Mercurial > hg > octave-nkf
comparison scripts/plot/findobj.m @ 14001:5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
* voronoi.m, image.m, imagesc.m, imshow.m, area.m, bar.m, barh.m, clabel.m,
clf.m, compass.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m,
ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, findall.m,
findobj.m, loglog.m, mesh.m, pareto.m, patch.m, pie.m, pie3.m, plot.m, polar.m,
quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m,
semilogx.m, semilogy.m, slice.m, stem.m, surf.m, surface.m, text.m, title.m,
trimesh.m, triplot.m, trisurf.m, xlabel.m, ylabel.m, zlabel.m:
Update documentation for functions returning a graphics handle h.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 06 Dec 2011 13:09:17 -0800 |
parents | e81ddf9cacd5 |
children | 72c96de7a403 |
comparison
equal
deleted
inserted
replaced
14000:15400d5deb1c | 14001:5f0bb45e615c |
---|---|
22 ## @deftypefnx {Function File} {@var{h} =} findobj ('-property', @var{prop_name}) | 22 ## @deftypefnx {Function File} {@var{h} =} findobj ('-property', @var{prop_name}) |
23 ## @deftypefnx {Function File} {@var{h} =} findobj ('-regexp', @var{prop_name}, @var{pattern}) | 23 ## @deftypefnx {Function File} {@var{h} =} findobj ('-regexp', @var{prop_name}, @var{pattern}) |
24 ## @deftypefnx {Function File} {@var{h} =} findobj ('flat', @dots{}) | 24 ## @deftypefnx {Function File} {@var{h} =} findobj ('flat', @dots{}) |
25 ## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, @dots{}) | 25 ## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, @dots{}) |
26 ## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, '-depth', @var{d}, @dots{}) | 26 ## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, '-depth', @var{d}, @dots{}) |
27 ## Find object with specified property values. The simplest form is | 27 ## Find graphics object with specified property values. The simplest form is |
28 ## | 28 ## |
29 ## @example | 29 ## @example |
30 ## findobj (@var{prop_name}, @var{prop_Value}) | 30 ## findobj (@var{prop_name}, @var{prop_Value}) |
31 ## @end example | 31 ## @end example |
32 ## | 32 ## |
241 | 241 |
242 h = h (keepers != 0); | 242 h = h (keepers != 0); |
243 h = reshape (h, [numel(h), 1]); | 243 h = reshape (h, [numel(h), 1]); |
244 endfunction | 244 endfunction |
245 | 245 |
246 | |
246 %!test | 247 %!test |
247 %! hf = figure ("visible", "off"); | 248 %! hf = figure ("visible", "off"); |
248 %! unwind_protect | 249 %! unwind_protect |
249 %! l = line; | 250 %! l = line; |
250 %! obj = findobj (hf, "type", "line"); | 251 %! obj = findobj (hf, "type", "line"); |
253 %! assert (hf, findobj (hf, "type", "figure")); | 254 %! assert (hf, findobj (hf, "type", "figure")); |
254 %! assert (isempty (findobj (hf, "type", "xyzxyz"))); | 255 %! assert (isempty (findobj (hf, "type", "xyzxyz"))); |
255 %! unwind_protect_cleanup | 256 %! unwind_protect_cleanup |
256 %! close (hf); | 257 %! close (hf); |
257 %! end_unwind_protect | 258 %! end_unwind_protect |
259 |