octave_packages/m/plot/isfigure.m

   1 ## Copyright (C) 2005-2012 John W. Eaton
   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} {} isfigure (@var{h})
  21 ## Return true if @var{h} is a graphics handle that contains a figure
  22 ## object.
  23 ## @seealso{ishandle}
  24 ## @end deftypefn
  25
  26 ## Author: jwe
  27
  28 function retval = isfigure (h)
  29
  30   if (nargin == 1)
  31     retval = (ishandle (h) && strcmp (get (h, "type"), "figure"));
  32   else
  33     print_usage ();
  34   endif
  35
  36 endfunction
  37
  38 %!test
  39 %! hf = figure ("visible", "off");
  40 %! unwind_protect
  41 %!   assert (isfigure (hf));
  42 %!   assert (!isfigure (-hf));
  43 %! unwind_protect_cleanup
  44 %!   close (hf);
  45 %! end_unwind_protect