Mercurial > hg > octave-lyh
view scripts/plot/gca.m @ 16808:772f51539af8
doc: Add gco() to documentation.
* doc/interpreter/plot.txi: Add gco() to manual.
* scripts/plot/gco.m: Add seealso links to docstring.
* scripts/plot/gcbf.m: Re-arrange seealso links. Improve docstring.
* scripts/plot/gcbo.m: Rewrite second paragraph of docstring.
Add seealso link to gco.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 22 Jun 2013 11:16:04 -0700 |
parents | f3d52523cde1 |
children | 64e7bb01fce2 |
line wrap: on
line source
## Copyright (C) 2005-2012 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} {} gca () ## Return a handle to the current axis object. If no axis object ## exists, create one and return its handle. The handle may then be ## used to examine or set properties of the axes. For example, ## ## @example ## @group ## ax = gca (); ## set (ax, "position", [0.5, 0.5, 0.5, 0.5]); ## @end group ## @end example ## ## @noindent ## creates an empty axes object, then changes its location and size in ## the figure window. ## @seealso{get, set} ## @end deftypefn ## Author: jwe function h = gca () if (nargin == 0) h = get (gcf (), "currentaxes"); if (isempty (h)) h = axes (); endif else print_usage (); endif endfunction %!test %! hf = figure ("visible", "off"); %! ax = axes; %! unwind_protect %! assert (gca, ax); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect