1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
|
## Copyright (C) 2010, 2013 Martin Hepperle
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} {@var{h} =} msgbox (@var{msg})
## @deftypefnx {Function File} {@var{h} =} msgbox (@var{msg}, @var{title})
## @deftypefnx {Function File} {@var{h} =} msgbox (@var{msg}, @var{title}, @var{icon})
## Display @var{msg} using a message dialog box.
##
## The message may have multiple lines separated by newline characters
## (@qcode{"\n"}), or it may be a cellstr array with one element for each
## line. The optional input @var{title} (character string) can be used to
## decorate the dialog caption.
##
## The optional argument @var{icon} selects a dialog icon.
## It can be one of @qcode{"none"} (default), @qcode{"error"},
## @qcode{"help"}, or @qcode{"warn"}.
##
## The return value is always 1.
## @seealso{errordlg, helpdlg, inputdlg, listdlg, questdlg, warndlg}
## @end deftypefn
function retval = msgbox (msg, title = "", varargin)
if (nargin < 1 || nargin > 3)
print_usage ();
endif
retval = message_dialog ("msgbox", msg, title, varargin{:});
endfunction
%!demo
%! disp('- test msgbox message only.');
%! msgbox("Below, you should see 3 lines:\nline #1\nline #2, and\nline #3.");
%!demo
%! disp('- test msgbox message and caption.');
%! msgbox('You should see a single line.','A msgbox');
|