octave_packages/m/plot/figure.m

   1 ## Copyright (C) 1996-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} {} 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.
  24 ##
  25 ## Multiple property-value pairs may be specified for the figure, but they
  26 ## must appear in pairs.
  27 ## @end deftypefn
  28
  29 ## Author: jwe, Bill Denney
  30
  31 function h = figure (varargin)
  32
  33   nargs = nargin;
  34
  35   f = NaN;
  36
  37   init_new_figure = false;
  38   if (mod (nargs, 2) == 1)
  39     tmp = varargin{1};
  40     if (ishandle (tmp) && strcmp (get (tmp, "type"), "figure"))
  41       f = tmp;
  42       varargin(1) = [];
  43       nargs--;
  44     elseif (isnumeric (tmp) && tmp > 0 && tmp == fix (tmp))
  45       f = tmp;
  46       init_new_figure = true;
  47       varargin(1) = [];
  48       nargs--;
  49     else
  50       error ("figure: expecting figure handle or figure number");
  51     endif
  52   endif
  53
  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
  56   ## or switching to.
  57   cf = get (0, "currentfigure");
  58   if (! isempty (cf) && cf != 0)
  59     if (isnan (f) || cf != f)
  60       drawnow ();
  61     endif
  62   endif
  63
  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);
  69         drawnow ();
  70         if (! isempty (varargin))
  71           set (f, varargin{:});
  72         endif
  73       else
  74         f = __go_figure__ (f, varargin{:});
  75       endif
  76     elseif (nargs > 0)
  77       set (f, varargin{:});
  78     endif
  79     set (0, "currentfigure", f);
  80   else
  81     print_usage ();
  82   endif
  83
  84   cf = get (0, "currentfigure");
  85   if (strcmp (get (cf, "__graphics_toolkit__"), "fltk"))
  86     __add_default_menu__ (cf);
  87   endif
  88
  89   if (nargout > 0)
  90     h = f;
  91   endif
  92
  93 endfunction
  94
  95 %!test
  96 %! hf = figure ("visible", "off");
  97 %! unwind_protect
  98 %!   assert (gcf, hf);
  99 %!   assert (isfigure (hf));
 100 %! unwind_protect_cleanup
 101 %!   close (hf);
 102 %! end_unwind_protect