octave_packages/m/plot/isprop.m

   1 ## Copyright (C) 2010-2012 Ben Abbott
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {@var{res} =} isprop (@var{h}, @var{prop})
  21 ## Return true if @var{prop} is a property of the object with handle @var{h}.
  22 ## @seealso{get, set}
  23 ## @end deftypefn
  24
  25 ## Author: Ben Abbott  <bpabbott@mac.com>
  26
  27 function res = isprop (h, prop)
  28   ## Check input
  29   if (nargin < 1 || nargin > 2)
  30     print_usage ();
  31   endif
  32
  33   if (! all (ishandle (h)))
  34     error ("isprop: first input argument must be a handle");
  35   elseif (! ischar (prop))
  36     error ("isprop: second input argument must be string");
  37   endif
  38
  39   res = false (size (h));
  40   for n = 1:numel(res)
  41     res(n) = true;
  42     try
  43       v = get (h(n), prop);
  44     catch
  45       res(n) = false;
  46     end_try_catch
  47   endfor
  48 endfunction
  49
  50 %!assert (isprop (0, "foobar"), false)
  51
  52 %!assert (isprop (0, "screenpixelsperinch"), true)
  53
  54 %!assert (isprop (zeros (2, 3), "visible"), true (2, 3))
  55