octave_packages/m/plot/hggroup.m

   1 ## Copyright (C) 2008-2012 Michael Goffioul
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {} hggroup ()
  21 ## @deftypefnx {Function File} {} hggroup (@var{h})
  22 ## @deftypefnx {Function File} {} hggroup (@dots{}, @var{property}, @var{value}, @dots{})
  23 ## Create group object with parent @var{h}.  If no parent is specified,
  24 ## the group is created in the current axes.  Return the handle of the
  25 ## group object created.
  26 ##
  27 ## Multiple property-value pairs may be specified for the group, but they
  28 ## must appear in pairs.
  29 ## @end deftypefn
  30
  31 ## Author: goffioul
  32
  33 function h = hggroup (varargin)
  34
  35   [ax, varargin] = __plt_get_axis_arg__ ("hggroup", varargin{:});
  36
  37   tmp = __go_hggroup__ (ax, varargin{:});
  38
  39   if (nargout > 0)
  40     h = tmp;
  41   endif
  42
  43 endfunction
  44
  45 %!test
  46 %! hf = figure ("visible", "off");
  47 %! unwind_protect
  48 %!   h = hggroup;
  49 %!   assert (findobj (hf, "type", "hggroup"), h);
  50 %!   assert (get (h, "type"), "hggroup");
  51 %! unwind_protect_cleanup
  52 %!   close (hf);
  53 %! end_unwind_protect