octave_packages/m/plot/gtext.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} {} gtext (@var{s})
  21 ## @deftypefnx {Function File} {} gtext (@{@var{s1}; @var{s2}; @dots{}@})
  22 ## @deftypefnx {Function File} {} gtext (@dots{}, @var{prop}, @var{val})
  23 ## Place text on the current figure using the mouse.  The text is defined
  24 ## by the string @var{s}.  If @var{s} is a cell array, each element of the cell
  25 ## array is written to a separate line.  Additional arguments are passed to
  26 ## the underlying text object as properties.
  27 ## @seealso{ginput, text}
  28 ## @end deftypefn
  29
  30 function gtext (s, varargin)
  31
  32   if (nargin < 1)
  33     print_usage ();
  34   endif
  35
  36   if (! (ischar (s) || iscellstr (s)))
  37     error ("gtext: S must be a string or cell array of strings");
  38   endif
  39
  40   if (! isempty (s))
  41     [x, y] = ginput (1);
  42     text (x, y, s, varargin{:});
  43   endif
  44
  45 endfunction
  46
  47 ## Remove from test statistics.  No real tests possible.
  48 %!test
  49 %! assert (1);