Mercurial > octave-nkf
view scripts/plot/ancestor.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 | e0cd6299842c |
children | bc924baa2c4e |
line wrap: on
line source
## Copyright (C) 2007-2012 Michael Goffioul ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}) ## @deftypefnx {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}, "toplevel") ## Return the first ancestor of handle object @var{h} whose type matches ## @var{type}, where @var{type} is a character string. If @var{type} is a ## cell array of strings, return the first parent whose type matches ## any of the given type strings. ## ## If the handle object @var{h} itself is of type @var{type}, return @var{h}. ## ## If @code{"toplevel"} is given as a third argument, return the highest ## parent in the object hierarchy that matches the condition, instead ## of the first (nearest) one. ## @seealso{findobj, findall, allchild} ## @end deftypefn function p = ancestor (h, type, toplevel) if (nargin < 2 || nargin > 3) print_usage (); endif if (ischar (type)) type = { type }; elseif (! iscellstr (type)) error ("ancestor: TYPE must be a string or cell array of strings"); endif find_first = true; if (nargin == 3) if (ischar (toplevel) && strcmpi (toplevel, "toplevel")) find_first = false; else error ('ancestor: third argument must be "toplevel"'); endif endif if (isempty (h)) p = []; else p = cell (numel (h), 1); h = num2cell (h); for nh = 1:numel (h) while (true) if (isempty (h{nh}) || ! ishandle (h{nh})) break; endif if (any (strcmpi (get (h{nh}, "type"), type))) p{nh} = h{nh}; if (find_first) break; endif endif h{nh} = get (h{nh}, "parent"); endwhile endfor if (nh == 1) p = p{1}; endif endif endfunction %!test %! hf = figure ("visible", "off"); %! unwind_protect %! hl = line; %! assert (ancestor (hl, "axes"), gca); %! assert (ancestor (hl, "figure"), hf); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect %!test %! hf = figure ("visible", "off"); %! unwind_protect %! hg1 = hggroup ("parent", gca); %! hg2 = hggroup ("parent", hg1); %! hl = line ("parent", hg2); %! assert (ancestor (hl, "line"), hl); %! assert (ancestor (hl, "axes"), gca); %! assert (ancestor (hl, "figure"), hf); %! assert (ancestor (hl, "hggroup"), hg2); %! assert (ancestor (hl, "hggroup", "toplevel"), hg1); %! assert (ancestor (hl, {"hggroup", "axes"}), hg2); %! assert (ancestor (hl, {"hggroup", "axes"}, "toplevel"), gca); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect %!assert (ancestor ([], "axes"), []) %!error ancestor () %!error ancestor (1,2,3) %!error <TYPE must be a string> ancestor (1,2) %!error <third argument must be "toplevel"> ancestor (1, "axes", "foo")