1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
|
########################################################################
##
## Copyright (C) 2017-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## 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
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {@var{tf} =} ishandle (@var{h})
## Return true if @var{h} is a handle to a graphics or Java object and false
## otherwise.
##
## @var{h} may also be a matrix of handles in which case a logical array is
## returned that is true where the elements of @var{h} are handles to graphics
## or Java objects and false where they are not.
##
## Programming Note: It is often more useful to test for a specific object
## type. To determine if a handle belongs to a graphics object use
## @code{ishghandle} or @code{isgraphics}. To determine if a handle belongs
## to a Java object use @code{isjava}.
## @seealso{ishghandle, isgraphics, isjava}
## @end deftypefn
function tf = ishandle (h)
if (nargin < 1)
print_usage ();
endif
tf = ishghandle (h) | isjava (h);
endfunction
%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%! assert (ishandle (hf));
%! assert (! ishandle (-hf));
%! ax = gca ();
%! l = line ();
%! assert (ishandle (ax));
%! assert (! ishandle (-ax));
%! assert (ishandle ([l, -1, ax, hf]), logical ([1, 0, 1, 1]));
%! assert (ishandle ([l, -1, ax, hf]'), logical ([1, 0, 1, 1]'));
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
%!assert (ishandle ([-1 0]), [false true])
%!testif HAVE_JAVA; usejava ("jvm")
%! jobj = javaObject ("java.lang.Double", 1.0);
%! assert (ishandle (jobj));
## Test input validation
%!error <Invalid call> ishandle ()
|