annotate scripts/ui/private/message_dialog.m @ 16508:f19e24c97b20

move common warndlg, errordlg, helpdlg, and msgbox code to private function * message_dialog.m: New file. * scripts/ui/module.mk: Include it in the list of functions. * errordlg.m, helpdlg.m, warndlg.m, msgbox.m: Call message_dialog to do most of the work.
author John W. Eaton <jwe@octave.org>
date Fri, 12 Apr 2013 18:17:26 -0400
parents
children 7f2395651a1c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16508
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
1 ## Copyright (C) 2010 Martin Hepperle
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2 ##
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4 ##
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ## your option) any later version.
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 ##
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 ##
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{h} =} message_dialog (@var{caller}, @var{msg}, @var{title}, @var{icon})
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
21 ## Undocumented internal function.
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22 ## @end deftypefn
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
23
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
24 function retval = message_dialog (caller, msg, title = "", icon)
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 if (! ischar (msg))
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 if (iscell (msg))
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28 msg = sprintf ("%s\n", msg{:});
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29 msg(end) = "";
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30 else
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
31 error ("%s: MSG must be a character string or cellstr array", caller);
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
32 endif
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 endif
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 if (! ischar (title))
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36 error ("%s: TITLE must be a character string", caller);
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 endif
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 dlg = "emptydlg";
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 if (nargin == 4)
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 switch (icon)
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42 case "error"
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 dlg = "errordlg";
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 case "help"
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 dlg = "helpdlg";
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 case "warn"
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 dlg = "warndlg";
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48 case "none"
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49 dlg = "emptydlg";
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50 otherwise
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 error ("%s: ICON is not a valid type", caller);
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52 endswitch
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53 endif
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 if (__have_feature__ ("JAVA"))
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56 retval = javaMethod (dlg, "org.octave.JDialogBox", msg, title);
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57 if (retval)
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 return;
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 endif
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 endif
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 ## FIXME -- provide terminal-based implementation here?
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64 if (! retval)
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
65 error ("%s is not available in this version of Octave", dlg);
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 endif
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67
f19e24c97b20 move common warndlg, errordlg, helpdlg, and msgbox code to private function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 endfunction