octave_packages/m/plot/waitforbuttonpress.m

   1 ## Copyright (C) 2004-2012 Petr Mikulik
   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{b} =} waitforbuttonpress ()
  21 ## Wait for button or mouse press.over a figure window.  The value of
  22 ## @var{b} returns 0 if a mouse button was pressed or 1 is a key was
  23 ## pressed.
  24 ## @seealso{ginput}
  25 ## @end deftypefn
  26
  27 ## The original version of this code bore the copyright
  28 ## Author: Petr Mikulik
  29 ## License: public domain
  30
  31 function a = waitforbuttonpress ()
  32
  33   if (nargin != 0 || nargout > 1)
  34     print_usage ();
  35   endif
  36
  37   [x, y, k] = ginput (1);
  38
  39   if (nargout == 1)
  40     if (k <= 5)
  41       a = 0;
  42     else
  43       a = 1;
  44     endif
  45   endif
  46
  47 endfunction