view scripts/plot/util/isaxes.m @ 24423:1d52db450db4

Change ishandle to return true for Java objects for Matlab compatibility. Add new function isgraphics() for Matlab compatibility. Change over existing instances of ishandle to ishghandle. * NEWS: Announce changes. * scripts/plot/util/isgraphics.m: New function. * scripts/plot/util/ishandle.m: New function. * scripts/plot/util/module.mk: Add isgraphics.m and ishandle.m to build system. * plot.txi: Change documentation around ishandle. Add isgraphics DOCSTRING to manual. * graphics.cc (Fishghandle): Rename function from ishandle to ishghandle. Add seealso links in docstring. * graphics.cc: Rename all instances of is_handle to is_hghandle. * genpropdoc.m, voronoi.m, guidata.m, guihandles.m, __uiobject_split_args__.m, uibuttongroup.m, uicontrol.m, uiwait.m, waitbar.m, brighten.m, delete.m, getappdata.m, isappdata.m, rmappdata.m, setappdata.m, __clabel__.m, camlookat.m, clabel.m, legend.m, material.m, thetaticks.m, whitebg.m, camlight.m, colorbar.m, isocolors.m, isonormals.m, plotmatrix.m, plotyy.m, reducepatch.m, shrinkfaces.m, __actual_axis_position__.m, __opengl_info__.m, __plt_get_axis_arg__.m, ancestor.m, copyobj.m, findobj.m, hdl2struct.m, hgsave.m, hold.m, isaxes.m, isfigure.m, ishold.m, isprop.m, linkprop.m, newplot.m, print.m, __gnuplot_draw_axes__.m, __gnuplot_draw_figure__.m, rotate.m, saveas.m, struct2hdl.m, subplot.m: Replace instances of ishandle with ishghandle in existing code.
author Rik <rik@octave.org>
date Sun, 17 Dec 2017 07:04:31 -0800
parents 092078913d54
children 6d2dc40a7c00
line wrap: on
line source

## Copyright (C) 2013-2017 Rik Wehbring
##
## 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 {} {} isaxes (@var{h})
## Return true if @var{h} is an axes graphics handle and false otherwise.
##
## If @var{h} is a matrix then return a logical array which is true where the
## elements of @var{h} are axes graphics handles and false where they are not.
## @seealso{isaxes, ishghandle}
## @end deftypefn

## Author: jwe

function retval = isaxes (h)

  if (nargin != 1)
    print_usage ();
  endif

  hlist = ishghandle (h);
  retval = hlist;

  if (any (hlist))
    retval(hlist) = strcmp (get (h(hlist), "type"), "axes");
  endif

endfunction


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

%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%!   hax = axes ();
%!   assert (isaxes ([hax NaN]), [true false]);
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect