1 ## Copyright (C) 1996-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} {} figure (@var{n})
21 ## @deftypefnx {Function File} {} figure (@var{n}, @var{property}, @var{value}, @dots{})
22 ## Set the current plot window to plot window @var{n}. If no arguments are
23 ## specified, the next available window number is chosen.
25 ## Multiple property-value pairs may be specified for the figure, but they
26 ## must appear in pairs.
29 ## Author: jwe, Bill Denney
31 function h = figure (varargin)
37 init_new_figure = false;
38 if (mod (nargs, 2) == 1)
40 if (ishandle (tmp) && strcmp (get (tmp, "type"), "figure"))
44 elseif (isnumeric (tmp) && tmp > 0 && tmp == fix (tmp))
46 init_new_figure = true;
50 error ("figure: expecting figure handle or figure number");
54 ## Check to see if we already have a figure on the screen. If we do,
55 ## then update it if it is different from the figure we are creating
57 cf = get (0, "currentfigure");
58 if (! isempty (cf) && cf != 0)
59 if (isnan (f) || cf != f)
64 if (rem (nargs, 2) == 0)
65 if (isnan (f) || init_new_figure)
66 if (ismac () && strcmp (graphics_toolkit (), "fltk"))
67 ## FIXME - Hack for fltk-aqua to work around bug # 31931
68 f = __go_figure__ (f);
70 if (! isempty (varargin))
74 f = __go_figure__ (f, varargin{:});
79 set (0, "currentfigure", f);
84 cf = get (0, "currentfigure");
85 if (strcmp (get (cf, "__graphics_toolkit__"), "fltk"))
86 __add_default_menu__ (cf);
96 %! hf = figure ("visible", "off");
99 %! assert (isfigure (hf));
100 %! unwind_protect_cleanup
102 %! end_unwind_protect