Mercurial > octave
view scripts/plot/util/axes.m @ 20173:777f26aa8e3e stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed plot/ and gui/ in scripts directory.
* scripts/gui/errordlg.m, scripts/gui/helpdlg.m, scripts/gui/inputdlg.m,
scripts/gui/listdlg.m, scripts/gui/msgbox.m,
scripts/gui/private/__get_funcname__.m,
scripts/gui/private/__uiobject_split_args__.m, scripts/gui/questdlg.m,
scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uiwait.m,
scripts/gui/waitbar.m, scripts/gui/warndlg.m,
scripts/plot/appearance/annotation.m, scripts/plot/appearance/axis.m,
scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m,
scripts/plot/appearance/datetick.m, scripts/plot/appearance/hidden.m,
scripts/plot/appearance/legend.m, scripts/plot/appearance/xlim.m,
scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlim.m,
scripts/plot/draw/area.m, scripts/plot/draw/comet.m,
scripts/plot/draw/comet3.m, scripts/plot/draw/contour.m,
scripts/plot/draw/contourf.m, scripts/plot/draw/isocolors.m,
scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m,
scripts/plot/draw/plotmatrix.m, scripts/plot/draw/quiver.m,
scripts/plot/draw/quiver3.m, scripts/plot/draw/ribbon.m,
scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogyerr.m,
scripts/plot/draw/sphere.m, scripts/plot/draw/surfl.m,
scripts/plot/draw/tetramesh.m, scripts/plot/util/allchild.m,
scripts/plot/util/ancestor.m, scripts/plot/util/axes.m,
scripts/plot/util/colstyle.m, scripts/plot/util/frame2im.m,
scripts/plot/util/gnuplot_binary.in, scripts/plot/util/hgsave.m,
scripts/plot/util/im2frame.m, scripts/plot/util/isaxes.m,
scripts/plot/util/isfigure.m, scripts/plot/util/linkaxes.m,
scripts/plot/util/ndgrid.m, scripts/plot/util/pan.m, scripts/plot/util/print.m,
scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m,
scripts/plot/util/rotate.m, scripts/plot/util/rotate3d.m,
scripts/plot/util/saveas.m, scripts/plot/util/struct2hdl.m,
scripts/plot/util/subplot.m, scripts/plot/util/zoom.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 09 May 2015 22:50:09 -0700 |
parents | 9fc020886ae9 |
children | 516bb87ea72e |
line wrap: on
line source
## Copyright (C) 2005-2015 John W. Eaton ## ## 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} {} axes () ## @deftypefnx {Function File} {} axes (@var{property}, @var{value}, @dots{}) ## @deftypefnx {Function File} {} axes (@var{hax}) ## @deftypefnx {Function File} {@var{h} =} axes (@dots{}) ## Create an axes object and return a handle to it, or set the current axes ## to @var{hax}. ## ## Called without any arguments, or with @var{property}/@var{value} pairs, ## construct a new axes. For accepted properties and corresponding ## values, @pxref{XREFset,,set}. ## ## Called with a single axes handle argument @var{hax}, the function makes ## @var{hax} the current axis. It also restacks the axes in the ## corresponding figure so that @var{hax} is the first entry in the list ## of children. This causes @var{hax} to be displayed on top of any other ## axes objects (Z-order stacking). ## ## @seealso{gca, set, get} ## @end deftypefn ## Author: jwe function h = axes (varargin) if (nargin == 0 || nargin > 1) ## Parent figure idx = find (strcmpi (varargin(1:2:end), "parent"), 1, "first"); if (! isempty (idx) && length (varargin) >= 2*idx) cf = varargin{2*idx}; varargin([2*idx-1, 2*idx]) = []; else cf = gcf (); endif ## If there is an annotation axes currently on top of the figure ## children stack, we will put it back on top do_restack = false; ch = allchild (cf); hax = ch(isaxes (ch)); idx = find (strcmp (get (hax, "tag"), "scribeoverlay")); if (idx == 1) hover = hax(idx); do_restack = true; endif ## Create an axes object. htmp = __go_axes__ (cf, varargin{:}); if (__is_handle_visible__ (htmp)) set (ancestor (cf, "figure"), "currentaxes", htmp); endif ## Restack if necessary if (do_restack) restack_axes (hover, cf); endif else ## ARG is axes handle. htmp = varargin{1}; if (isscalar (htmp) && isaxes (htmp)) cf = ancestor (htmp, "figure"); if (__is_handle_visible__ (htmp)) set (0, "currentfigure", cf); set (cf, "currentaxes", htmp); endif ## restack restack_axes (htmp, cf); else error ("axes: H must be a scalar axes handle"); endif endif if (nargout > 0) h = htmp; endif endfunction function restack_axes (h, cf) show = get (0, "showhiddenhandles"); set (0, "showhiddenhandles", "on"); unwind_protect ch = get (cf, "children"); hax = ch(isaxes (ch)); ch(isaxes (ch)) = [h; hax(hax != h)]; set (cf, "children", ch); unwind_protect_cleanup set (0, "showhiddenhandles", show); end_unwind_protect endfunction