Mercurial > octave
view scripts/gui/errordlg.m @ 31548:c8ad083a5802 stable
maint: Clean up m-files before Octave 8.1 release.
* external.txi, oop.txi, Table.h, documentation.cc, gui-preferences-ed.h,
lo-specfun.cc, range.tst : Eliminate triple newlines.
* Map.m, MemoizedFunction.m, delaunayn.m, inputParser.m,
__publish_latex_output__.m, publish.m, unpack.m, fminbnd.m,
__add_default_menu__.m, gammainc.m, gallery.m, hadamard.m, weboptions.m:
Add newline after keyword "function" or before keyword "endfunction" for
readability.
* getaudiodata.m, pkg.m : Add semicolon to end of line for error() statement.
* movegui.m: Combine mutliple calls to set() into one for performance.
* __unimplemented__.m (missing_functions): Remove missing functions that have
been implemented.
* __vectorize__.m, check_default_input.m, betaincinv.m, gammaincinv.m:
Remove semicolon at end of line with "function" declaration.
* weboptions.m: Remove semicolon at end of line with "if" keyword.
* integrate_adaptive.m, factor.m: Use keyword "endif" rather than bare "end".
author | Rik <rik@octave.org> |
---|---|
date | Fri, 25 Nov 2022 21:23:54 -0800 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2010-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} errordlg () ## @deftypefnx {} {} errordlg (@var{msg}) ## @deftypefnx {} {} errordlg (@var{msg}, @var{title}) ## @deftypefnx {} {} errordlg (@var{msg}, @var{title}, @var{opt}) ## @deftypefnx {} {@var{h} =} errordlg (@dots{}) ## Display an error dialog box with error message @var{msg} and caption ## @var{title}. ## ## The default error message is @qcode{"This is the default error string.@:"} ## and the default caption is @qcode{"Error Dialog"}. ## ## The error message may have multiple lines separated by newline characters ## ("\n"), or it may be a cellstr array with one element for each line. ## ## The third optional argument @var{opt} controls the behavior of the dialog. ## For details, @pxref{XREFmsgbox,,@code{msgbox}}. ## ## The return value @var{h} is a handle to the figure object used for ## building the dialog. ## ## Examples: ## ## @example ## @group ## errordlg ("Some fancy error occurred."); ## errordlg ("Some fancy error\nwith two lines."); ## errordlg (@{"Some fancy error", "with two lines."@}); ## errordlg ("Some fancy error occurred.", "Fancy caption"); ## @end group ## @end example ## ## @seealso{helpdlg, warndlg, msgbox, inputdlg, listdlg, questdlg} ## @end deftypefn function h = errordlg (varargin) msg = "This is the default error."; tit = "Error Dialog"; opt = "non-modal"; nargs = numel (varargin); if (nargs > 3) print_usage (); elseif (nargs == 1) msg = varargin{1}; elseif (nargs == 2) msg = varargin{1}; tit = varargin{2}; elseif (nargs == 3) msg = varargin{1}; tit = varargin{2}; opt = varargin{3}; endif htmp = msgbox (msg, tit, "error", opt); if (nargout) h = htmp; endif endfunction ## No BIST tests. This function just dispatches to msgbox(). %!assert (1)