1 ## Copyright (C) 2005-2012 John W. Eaton
3 ## This file is part of Octave.
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.
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.
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/>.
20 ## @deftypefn {Function File} {} gcf ()
21 ## Return the current figure handle. If a figure does not exist, create
22 ## one and return its handle. The handle may then be used to examine or
23 ## set properties of the figure. For example,
27 ## fplot (@@sin, [-10, 10]);
29 ## set (fig, "visible", "off");
34 ## plots a sine wave, finds the handle of the current figure, and then
35 ## makes that figure invisible. Setting the visible property of the
36 ## figure to @code{"on"} will cause it to be displayed again.
40 ## Author: jwe, Bill Denney
45 h = get (0, "currentfigure");
46 if (isempty (h) || h == 0)
47 ## We only have a root figure object, so create a new figure
48 ## object and make it the current figure.
58 %! hf = figure ("visible", "off");
61 %! unwind_protect_cleanup