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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Octave: Dialog Box Functions</title>
<meta name="description" content="GNU Octave: Dialog Box Functions">
<meta name="keywords" content="GNU Octave: Dialog Box Functions">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Java-Interface.html#Java-Interface" rel="up" title="Java Interface">
<link href="FAQ-_002d-Frequently-asked-Questions.html#FAQ-_002d-Frequently-asked-Questions" rel="next" title="FAQ - Frequently asked Questions">
<link href="Java-Interface-Functions.html#Java-Interface-Functions" rel="prev" title="Java Interface Functions">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Dialog-Box-Functions"></a>
<div class="header">
<p>
Next: <a href="FAQ-_002d-Frequently-asked-Questions.html#FAQ-_002d-Frequently-asked-Questions" accesskey="n" rel="next">FAQ - Frequently asked Questions</a>, Previous: <a href="Java-Interface-Functions.html#Java-Interface-Functions" accesskey="p" rel="prev">Java Interface Functions</a>, Up: <a href="Java-Interface.html#Java-Interface" accesskey="u" rel="up">Java Interface</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Dialog-Box-Functions-1"></a>
<h3 class="section">37.2 Dialog Box Functions</h3>
<p>The following functions all use the Java Interface to provide some form
of dialog box.
</p>
<a name="index-dialog_002c-displaying-a-warning-dialog"></a>
<a name="XREFmsgbox"></a><dl>
<dt><a name="index-msgbox"></a>Function File: <em><var>h</var> =</em> <strong>msgbox</strong> <em>(<var>msg</var>)</em></dt>
<dt><a name="index-msgbox-1"></a>Function File: <em><var>h</var> =</em> <strong>msgbox</strong> <em>(<var>msg</var>, <var>title</var>)</em></dt>
<dt><a name="index-msgbox-2"></a>Function File: <em><var>h</var> =</em> <strong>msgbox</strong> <em>(<var>msg</var>, <var>title</var>, <var>icon</var>)</em></dt>
<dd><p>Display <var>msg</var> using a message dialog box.
</p>
<p>The message may have multiple lines separated by newline characters
(<code>"\n"</code>), or it may be a cellstr array with one element for each
line. The optional input <var>title</var> (character string) can be used to
decorate the dialog caption.
</p>
<p>The optional argument <var>icon</var> selects a dialog icon.
It can be one of <code>"none"</code> (default), <code>"error"</code>,
<code>"help"</code>, or <code>"warn"</code>.
</p>
<p>The return value is always 1.
</p>
<p><strong>See also:</strong> <a href="#XREFerrordlg">errordlg</a>, <a href="#XREFhelpdlg">helpdlg</a>, <a href="#XREFinputdlg">inputdlg</a>, <a href="#XREFlistdlg">listdlg</a>, <a href="#XREFquestdlg">questdlg</a>, <a href="#XREFwarndlg">warndlg</a>.
</p></dd></dl>
<a name="index-dialog_002c-displaying-an-error-dialog"></a>
<a name="XREFerrordlg"></a><dl>
<dt><a name="index-errordlg"></a>Function File: <em><var>h</var> =</em> <strong>errordlg</strong> <em>(<var>msg</var>)</em></dt>
<dt><a name="index-errordlg-1"></a>Function File: <em><var>h</var> =</em> <strong>errordlg</strong> <em>(<var>msg</var>, <var>title</var>)</em></dt>
<dd><p>Display <var>msg</var> using an error dialog box.
</p>
<p>The message may have multiple lines separated by newline characters
("\n"), or it may be a cellstr array with one element for each
line. The optional input <var>title</var> (character string) can be used to
set the dialog caption. The default title is <code>"Error Dialog"</code>.
</p>
<p>The return value is always 1.
</p>
<p><strong>See also:</strong> <a href="#XREFhelpdlg">helpdlg</a>, <a href="#XREFinputdlg">inputdlg</a>, <a href="#XREFlistdlg">listdlg</a>, <a href="#XREFmsgbox">msgbox</a>, <a href="#XREFquestdlg">questdlg</a>, <a href="#XREFwarndlg">warndlg</a>.
</p></dd></dl>
<a name="index-dialog_002c-displaying-a-help-dialog"></a>
<a name="XREFhelpdlg"></a><dl>
<dt><a name="index-helpdlg"></a>Function File: <em><var>h</var> =</em> <strong>helpdlg</strong> <em>(<var>msg</var>)</em></dt>
<dt><a name="index-helpdlg-1"></a>Function File: <em><var>h</var> =</em> <strong>helpdlg</strong> <em>(<var>msg</var>, <var>title</var>)</em></dt>
<dd><p>Display <var>msg</var> in a help dialog box.
</p>
<p>The message may have multiple lines separated by newline characters
("\n"), or it may be a cellstr array with one element for each
line. The optional input <var>title</var> (character string) can be used to
set the dialog caption. The default title is <code>"Help Dialog"</code>.
</p>
<p>The return value is always 1.
</p>
<p><strong>See also:</strong> <a href="#XREFerrordlg">errordlg</a>, <a href="#XREFinputdlg">inputdlg</a>, <a href="#XREFlistdlg">listdlg</a>, <a href="#XREFmsgbox">msgbox</a>, <a href="#XREFquestdlg">questdlg</a>, <a href="#XREFwarndlg">warndlg</a>.
</p></dd></dl>
<a name="index-dialog_002c-displaying-an-input-dialog"></a>
<a name="XREFinputdlg"></a><dl>
<dt><a name="index-inputdlg"></a>Function File: <em><var>cstr</var> =</em> <strong>inputdlg</strong> <em>(<var>prompt</var>)</em></dt>
<dt><a name="index-inputdlg-1"></a>Function File: <em><var>cstr</var> =</em> <strong>inputdlg</strong> <em>(<var>prompt</var>, <var>title</var>)</em></dt>
<dt><a name="index-inputdlg-2"></a>Function File: <em><var>cstr</var> =</em> <strong>inputdlg</strong> <em>(<var>prompt</var>, <var>title</var>, <var>rowscols</var>)</em></dt>
<dt><a name="index-inputdlg-3"></a>Function File: <em><var>cstr</var> =</em> <strong>inputdlg</strong> <em>(<var>prompt</var>, <var>title</var>, <var>rowscols</var>, <var>defaults</var>)</em></dt>
<dd><p>Return user input from a multi-textfield dialog box in a cell array
of strings, or an empty cell array if the dialog is closed by the
Cancel button.
</p>
<p>Inputs:
</p>
<dl compact="compact">
<dt><var>prompt</var></dt>
<dd><p>A cell array with strings labeling each text field. This input is required.
</p>
</dd>
<dt><var>title</var></dt>
<dd><p>String to use for the caption of the dialog. The default is <code>"Input
Dialog"</code>.
</p>
</dd>
<dt><var>rowscols</var></dt>
<dd><p>Specifies the size of the text fields and can take three forms:
</p>
<ol>
<li> a scalar value which defines the number of rows used for each
text field.
</li><li> a vector which defines the individual number of rows
used for each text field.
</li><li> a matrix which defines the individual number of rows and
columns used for each text field. In the matrix each row describes
a single text field. The first column specifies the number of input
rows to use and the second column specifies the text field width.
</li></ol>
</dd>
<dt><var>defaults</var></dt>
<dd><p>A list of default values to place in each text fields. It must be
a cell array of strings with the same size as <var>prompt</var>.
</p></dd>
</dl>
<p><strong>See also:</strong> <a href="#XREFerrordlg">errordlg</a>, <a href="#XREFhelpdlg">helpdlg</a>, <a href="#XREFlistdlg">listdlg</a>, <a href="#XREFmsgbox">msgbox</a>, <a href="#XREFquestdlg">questdlg</a>, <a href="#XREFwarndlg">warndlg</a>.
</p></dd></dl>
<a name="index-dialog_002c-displaying-a-list-dialog"></a>
<a name="XREFlistdlg"></a><dl>
<dt><a name="index-listdlg"></a>Function File: <em>[<var>sel</var>, <var>ok</var>] =</em> <strong>listdlg</strong> <em>(<var>key</var>, <var>value</var>, …)</em></dt>
<dd><p>Return user inputs from a list dialog box in a vector of
selection indices <var>sel</var> and a flag <var>ok</var> indicating how the
user closed the dialog box. The value of <var>ok</var> is 1 if the user
closed the box with the OK button, otherwise it is 0 and <var>sel</var> is
empty.
</p>
<p>The indices in <var>sel</var> are 1-based.
</p>
<p>The arguments are specified in form of <var>key</var>, <var>value</var> pairs.
The <code>"ListString"</code> argument pair must be specified.
</p>
<p>Valid <var>key</var> and <var>value</var> pairs are:
</p>
<dl compact="compact">
<dt><code>"ListString"</code></dt>
<dd><p>a cell array of strings comprising the content of the list.
</p>
</dd>
<dt><code>"SelectionMode"</code></dt>
<dd><p>can be either <code>"Single"</code> or <code>"Multiple"</code> (default).
</p>
</dd>
<dt><code>"ListSize"</code></dt>
<dd><p>a vector with two elements <var>width</var> and <var>height</var> defining
the size of the list field in pixels. Default is [160 300].
</p>
</dd>
<dt><code>"InitialValue"</code></dt>
<dd><p>a vector containing 1-based indices of preselected elements. Default
is 1 (first item).
</p>
</dd>
<dt><code>"Name"</code></dt>
<dd><p>a string to be used as the dialog caption. Default is "".
</p>
</dd>
<dt><code>"PromptString"</code></dt>
<dd><p>a cell array of strings to be displayed above the list field. Default
is {}.
</p>
</dd>
<dt><code>"OKString"</code></dt>
<dd><p>a string used to label the OK button. Default is <code>"OK"</code>.
</p>
</dd>
<dt><code>"CancelString"</code></dt>
<dd><p>a string used to label the Cancel button. Default is <code>"Cancel"</code>.
</p></dd>
</dl>
<p>Example:
</p>
<div class="example">
<pre class="example">[sel, ok] = listdlg ("ListString", {"An item", "another", "yet another"},
"SelectionMode", "Multiple");
if (ok == 1)
for i = 1:numel (sel)
disp (sel(i));
endfor
endif
</pre></div>
<p><strong>See also:</strong> <a href="Terminal-Input.html#XREFmenu">menu</a>, <a href="#XREFerrordlg">errordlg</a>, <a href="#XREFhelpdlg">helpdlg</a>, <a href="#XREFinputdlg">inputdlg</a>, <a href="#XREFmsgbox">msgbox</a>, <a href="#XREFquestdlg">questdlg</a>, <a href="#XREFwarndlg">warndlg</a>.
</p></dd></dl>
<a name="index-dialog_002c-displaying-a-question-dialog"></a>
<a name="XREFquestdlg"></a><dl>
<dt><a name="index-questdlg"></a>Function File: <em><var>btn</var> =</em> <strong>questdlg</strong> <em>(<var>msg</var>)</em></dt>
<dt><a name="index-questdlg-1"></a>Function File: <em><var>btn</var> =</em> <strong>questdlg</strong> <em>(<var>msg</var>, <var>title</var>)</em></dt>
<dt><a name="index-questdlg-2"></a>Function File: <em><var>btn</var> =</em> <strong>questdlg</strong> <em>(<var>msg</var>, <var>title</var>, <var>default</var>)</em></dt>
<dt><a name="index-questdlg-3"></a>Function File: <em><var>btn</var> =</em> <strong>questdlg</strong> <em>(<var>msg</var>, <var>title</var>, <var>btn1</var>, <var>btn2</var>, <var>default</var>)</em></dt>
<dt><a name="index-questdlg-4"></a>Function File: <em><var>btn</var> =</em> <strong>questdlg</strong> <em>(<var>msg</var>, <var>title</var>, <var>btn1</var>, <var>btn2</var>, <var>btn3</var>, <var>default</var>)</em></dt>
<dd><p>Display <var>msg</var> using a question dialog box and return the caption
of the activated button.
</p>
<p>The dialog may contain two or three buttons which will all close the dialog.
</p>
<p>The message may have multiple lines separated by newline characters
("\n"), or it may be a cellstr array with one element for each
line. The optional <var>title</var> (character string) can be used to
decorate the dialog caption.
</p>
<p>The string <var>default</var> identifies the default button,
which is activated by pressing the <tt class="key">ENTER</tt> key.
It must match one of the strings given in <var>btn1</var>, <var>btn2</var>, or
<var>btn3</var>.
</p>
<p>If only <var>msg</var> and <var>title</var> are specified, three buttons with
the default captions <code>"Yes"</code>, <code>"No"</code>, and <code>"Cancel"</code> are
used.
</p>
<p>If only two button captions, <var>btn1</var> and <var>btn2</var>, are specified
the dialog will have only these two buttons.
</p>
<p><strong>See also:</strong> <a href="#XREFerrordlg">errordlg</a>, <a href="#XREFhelpdlg">helpdlg</a>, <a href="#XREFinputdlg">inputdlg</a>, <a href="#XREFlistdlg">listdlg</a>, <a href="#XREFwarndlg">warndlg</a>.
</p></dd></dl>
<a name="index-dialog_002c-displaying-a-warning-dialog-1"></a>
<a name="XREFwarndlg"></a><dl>
<dt><a name="index-warndlg"></a>Function File: <em><var>h</var> =</em> <strong>warndlg</strong> <em>(<var>msg</var>)</em></dt>
<dt><a name="index-warndlg-1"></a>Function File: <em><var>h</var> =</em> <strong>warndlg</strong> <em>(<var>msg</var>, <var>title</var>)</em></dt>
<dd><p>Display <var>msg</var> using a warning dialog box.
</p>
<p>The message may have multiple lines separated by newline characters
("\n"), or it may be a cellstr array with one element for each
line. The optional input <var>title</var> (character string) can be used to
set the dialog caption. The default title is <code>"Warning Dialog"</code>.
</p>
<p><strong>See also:</strong> <a href="#XREFhelpdlg">helpdlg</a>, <a href="#XREFinputdlg">inputdlg</a>, <a href="#XREFlistdlg">listdlg</a>, <a href="#XREFquestdlg">questdlg</a>.
</p></dd></dl>
<hr>
<div class="header">
<p>
Next: <a href="FAQ-_002d-Frequently-asked-Questions.html#FAQ-_002d-Frequently-asked-Questions" accesskey="n" rel="next">FAQ - Frequently asked Questions</a>, Previous: <a href="Java-Interface-Functions.html#Java-Interface-Functions" accesskey="p" rel="prev">Java Interface Functions</a>, Up: <a href="Java-Interface.html#Java-Interface" accesskey="u" rel="up">Java Interface</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
