Mercurial > octave
view scripts/plot/util/isprop.m @ 29490:0e734bdfd6b2 stable
isprop.m: Document that function only works on graphics objects in Octave 6.X (bug #60295)
isprop.m: Document that function only works on graphics objects in Octave 6.X,
but that it has already been extended to classdef objects on the development
branch.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 05 Apr 2021 09:09:22 -0700 |
parents | 0a5b15007766 |
children | 747f592e2001 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2010-2021 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{res} =} isprop (@var{obj}, "@var{prop}") ## Return true if @var{prop} is a property of the object @var{obj}. ## ## @var{obj} may also be an array of objects in which case @var{res} will be a ## logical array indicating whether each handle has the property @var{prop}. ## ## For plotting, @var{obj} is a handle to a graphics object. ## ## Programming Note: There is no support in Octave versions 6.X.X for @var{obj} ## to be an instance of a class (i.e., a classdef object). This functionality ## has already been added on the development branch which will become Octave ## 7.1.0. ## @seealso{get, set, ismethod, isobject} ## @end deftypefn function res = isprop (obj, prop) if (nargin != 2) print_usage (); elseif (! ischar (prop)) error ("isprop: PROP name must be a string"); endif warning ("error", "Octave:abbreviated-property-match", "local"); res = false (size (obj)); for i = 1:numel (res) if (ishghandle (obj(i))) try v = get (obj(i), prop); res(i) = true; end_try_catch endif endfor endfunction %!assert (isprop (0, "foobar"), false) %!assert (isprop (0, "screenpixelsperinch"), true) %!assert (isprop (zeros (2, 3), "visible"), true (2, 3)) %!assert (isprop ([-2, -1, 0], "visible"), [false, false, true]) %!error isprop () %!error isprop (1) %!error isprop (1,2,3) %!error <PROP name must be a string> isprop (0, {"visible"})