1########################################################################
2##
3## Copyright (C) 2013-2021 The Octave Project Developers
4##
5## See the file COPYRIGHT.md in the top-level directory of this
6## distribution or <https://octave.org/copyright/>.
7##
8## This file is part of Octave.
9##
10## Octave is free software: you can redistribute it and/or modify it
11## under the terms of the GNU General Public License as published by
12## the Free Software Foundation, either version 3 of the License, or
13## (at your option) any later version.
14##
15## Octave is distributed in the hope that it will be useful, but
16## WITHOUT ANY WARRANTY; without even the implied warranty of
17## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18## GNU General Public License for more details.
19##
20## You should have received a copy of the GNU General Public License
21## along with Octave; see the file COPYING.  If not, see
22## <https://www.gnu.org/licenses/>.
23##
24########################################################################
25
26## -*- texinfo -*-
27## @deftypefn {} {} isaxes (@var{h})
28## Return true if @var{h} is an axes graphics handle and false otherwise.
29##
30## If @var{h} is a matrix then return a logical array which is true where the
31## elements of @var{h} are axes graphics handles and false where they are not.
32## @seealso{isfigure, ishghandle, isgraphics}
33## @end deftypefn
34
35function retval = isaxes (h)
36
37  if (nargin != 1)
38    print_usage ();
39  endif
40
41  retval = ishghandle (h);
42
43  if (any (retval))
44    retval(retval) = strcmp (get (h(retval), "type"), "axes");
45  endif
46
47endfunction
48
49
50%!test
51%! hf = figure ("visible", "off");
52%! unwind_protect
53%!   hax = axes ();
54%!   assert (isaxes (hax));
55%!   assert (! isaxes (-hax));
56%! unwind_protect_cleanup
57%!   close (hf);
58%! end_unwind_protect
59
60%!test
61%! hf = figure ("visible", "off");
62%! unwind_protect
63%!   hax = axes ();
64%!   assert (isaxes ([hax NaN]), [true false]);
65%! unwind_protect_cleanup
66%!   close (hf);
67%! end_unwind_protect
68
69%!error isaxes ()
70%!error isaxes (1, 2)
71