Mercurial > octave
diff scripts/plot/findobj.m @ 17122:eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
* doc/interpreter/plot.txi: Add @findex entries that were in xlim.m
* scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m,
scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m,
scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m,
scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m,
scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m,
scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m,
scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m,
scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m,
scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m,
scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m,
scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m,
scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m,
scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m,
scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m,
scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m,
scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m,
scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m,
scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m,
scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m,
scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m,
scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m,
scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m,
scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m,
scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m,
scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m,
scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m,
scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m,
scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m,
scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m,
scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m,
scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m,
scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m,
scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m,
scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m,
scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m,
scripts/plot/zlim.m: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 31 Jul 2013 13:53:30 -0700 |
| parents | bd50e0660545 |
| children | 3fd617363762 |
line wrap: on
line diff
--- a/scripts/plot/findobj.m Wed Jul 31 13:49:06 2013 -0700 +++ b/scripts/plot/findobj.m Wed Jul 31 13:53:30 2013 -0700 @@ -18,46 +18,57 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{h} =} findobj () -## @deftypefnx {Function File} {@var{h} =} findobj (@var{prop_name}, @var{prop_value}) +## @deftypefnx {Function File} {@var{h} =} findobj (@var{prop_name}, @var{prop_value}, @dots{}) +## @deftypefnx {Function File} {@var{h} =} findobj (@var{prop_name}, @var{prop_value}, "-@var{logical_op}", @var{prop_name}, @var{prop_value}) ## @deftypefnx {Function File} {@var{h} =} findobj ("-property", @var{prop_name}) ## @deftypefnx {Function File} {@var{h} =} findobj ("-regexp", @var{prop_name}, @var{pattern}) -## @deftypefnx {Function File} {@var{h} =} findobj ("flat", @dots{}) -## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, @dots{}) -## @deftypefnx {Function File} {@var{h} =} findobj (@var{h}, "-depth", @var{d}, @dots{}) -## Find graphics object with specified property values. The simplest form is +## @deftypefnx {Function File} {@var{h} =} findobj (@var{hlist}, @dots{}) +## @deftypefnx {Function File} {@var{h} =} findobj (@var{hlist}, "flat", @dots{}) +## @deftypefnx {Function File} {@var{h} =} findobj (@var{hlist}, "-depth", @var{d}, @dots{}) +## Find graphics object with specified property values. +## +## The simplest form is ## ## @example ## findobj (@var{prop_name}, @var{prop_value}) ## @end example ## ## @noindent -## which returns all of the handles to the objects with the name -## @var{prop_name} and the name @var{prop_value}. The search can be limited -## to a particular object or set of objects and their descendants by -## passing a handle or set of handles @var{h} as the first argument to -## @code{findobj}. +## which returns the handles of all objects which have a property named +## @var{prop_name} that has the value @var{prop_value}. If multiple +## property/value pairs are specified then only objects meeting all of the +## conditions are returned. ## -## The depth of hierarchy of objects to which to search to can be limited -## with the "-depth" argument. To limit the number depth of the hierarchy -## to search to @var{d} generations of children, and example is +## The search can be limited to a particular set of objects and their +## descendants, by passing a handle or set of handles @var{hlist} as the first +## argument. +## +## The depth of the object hierarchy to search can be limited with the "-depth" +## argument. An example of searching only three generations of children is: ## ## @example -## findobj (@var{h}, "-depth", @var{d}, @var{prop_name}, @var{prop_value}) +## findobj (@var{hlist}, "-depth", @var{d}, @var{prop_name}, @var{prop_value}) ## @end example ## -## Specifying a depth @var{d} of 0, limits the search to the set of object -## passed in @var{h}. A depth @var{d} of 0 is equivalent to the "-flat" +## Specifying a depth @var{d} of 0, limits the search to the set of objects +## passed in @var{hlist}. A depth @var{d} of 0 is equivalent to the "flat" ## argument. ## ## A specified logical operator may be applied to the pairs of @var{prop_name} -## and @var{prop_value}. The supported logical operators are "-and", "-or", +## and @var{prop_value}. The supported logical operators are: "-and", "-or", ## "-xor", "-not". ## -## The objects may also be matched by comparing a regular expression to the -## property values, where property values that match @code{regexp -## (@var{prop_value}, @var{pattern})} are returned. Finally, objects may be -## matched by property name only, using the "-property" option. -## @seealso{get, set} +## Objects may also be matched by comparing a regular expression to the +## property values, where property values that match +## @code{regexp (@var{prop_value}, @var{pattern})} are returned. +## +## Finally, objects may be matched by property name only by using the +## "-property" option. +## +## Implementation Note: The search only includes objects with visible +## handles ("HandleVisibility" = "on"). @xref{XREFfindall,,findall}, to +## search for all objects including hidden ones. +## @seealso{findall, allchild, get, set} ## @end deftypefn ## Author: Ben Abbott <bpabbott@mac.com>