annotate scripts/plot/util/isprop.m @ 17572:7bb76a22cde1

maint: Split scripts/plot directory into 4 pieces. scripts/gui : user-interface functions scripts/plot/appearance : functions controlling plot appearance scripts/plot/draw : plotting functions which produce graphs scripts/plot/util : low-level plotting functions and utilities. * scripts/gui/guidata.m, scripts/gui/guihandles.m, scripts/gui/module.mk, scripts/gui/private/__file_filter__.m, scripts/gui/private/__fltk_file_filter__.m, scripts/gui/private/__is_function__.m, scripts/gui/private/__uigetdir_fltk__.m, scripts/gui/private/__uigetfile_fltk__.m, scripts/gui/private/__uiobject_split_args__.m, scripts/gui/private/__uiputfile_fltk__.m, scripts/gui/uicontextmenu.m, scripts/gui/uicontrol.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uimenu.m, scripts/gui/uipanel.m, scripts/gui/uipushtool.m, scripts/gui/uiputfile.m, scripts/gui/uiresume.m, scripts/gui/uitoggletool.m, scripts/gui/uitoolbar.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m, scripts/gui/waitforbuttonpress.m: Moved from scripts/plot to scripts/gui * scripts/plot/appearance/__clabel__.m, scripts/plot/appearance/__getlegenddata__.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m, scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m, scripts/plot/appearance/diffuse.m, scripts/plot/appearance/grid.m, scripts/plot/appearance/gtext.m, scripts/plot/appearance/hidden.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m, scripts/plot/appearance/pbaspect.m, scripts/plot/appearance/private/__axis_label__.m, scripts/plot/appearance/private/__axis_limits__.m, scripts/plot/appearance/shading.m, scripts/plot/appearance/specular.m, scripts/plot/appearance/text.m, scripts/plot/appearance/title.m, scripts/plot/appearance/view.m, scripts/plot/appearance/whitebg.m, scripts/plot/appearance/xlabel.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylabel.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlabel.m, scripts/plot/appearance/zlim.m: Moved from scripts/plot to subdir appearance. * scripts/plot/draw/area.m, scripts/plot/draw/bar.m, scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m, scripts/plot/draw/comet.m, scripts/plot/draw/comet3.m, scripts/plot/draw/compass.m, scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m, scripts/plot/draw/contourc.m, scripts/plot/draw/contourf.m, scripts/plot/draw/cylinder.m, scripts/plot/draw/ellipsoid.m, scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m, scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m, scripts/plot/draw/ezmeshc.m, scripts/plot/draw/ezplot.m, scripts/plot/draw/ezplot3.m, scripts/plot/draw/ezpolar.m, scripts/plot/draw/ezsurf.m, scripts/plot/draw/ezsurfc.m, scripts/plot/draw/feather.m, scripts/plot/draw/fill.m, scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m, scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m, scripts/plot/draw/line.m, scripts/plot/draw/loglog.m, scripts/plot/draw/loglogerr.m, scripts/plot/draw/mesh.m, scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m, scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m, scripts/plot/draw/pcolor.m, scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m, scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m, scripts/plot/draw/plot3.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/polar.m, scripts/plot/draw/private/__add_datasource__.m, scripts/plot/draw/private/__bar__.m, scripts/plot/draw/private/__contour__.m, scripts/plot/draw/private/__errcomm__.m, scripts/plot/draw/private/__errplot__.m, scripts/plot/draw/private/__ezplot__.m, scripts/plot/draw/private/__interp_cube__.m, scripts/plot/draw/private/__line__.m, scripts/plot/draw/private/__marching_cube__.m, scripts/plot/draw/private/__patch__.m, scripts/plot/draw/private/__pie__.m, scripts/plot/draw/private/__plt__.m, scripts/plot/draw/private/__quiver__.m, scripts/plot/draw/private/__scatter__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/draw/rectangle.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m, scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m, scripts/plot/draw/semilogx.m, scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogy.m, scripts/plot/draw/semilogyerr.m, scripts/plot/draw/shrinkfaces.m, scripts/plot/draw/slice.m, scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m, scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m, scripts/plot/draw/stem3.m, scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m, scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m, scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m, scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m, scripts/plot/draw/waterfall.m: Moved from plot/ to subdir draw. * scripts/plot/util/__actual_axis_position__.m, scripts/plot/util/__default_plot_options__.m, scripts/plot/util/__gnuplot_drawnow__.m, scripts/plot/util/__next_line_color__.m, scripts/plot/util/__next_line_style__.m, scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/__pltopt__.m, scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m, scripts/plot/util/axes.m, scripts/plot/util/cla.m, scripts/plot/util/clf.m, scripts/plot/util/close.m, scripts/plot/util/closereq.m, scripts/plot/util/colstyle.m, scripts/plot/util/copyobj.m, scripts/plot/util/figure.m, scripts/plot/util/findall.m, scripts/plot/util/findfigs.m, scripts/plot/util/findobj.m, scripts/plot/util/gca.m, scripts/plot/util/gcbf.m, scripts/plot/util/gcbo.m, scripts/plot/util/gcf.m, scripts/plot/util/gco.m, scripts/plot/util/ginput.m, scripts/plot/util/gnuplot_binary.in, scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hdl2struct.m, scripts/plot/util/hggroup.m, scripts/plot/util/hold.m, scripts/plot/util/isaxes.m, scripts/plot/util/isfigure.m, scripts/plot/util/ishghandle.m, scripts/plot/util/ishold.m, scripts/plot/util/isprop.m, scripts/plot/util/linkprop.m, scripts/plot/util/meshgrid.m, scripts/plot/util/ndgrid.m, scripts/plot/util/newplot.m, scripts/plot/util/print.m, scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/private/__fltk_ginput__.m, scripts/plot/util/private/__fltk_print__.m, scripts/plot/util/private/__ghostscript__.m, scripts/plot/util/private/__gnuplot_get_var__.m, scripts/plot/util/private/__gnuplot_ginput__.m, scripts/plot/util/private/__gnuplot_has_feature__.m, scripts/plot/util/private/__gnuplot_has_terminal__.m, scripts/plot/util/private/__gnuplot_open_stream__.m, scripts/plot/util/private/__gnuplot_print__.m, scripts/plot/util/private/__gnuplot_version__.m, scripts/plot/util/private/__go_draw_axes__.m, scripts/plot/util/private/__go_draw_figure__.m, scripts/plot/util/private/__print_parse_opts__.m, scripts/plot/util/private/__tight_eps_bbox__.m, scripts/plot/util/refresh.m, scripts/plot/util/refreshdata.m, scripts/plot/util/saveas.m, scripts/plot/util/shg.m, scripts/plot/util/struct2hdl.m, scripts/plot/util/subplot.m: Moved from plot to subdir util. * etc/HACKING: Updated directory structure info. * scripts/Makefile.am, scripts/plot/appearance/module.mk, scripts/plot/draw/module.mk, scripts/plot/util/module.mk: Added new directories to build system.
author Rik <rik@octave.org>
date Fri, 04 Oct 2013 17:09:08 -0700
parents scripts/plot/isprop.m@278ef6bd821d
children d63878346099
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13214
diff changeset
1 ## Copyright (C) 2010-2012 Ben Abbott
11374
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
2 ##
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
3 ## This file is part of Octave.
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
4 ##
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
8 ## your option) any later version.
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
9 ##
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
13 ## General Public License for more details.
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
14 ##
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
18
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
19 ## -*- texinfo -*-
17488
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
20 ## @deftypefn {Function File} {@var{res} =} isprop (@var{h}, "@var{prop}")
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 11374
diff changeset
21 ## Return true if @var{prop} is a property of the object with handle @var{h}.
17488
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
22 ##
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
23 ## @var{h} may also be an array of handles in which case @var{res} will be a
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
24 ## logical array indicating whether each handle has the property @var{prop}.
11374
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
25 ## @seealso{get, set}
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
26 ## @end deftypefn
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
27
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
28 ## Author: Ben Abbott <bpabbott@mac.com>
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
29
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
30 function res = isprop (h, prop)
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
31
17488
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
32 if (nargin != 2)
11374
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
33 print_usage ();
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
34 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
35
13214
7715aca4bce1 Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents: 11587
diff changeset
36 if (! all (ishandle (h)))
17488
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
37 error ("isprop: H must be a graphics handle or vector of handles");
11374
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
38 elseif (! ischar (prop))
17488
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
39 error ("isprop: PROP name must be a string");
11374
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
40 endif
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
41
13214
7715aca4bce1 Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents: 11587
diff changeset
42 res = false (size (h));
17488
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
43 for i = 1:numel (res)
13214
7715aca4bce1 Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents: 11587
diff changeset
44 try
17488
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
45 v = get (h(i), prop);
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
46 res(i) = true;
13214
7715aca4bce1 Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents: 11587
diff changeset
47 end_try_catch
7715aca4bce1 Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents: 11587
diff changeset
48 endfor
11374
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
49 endfunction
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
50
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
51
11374
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
52 %!assert (isprop (0, "foobar"), false)
d67d44f47949 isprop.m: New function.
Ben Abbott <bpabbott@mac.com>
parents:
diff changeset
53 %!assert (isprop (0, "screenpixelsperinch"), true)
13214
7715aca4bce1 Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents: 11587
diff changeset
54 %!assert (isprop (zeros (2, 3), "visible"), true (2, 3))
7715aca4bce1 Allow an nd-array of handles when calling isprop.m.
Ben Abbott <bpabbott@mac.com>
parents: 11587
diff changeset
55
17488
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
56 %!error isprop ()
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
57 %!error isprop (1)
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
58 %!error isprop (1,2,3)
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
59 %!error <H must be a graphics handle> isprop ({1}, "visible")
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
60 %!error <PROP name must be a string> isprop (0, {"visible"})
278ef6bd821d isprop.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
61