octave_packages/m/plot/gca.m

   1 ## Copyright (C) 2005-2012 John W. Eaton
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} gca ()
  21 ## Return a handle to the current axis object.  If no axis object
  22 ## exists, create one and return its handle.  The handle may then be
  23 ## used to examine or set properties of the axes.  For example,
  24 ##
  25 ## @example
  26 ## @group
  27 ## ax = gca ();
  28 ## set (ax, "position", [0.5, 0.5, 0.5, 0.5]);
  29 ## @end group
  30 ## @end example
  31 ##
  32 ## @noindent
  33 ## creates an empty axes object, then changes its location and size in
  34 ## the figure window.
  35 ## @seealso{get, set}
  36 ## @end deftypefn
  37
  38 ## Author: jwe
  39
  40 function h = gca ()
  41
  42   if (nargin == 0)
  43     h = get (gcf (), "currentaxes");
  44     if (isempty (h))
  45       h = axes ();
  46     endif
  47   else
  48     print_usage ();
  49   endif
  50
  51 endfunction
  52
  53 %!test
  54 %! hf = figure ("visible", "off");
  55 %! ax = axes;
  56 %! unwind_protect
  57 %!   assert (gca, ax);
  58 %! unwind_protect_cleanup
  59 %!   close (hf);
  60 %! end_unwind_protect