← Back to branch summary

~gabriel1984sibiu/octave/octave

« back to all changes in this revision

Viewing changes to scripts/plot/util/gca.m

  • Committer: Grevutiu Gabriel
  • Date: 2014-01-02 13:05:54 UTC
  • Revision ID: gabriel1984sibiu@gmail.com-20140102130554-3r7ivdjln1ni6kcg
New version (3.8.0) from upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
scripts/plot/util/gca.m
 
1
## Copyright (C) 2005-2013 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} {@var{h} =} gca ()
 
21
## Return a handle to the current axis object.
 
22
##
 
23
## The current axis is the default target for graphics output.  In the case
 
24
## of a figure with multiple axes, @code{gca} returns the last created axes
 
25
## or the last axes that was clicked on with the mouse.
 
26
##
 
27
## If no current axes object exists, create one and return its handle.  The
 
28
## handle may then be used to examine or set properties of the axes.  For
 
29
## example,
 
30
##
 
31
## @example
 
32
## @group
 
33
## ax = gca ();
 
34
## set (ax, "position", [0.5, 0.5, 0.5, 0.5]);
 
35
## @end group
 
36
## @end example
 
37
##
 
38
## @noindent
 
39
## creates an empty axes object and then changes its location and size in the
 
40
## figure window.
 
41
##
 
42
## Note: To find the current axis without creating a new axes object if it
 
43
## does not exist, query the @qcode{"CurrentAxes"} property of a figure.
 
44
##
 
45
## @example
 
46
## get (gcf, "currentaxes");
 
47
## @end example
 
48
## @seealso{gcf, gco, gcbf, gcbo, get, set}
 
49
## @end deftypefn
 
50
 
 
51
## Author: jwe
 
52
 
 
53
function h = gca ()
 
54
 
 
55
  if (nargin == 0)
 
56
    h = get (gcf (), "currentaxes");
 
57
    if (isempty (h))
 
58
      h = axes ();
 
59
    endif
 
60
  else
 
61
    print_usage ();
 
62
  endif
 
63
 
 
64
endfunction
 
65
 
 
66
 
 
67
%!test
 
68
%! hf = figure ("visible", "off");
 
69
%! ax = axes;
 
70
%! unwind_protect
 
71
%!   assert (gca, ax);
 
72
%! unwind_protect_cleanup
 
73
%!   close (hf);
 
74
%! end_unwind_protect
 
75