octave_packages/m/plot/ginput.m

   1 ## Copyright (C) 2008-2012 David Bateman
   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{x}, @var{y}, @var{buttons}] =} ginput (@var{n})
  21 ## Return which mouse buttons were pressed and keys were hit on the current
  22 ## figure.  If @var{n} is defined, then wait for @var{n} mouse clicks
  23 ## before returning.  If @var{n} is not defined, then @code{ginput} will
  24 ## loop until the return key @key{RET} is pressed.
  25 ## @end deftypefn
  26
  27 function varargout = ginput (n)
  28
  29   if (nargin > 1)
  30     print_usage ();
  31   endif
  32
  33   f = gcf ();
  34   drawnow ();
  35   toolkit = (get (f, "__graphics_toolkit__"));
  36
  37   varargout = cell (1, nargout);
  38   if (nargin == 0)
  39     [varargout{:}] = feval (strcat ("__", toolkit, "_ginput__"), f);
  40   else
  41     [varargout{:}] = feval (strcat ("__", toolkit, "_ginput__"), f, n);
  42   endif
  43
  44 endfunction
  45
  46 ## Remove from test statistics.  No real tests possible.
  47 %!test
  48 %! assert (1);