view scripts/plot/isfigure.m @ 16772:7eff3032d144

Fix seealso HTML links when using Texinfo 4.X (bug #38862). Use the prefix 'docX' instead of 'doc-' for Texinfo references. * doc/interpreter/arith.txi, doc/interpreter/basics.txi, doc/interpreter/container.txi, doc/interpreter/func.txi, doc/interpreter/java.txi, doc/interpreter/matrix.txi, doc/interpreter/munge-texi.pl, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/stats.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/var.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/qz.cc, libinterp/corefcn/regexp.cc, libinterp/interpfcn/error.cc, scripts/general/accumarray.m, scripts/general/structfun.m, scripts/miscellaneous/setfield.m, scripts/optimization/fminbnd.m, scripts/optimization/fzero.m, scripts/optimization/lsqnonneg.m: Use the prefix 'docX' instead of 'doc-' for Texinfo references.
author Rik <rik@octave.org>
date Tue, 18 Jun 2013 20:35:12 -0700
parents f3d52523cde1
children 60228ef13f20
line wrap: on
line source

## Copyright (C) 2005-2012 John W. Eaton
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {} isfigure (@var{h})
## Return true if @var{h} is a graphics handle that contains a figure
## object.
## @seealso{ishandle}
## @end deftypefn

## Author: jwe

function retval = isfigure (h)

  if (nargin == 1)
    retval = (ishandle (h) && strcmp (get (h, "type"), "figure"));
  else
    print_usage ();
  endif

endfunction


%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%!   assert (isfigure (hf));
%!   assert (! isfigure (-hf));
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect