octave_packages/java-1.2.8/helpdlg.m

   1 ## Copyright (C) 2010 Martin Hepperle
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify
   4 ## it under the terms of the GNU General Public License as published by
   5 ## the Free Software Foundation; either version 2 of the License, or
   6 ## (at your option) any later version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful,
   9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 ## GNU General Public License for more details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License
  14 ## along with this program; If not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function file} {@var{P} =} helpdlg (@var{MESSAGE} [,@var{TITLE}])
  18 ##
  19 ## Displays a @var{MESSAGE} in a help dialog box.
  20 ## The help message can have multiple lines, separated by a newline character '\n'.
  21 ## The @var{TITLE} can be used optionally to decorate the dialog caption.
  22 ## The return value is always 1.
  23 ##
  24 ## @end deftypefn
  25 ## @seealso{errordlg, inputdlg, listdlg, questdlg, warndlg}
  26
  27 function ret = helpdlg(message,varargin)
  28
  29   switch length (varargin)
  30   case 0
  31      title = "Help Dialog";
  32   otherwise
  33      title = varargin{1};
  34   endswitch
  35
  36   ret = java_invoke ("org.octave.JDialogBox", "helpdlg", message, title);
  37
  38 endfunction