Mercurial > octave-nkf

comparison scripts/plot/findobj.m @ 14327:4d917a6a858b stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Use Octave coding conventions in @example blocks of docstrings. * accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m, celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m, contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m, dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m, ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m, flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m, idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m, isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m, logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m, moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m, polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m, randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m, shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m, strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m, subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m, voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in @example blocks of docstrings.
author Rik <octave@nomad.inbox5.com>
date Sat, 04 Feb 2012 22:12:50 -0800
parents 72c96de7a403
children 86854d032a37
comparison
equal deleted inserted replaced
14325:a646cee995cf 14327:4d917a6a858b
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {@var{h} =} findobj () 20 ## @deftypefn {Function File} {@var{h} =} findobj ()
21 ## @deftypefnx {Function File} {@var{h} =} findobj (@var{prop_name}, @var{prop_value}) 21 ## @deftypefnx {Function File} {@var{h} =} findobj (@var{prop_name}, @var{prop_value})
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 graphics 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 ##
33 ## @noindent 33 ## @noindent
34 ## which returns all of the handles to the objects with the name 34 ## which returns all of the handles to the objects with the name
35 ## @var{prop_name} and the name @var{prop_Value}. The search can be limited 35 ## @var{prop_name} and the name @var{prop_value}. The search can be limited
36 ## to a particular object or set of objects and their descendants by 36 ## to a particular object or set of objects and their descendants by
37 ## passing a handle or set of handles @var{h} as the first argument to 37 ## passing a handle or set of handles @var{h} as the first argument to
38 ## @code{findobj}. 38 ## @code{findobj}.
39 ## 39 ##
40 ## The depth of hierarchy of objects to which to search to can be limited 40 ## The depth of hierarchy of objects to which to search to can be limited
41 ## with the '-depth' argument. To limit the number depth of the hierarchy 41 ## with the "-depth" argument. To limit the number depth of the hierarchy
42 ## to search to @var{d} generations of children, and example is 42 ## to search to @var{d} generations of children, and example is
43 ## 43 ##
44 ## @example 44 ## @example
45 ## findobj (@var{h}, '-depth', @var{d}, @var{prop_Name}, @var{prop_Value}) 45 ## findobj (@var{h}, "-depth", @var{d}, @var{prop_name}, @var{prop_value})
46 ## @end example 46 ## @end example
47 ## 47 ##
48 ## Specifying a depth @var{d} of 0, limits the search to the set of object 48 ## Specifying a depth @var{d} of 0, limits the search to the set of object
49 ## passed in @var{h}. A depth @var{d} of 0 is equivalent to the '-flat' 49 ## passed in @var{h}. A depth @var{d} of 0 is equivalent to the "-flat"
50 ## argument. 50 ## argument.
51 ## 51 ##
52 ## A specified logical operator may be applied to the pairs of @var{prop_Name} 52 ## A specified logical operator may be applied to the pairs of @var{prop_name}
53 ## and @var{prop_Value}. The supported logical operators are '-and', '-or', 53 ## and @var{prop_value}. The supported logical operators are "-and", "-or",
54 ## '-xor', '-not'. 54 ## "-xor", "-not".
55 ## 55 ##
56 ## The objects may also be matched by comparing a regular expression to the 56 ## The objects may also be matched by comparing a regular expression to the
57 ## property values, where property values that match @code{regexp 57 ## property values, where property values that match @code{regexp
58 ## (@var{prop_Value}, @var{pattern})} are returned. Finally, objects may be 58 ## (@var{prop_value}, @var{pattern})} are returned. Finally, objects may be
59 ## matched by property name only, using the '-property' option. 59 ## matched by property name only, using the "-property" option.
60 ## @seealso{get, set} 60 ## @seealso{get, set}
61 ## @end deftypefn 61 ## @end deftypefn
62 62
63 ## Author: Ben Abbott <bpabbott@mac.com> 63 ## Author: Ben Abbott <bpabbott@mac.com>
64 64