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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
|
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>I/O Dialogs (GNU Octave (version 10.3.0))</title>
<meta name="description" content="I/O Dialogs (GNU Octave (version 10.3.0))">
<meta name="keywords" content="I/O Dialogs (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="GUI-Development.html" rel="up" title="GUI Development">
<link href="Progress-Bar.html" rel="next" title="Progress Bar">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
kbd.key {font-style: normal}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="section-level-extent" id="I_002fO-Dialogs">
<div class="nav-panel">
<p>
Next: <a href="Progress-Bar.html" accesskey="n" rel="next">Progress Bar</a>, Up: <a href="GUI-Development.html" accesskey="u" rel="up">GUI Development</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="I_002fO-Dialogs-1"><span>35.1 I/O Dialogs<a class="copiable-link" href="#I_002fO-Dialogs-1"> ¶</a></span></h3>
<p>Simple dialog menus are available for choosing directories or files. They
return a string variable which can then be used with any command requiring
a filename.
</p>
<a class="index-entry-id" id="index-dialog_002c-displaying-a-dialog-for-selecting-directories"></a>
<a class="anchor" id="XREFuigetdir"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-uigetdir"><span><code class="def-type"><var class="var">dirname</var> =</code> <strong class="def-name">uigetdir</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-uigetdir"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uigetdir-1"><span><code class="def-type"><var class="var">dirname</var> =</code> <strong class="def-name">uigetdir</strong> <code class="def-code-arguments">(<var class="var">init_path</var>)</code><a class="copiable-link" href="#index-uigetdir-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uigetdir-2"><span><code class="def-type"><var class="var">dirname</var> =</code> <strong class="def-name">uigetdir</strong> <code class="def-code-arguments">(<var class="var">init_path</var>, <var class="var">dialog_name</var>)</code><a class="copiable-link" href="#index-uigetdir-2"> ¶</a></span></dt>
<dd><p>Open a GUI dialog for selecting a directory.
</p>
<p>If <var class="var">init_path</var> is not given the current working directory is used.
</p>
<p><var class="var">dialog_name</var> may be used to customize the dialog title.
</p>
<p>The output <var class="var">dirname</var> is a character string with the name of the selected
directory. However, if the ‘<samp class="samp">Cancel</samp>’ button is clicked the output is of
type double with the value <code class="code">0</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFuigetfile">uigetfile</a>, <a class="ref" href="#XREFuiputfile">uiputfile</a>.
</p></dd></dl>
<a class="index-entry-id" id="index-dialog_002c-displaying-a-dialog-for-selecting-files"></a>
<a class="anchor" id="XREFuigetfile"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-uigetfile"><span><code class="def-type">[<var class="var">fname</var>, <var class="var">fpath</var>, <var class="var">fltidx</var>] =</code> <strong class="def-name">uigetfile</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-uigetfile"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uigetfile-1"><span><code class="def-type">[…] =</code> <strong class="def-name">uigetfile</strong> <code class="def-code-arguments">(<var class="var">flt</var>)</code><a class="copiable-link" href="#index-uigetfile-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uigetfile-2"><span><code class="def-type">[…] =</code> <strong class="def-name">uigetfile</strong> <code class="def-code-arguments">(<var class="var">flt</var>, <var class="var">dialog_name</var>)</code><a class="copiable-link" href="#index-uigetfile-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uigetfile-3"><span><code class="def-type">[…] =</code> <strong class="def-name">uigetfile</strong> <code class="def-code-arguments">(<var class="var">flt</var>, <var class="var">dialog_name</var>, <var class="var">default_file</var>)</code><a class="copiable-link" href="#index-uigetfile-3"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uigetfile-4"><span><code class="def-type">[…] =</code> <strong class="def-name">uigetfile</strong> <code class="def-code-arguments">(…, "MultiSelect", <var class="var">mode</var>)</code><a class="copiable-link" href="#index-uigetfile-4"> ¶</a></span></dt>
<dd>
<p>Open a GUI dialog for selecting a file and return the filename <var class="var">fname</var>,
the path to this file <var class="var">fpath</var>, and the filter index <var class="var">fltidx</var>.
</p>
<p><var class="var">flt</var> contains a (list of) file filter string(s) in one of the following
formats:
</p>
<dl class="table">
<dt><code class="code">"/path/to/filename.ext"</code></dt>
<dd><p>If a filename is given then the file extension is extracted and used as
filter. In addition, the path is selected as current path in the dialog and
the filename is selected as default file.
Example: <code class="code">uigetfile ("myfcn.m")</code>
</p>
</dd>
<dt>A single file extension <code class="code">"*.ext"</code></dt>
<dd><p>Example: <code class="code">uigetfile ("*.ext")</code>
</p>
</dd>
<dt>A 2-column cell array</dt>
<dd><p>containing a file extension in the first column and a brief description in
the second column. Example:
<code class="code">uigetfile ({"*.ext", "My Description";"*.xyz", "XYZ-Format"})</code>
</p>
<p>The filter string can also contain a semicolon separated list of filter
extensions. Example:
<code class="code">uigetfile ({"*.gif;*.png;*.jpg", "Supported Picture Formats"})</code>
</p>
</dd>
<dt>A directory name or path name</dt>
<dd><p>If the folder name of path name contains a trailing file separator, the
contents of that folder will be displayed. If no trailing file separator
is present the parent directory is listed. The substring to the right of
the rightmost file separator (if any) will be interpreted as a file or
directory name and if that file or directory exists it will be highlighted.
If the path name or directory name is entirely or partly nonexistent, the
current working directory will be displayed.
No filter will be active.
</p></dd>
</dl>
<p><var class="var">dialog_name</var> can be used to customize the dialog title.
</p>
<p>If <var class="var">default_file</var> is given then it will be selected in the GUI dialog.
If, in addition, a path is given it is also used as current path.
</p>
<p>Two or more files can be selected when setting the <code class="code">"MultiSelect"</code> key
to <code class="code">"on"</code>. In that case, <var class="var">fname</var> is a cell array containing the
files.
</p>
<p>The outputs <var class="var">fname</var> and <var class="var">fpath</var> are strings returning the chosen
name and path, respectively. However, if the ‘<samp class="samp">Cancel</samp>’ button is
clicked the outputs are of type double with a value of <code class="code">0</code>.
<var class="var">fltidx</var> is the index in the list of filter extensions <var class="var">flt</var> that
was selected.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFuiputfile">uiputfile</a>, <a class="ref" href="#XREFuigetdir">uigetdir</a>.
</p></dd></dl>
<a class="index-entry-id" id="index-dialog_002c-displaying-a-dialog-for-storing-files"></a>
<a class="anchor" id="XREFuiputfile"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-uiputfile"><span><code class="def-type">[<var class="var">fname</var>, <var class="var">fpath</var>, <var class="var">fltidx</var>] =</code> <strong class="def-name">uiputfile</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-uiputfile"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uiputfile-1"><span><code class="def-type">[<var class="var">fname</var>, <var class="var">fpath</var>, <var class="var">fltidx</var>] =</code> <strong class="def-name">uiputfile</strong> <code class="def-code-arguments">(<var class="var">flt</var>)</code><a class="copiable-link" href="#index-uiputfile-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uiputfile-2"><span><code class="def-type">[<var class="var">fname</var>, <var class="var">fpath</var>, <var class="var">fltidx</var>] =</code> <strong class="def-name">uiputfile</strong> <code class="def-code-arguments">(<var class="var">flt</var>, <var class="var">dialog_name</var>)</code><a class="copiable-link" href="#index-uiputfile-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uiputfile-3"><span><code class="def-type">[<var class="var">fname</var>, <var class="var">fpath</var>, <var class="var">fltidx</var>] =</code> <strong class="def-name">uiputfile</strong> <code class="def-code-arguments">(<var class="var">flt</var>, <var class="var">dialog_name</var>, <var class="var">default_file</var>)</code><a class="copiable-link" href="#index-uiputfile-3"> ¶</a></span></dt>
<dd><p>Open a GUI dialog for selecting a file.
</p>
<p><var class="var">flt</var> contains a (list of) file filter string(s) in one of the following
formats:
</p>
<dl class="table">
<dt><code class="code">"/path/to/filename.ext"</code></dt>
<dd><p>If a filename is given the file extension is extracted and used as filter.
In addition the path is selected as current path in the dialog and the
filename is selected as default file. Example:
<code class="code">uiputfile ("myfcn.m")</code>
</p>
</dd>
<dt><code class="code">"*.ext"</code></dt>
<dd><p>A single file extension.
Example: <code class="code">uiputfile ("*.ext")</code>
</p>
</dd>
<dt><code class="code">{"*.ext", "My Description"}</code></dt>
<dd><p>A 2-column cell array containing the file extension in the 1st column and
a brief description in the 2nd column. Example:
<code class="code">uiputfile ({"*.ext","My Description";"*.xyz", "XYZ-Format"})</code>
</p></dd>
</dl>
<p>The filter string can also contain a semicolon separated list of filter
extensions. Example:
<code class="code">uiputfile ({"*.gif;*.png;*.jpg", "Supported Picture Formats"})</code>
</p>
<p><var class="var">dialog_name</var> can be used to customize the dialog title.
If <var class="var">default_file</var> is given it is preselected in the GUI dialog.
If, in addition, a path is given it is also used as current path.
</p>
<p><var class="var">fname</var> and <var class="var">fpath</var> return the chosen name and path, respectively.
<var class="var">fltidx</var> is the index in the list of filter extensions <var class="var">flt</var> that
was selected.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFuigetfile">uigetfile</a>, <a class="ref" href="#XREFuigetdir">uigetdir</a>.
</p></dd></dl>
<p>Additionally, there are dialog boxes for displaying help messages, warnings, or
errors, and for getting text input from the user.
</p>
<a class="index-entry-id" id="index-dialog_002c-displaying-an-error-dialog"></a>
<a class="anchor" id="XREFerrordlg"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-errordlg"><span><strong class="def-name">errordlg</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-errordlg"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-errordlg-1"><span><strong class="def-name">errordlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>)</code><a class="copiable-link" href="#index-errordlg-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-errordlg-2"><span><strong class="def-name">errordlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>)</code><a class="copiable-link" href="#index-errordlg-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-errordlg-3"><span><strong class="def-name">errordlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>, <var class="var">opt</var>)</code><a class="copiable-link" href="#index-errordlg-3"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-errordlg-4"><span><code class="def-type"><var class="var">h</var> =</code> <strong class="def-name">errordlg</strong> <code class="def-code-arguments">(…)</code><a class="copiable-link" href="#index-errordlg-4"> ¶</a></span></dt>
<dd><p>Display an error dialog box with error message <var class="var">msg</var> and caption
<var class="var">title</var>.
</p>
<p>The default error message is <code class="code">"This is the default error string."</code>
and the default caption is <code class="code">"Error Dialog"</code>.
</p>
<p>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.
</p>
<p>The third optional argument <var class="var">opt</var> controls the behavior of the dialog.
For details, see <a class="pxref" href="#XREFmsgbox"><code class="code">msgbox</code></a>.
</p>
<p>The return value <var class="var">h</var> is a handle to the figure object used for
building the dialog.
</p>
<p>Examples:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">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");
</pre></div></div>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFhelpdlg">helpdlg</a>, <a class="ref" href="#XREFwarndlg">warndlg</a>, <a class="ref" href="#XREFmsgbox">msgbox</a>, <a class="ref" href="#XREFinputdlg">inputdlg</a>, <a class="ref" href="#XREFlistdlg">listdlg</a>, <a class="ref" href="#XREFquestdlg">questdlg</a>.
</p></dd></dl>
<a class="index-entry-id" id="index-dialog_002c-displaying-a-help-dialog"></a>
<a class="anchor" id="XREFhelpdlg"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-helpdlg"><span><strong class="def-name">helpdlg</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-helpdlg"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-helpdlg-1"><span><strong class="def-name">helpdlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>)</code><a class="copiable-link" href="#index-helpdlg-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-helpdlg-2"><span><strong class="def-name">helpdlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>)</code><a class="copiable-link" href="#index-helpdlg-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-helpdlg-3"><span><code class="def-type"><var class="var">h</var> =</code> <strong class="def-name">helpdlg</strong> <code class="def-code-arguments">(…)</code><a class="copiable-link" href="#index-helpdlg-3"> ¶</a></span></dt>
<dd><p>Display a help dialog box with help message <var class="var">msg</var> and caption
<var class="var">title</var>.
</p>
<p>The default help message is <code class="code">"This is the default help string."</code>
and the default caption is <code class="code">"Help Dialog"</code>.
</p>
<p>The help message may have multiple lines separated by newline characters
("\n"), or it may be a cellstr array with one element for each line.
</p>
<p>The return value <var class="var">h</var> is a handle to the figure object used for
building the dialog.
</p>
<p>Examples:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">helpdlg ("Some helpful text for the user.");
helpdlg ("Some helpful text\nwith two lines.");
helpdlg ({"Some helpful text", "with two lines."});
helpdlg ("Some helpful text for the user.", "Fancy caption");
</pre></div></div>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFerrordlg">errordlg</a>, <a class="ref" href="#XREFwarndlg">warndlg</a>, <a class="ref" href="#XREFmsgbox">msgbox</a>, <a class="ref" href="#XREFinputdlg">inputdlg</a>, <a class="ref" href="#XREFlistdlg">listdlg</a>, <a class="ref" href="#XREFquestdlg">questdlg</a>.
</p></dd></dl>
<a class="index-entry-id" id="index-dialog_002c-displaying-an-input-dialog"></a>
<a class="anchor" id="XREFinputdlg"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-inputdlg"><span><code class="def-type"><var class="var">cstr</var> =</code> <strong class="def-name">inputdlg</strong> <code class="def-code-arguments">(<var class="var">prompt</var>)</code><a class="copiable-link" href="#index-inputdlg"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-inputdlg-1"><span><code class="def-type"><var class="var">cstr</var> =</code> <strong class="def-name">inputdlg</strong> <code class="def-code-arguments">(<var class="var">prompt</var>, <var class="var">title</var>)</code><a class="copiable-link" href="#index-inputdlg-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-inputdlg-2"><span><code class="def-type"><var class="var">cstr</var> =</code> <strong class="def-name">inputdlg</strong> <code class="def-code-arguments">(<var class="var">prompt</var>, <var class="var">title</var>, <var class="var">rowscols</var>)</code><a class="copiable-link" href="#index-inputdlg-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-inputdlg-3"><span><code class="def-type"><var class="var">cstr</var> =</code> <strong class="def-name">inputdlg</strong> <code class="def-code-arguments">(<var class="var">prompt</var>, <var class="var">title</var>, <var class="var">rowscols</var>, <var class="var">defaults</var>)</code><a class="copiable-link" href="#index-inputdlg-3"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-inputdlg-4"><span><code class="def-type"><var class="var">cstr</var> =</code> <strong class="def-name">inputdlg</strong> <code class="def-code-arguments">(<var class="var">prompt</var>, <var class="var">title</var>, <var class="var">rowscols</var>, <var class="var">defaults</var>, <var class="var">options</var>)</code><a class="copiable-link" href="#index-inputdlg-4"> ¶</a></span></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 class="table">
<dt><var class="var">prompt</var></dt>
<dd><p>A cell array with strings labeling each text field. This input is required.
</p>
</dd>
<dt><var class="var">title</var></dt>
<dd><p>String to use for the caption of the dialog. The default is
<code class="code">"Input Dialog"</code>.
</p>
</dd>
<dt><var class="var">rowscols</var></dt>
<dd><p>Specifies the size of the text fields and can take three forms:
</p>
<ol class="enumerate">
<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 class="var">defaults</var></dt>
<dd><p>A list of default values to place in each text field. It must be a cell
array of strings with the same size as <var class="var">prompt</var>.
</p>
</dd>
<dt><var class="var">options</var></dt>
<dd><p>Not supported, only for <small class="sc">MATLAB</small> compatibility.
</p></dd>
</dl>
<p>Example:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">prompt = {"Width", "Height", "Depth"};
defaults = {"1.10", "2.20", "3.30"};
rowscols = [1,10; 2,20; 3,30];
dims = inputdlg (prompt, "Enter Box Dimensions", ...
rowscols, defaults);
</pre></div></div>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFerrordlg">errordlg</a>, <a class="ref" href="#XREFhelpdlg">helpdlg</a>, <a class="ref" href="#XREFlistdlg">listdlg</a>, <a class="ref" href="#XREFmsgbox">msgbox</a>, <a class="ref" href="#XREFquestdlg">questdlg</a>, <a class="ref" href="#XREFwarndlg">warndlg</a>.
</p></dd></dl>
<a class="index-entry-id" id="index-dialog_002c-displaying-a-list-dialog"></a>
<a class="anchor" id="XREFlistdlg"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-listdlg"><span><code class="def-type">[<var class="var">sel</var>, <var class="var">ok</var>] =</code> <strong class="def-name">listdlg</strong> <code class="def-code-arguments">(<var class="var">key</var>, <var class="var">value</var>, …)</code><a class="copiable-link" href="#index-listdlg"> ¶</a></span></dt>
<dd><p>Return user inputs from a list dialog box in a vector of selection indices
(<var class="var">sel</var>) and a flag indicating how the user closed the dialog box
(<var class="var">ok</var>).
</p>
<p>The indices in <var class="var">sel</var> are 1-based.
</p>
<p>The value of <var class="var">ok</var> is 1 if the user closed the box with the OK button,
otherwise it is 0 and <var class="var">sel</var> is empty.
</p>
<p>Input arguments are specified in form of <var class="var">key</var>, <var class="var">value</var> pairs.
The <code class="code">"ListString"</code> argument pair <strong class="strong">must</strong> be specified.
</p>
<p>Valid <var class="var">key</var> and <var class="var">value</var> pairs are:
</p>
<dl class="table">
<dt><code class="code">"ListString"</code></dt>
<dd><p>a cell array of strings specifying the items to list in the dialog.
</p>
</dd>
<dt><code class="code">"SelectionMode"</code></dt>
<dd><p>can be either <code class="code">"Single"</code> (only one item may be selected at a time) or
<code class="code">"Multiple"</code> (default).
</p>
</dd>
<dt><code class="code">"ListSize"</code></dt>
<dd><p>a two-element vector <code class="code">[<var class="var">width</var>, <var class="var">height</var>]</code> specifying the size
of the list field in pixels. The default is [160, 300].
</p>
</dd>
<dt><code class="code">"InitialValue"</code></dt>
<dd><p>a vector containing 1-based indices of elements which will be pre-selected
when the list dialog is first displayed.
The default is 1 (first item).
</p>
</dd>
<dt><code class="code">"Name"</code></dt>
<dd><p>a string to be used as the dialog caption. Default is "".
</p>
</dd>
<dt><code class="code">"PromptString"</code></dt>
<dd><p>a cell array of strings to be displayed above the list of items.
Default is {}.
</p>
</dd>
<dt><code class="code">"OKString"</code></dt>
<dd><p>a string used to label the OK button. Default is <code class="code">"OK"</code>.
</p>
</dd>
<dt><code class="code">"CancelString"</code></dt>
<dd><p>a string used to label the Cancel button. Default is <code class="code">"Cancel"</code>.
</p></dd>
</dl>
<p>Example:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">my_options = {"An item", "another", "yet another"};
[sel, ok] = listdlg ("ListString", my_options,
"SelectionMode", "Multiple");
if (ok == 1)
disp ("You selected:");
for i = 1:numel (sel)
disp (sprintf ("\t%s", my_options{sel(i)}));
endfor
else
disp ("You cancelled.");
endif
</pre></div></div>
<p><strong class="strong">See also:</strong> <a class="ref" href="Terminal-Input.html#XREFmenu">menu</a>, <a class="ref" href="#XREFerrordlg">errordlg</a>, <a class="ref" href="#XREFhelpdlg">helpdlg</a>, <a class="ref" href="#XREFinputdlg">inputdlg</a>, <a class="ref" href="#XREFmsgbox">msgbox</a>, <a class="ref" href="#XREFquestdlg">questdlg</a>, <a class="ref" href="#XREFwarndlg">warndlg</a>.
</p></dd></dl>
<a class="index-entry-id" id="index-dialog_002c-displaying-a-message-dialog"></a>
<a class="anchor" id="XREFmsgbox"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-msgbox"><span><code class="def-type"><var class="var">h</var> =</code> <strong class="def-name">msgbox</strong> <code class="def-code-arguments">(<var class="var">msg</var>)</code><a class="copiable-link" href="#index-msgbox"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-msgbox-1"><span><code class="def-type"><var class="var">h</var> =</code> <strong class="def-name">msgbox</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>)</code><a class="copiable-link" href="#index-msgbox-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-msgbox-2"><span><code class="def-type"><var class="var">h</var> =</code> <strong class="def-name">msgbox</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>, <var class="var">icon</var>)</code><a class="copiable-link" href="#index-msgbox-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-msgbox-3"><span><code class="def-type"><var class="var">h</var> =</code> <strong class="def-name">msgbox</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>, "custom", <var class="var">cdata</var>)</code><a class="copiable-link" href="#index-msgbox-3"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-msgbox-4"><span><code class="def-type"><var class="var">h</var> =</code> <strong class="def-name">msgbox</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>, "custom", <var class="var">cdata</var>, <var class="var">colormap</var>)</code><a class="copiable-link" href="#index-msgbox-4"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-msgbox-5"><span><code class="def-type"><var class="var">h</var> =</code> <strong class="def-name">msgbox</strong> <code class="def-code-arguments">(…, <var class="var">opt</var>)</code><a class="copiable-link" href="#index-msgbox-5"> ¶</a></span></dt>
<dd><p>Display <var class="var">msg</var> using a message 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.
</p>
<p>The optional input <var class="var">title</var> (character string) can be used to decorate
the dialog caption.
</p>
<p>The optional argument <var class="var">icon</var> selects a dialog icon.
It can be one of <code class="code">"none"</code> (default), <code class="code">"error"</code>, <code class="code">"help"</code>,
<code class="code">"warn"</code>, or <code class="code">"custom"</code>. The latter must be followed by an
image array <var class="var">cdata</var>, and for indexed images the associated colormap.
</p>
<p>The final optional argument <var class="var">opt</var> controls the behavior of the dialog.
If <var class="var">opt</var> is a string, it may be one of
</p>
<dl class="table">
<dt><code class="code">"non-modal"</code> (default)</dt>
<dd><p>The dialog is normal.
</p>
</dd>
<dt><code class="code">"modal"</code></dt>
<dd><p>If any dialogs already exist with the same title, the most recent is reused
and all others are closed. The dialog is displayed <code class="code">"modal"</code> which
means it prevents users from interacting with any other GUI element until
the dialog has been closed.
</p>
</dd>
<dt><code class="code">"replace"</code></dt>
<dd><p>If any dialogs already exist with the same title, the most recent is reused
and all others are closed. The resulting dialog is set <code class="code">"non-modal"</code>.
</p></dd>
</dl>
<p>If <var class="var">opt</var> is a structure, it must contain fields <code class="code">"WindowStyle"</code>
and <code class="code">"Interpreter"</code>:
</p>
<dl class="table">
<dt><code class="code">"WindowStyle"</code></dt>
<dd><p>The value must be <code class="code">"non-modal"</code>, <code class="code">"modal"</code>, or
<code class="code">"replace"</code>. See above.
</p>
</dd>
<dt><code class="code">"Interpreter"</code></dt>
<dd><p>Controls the <code class="code">"interpreter"</code> property of the text object used for
displaying the message. The value must be <code class="code">"tex"</code> (default),
<code class="code">"none"</code>, or <code class="code">"latex"</code>.
</p></dd>
</dl>
<p>The return value <var class="var">h</var> is a handle to the figure object used for building
the dialog.
</p>
<p>Examples:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">msgbox ("Some message for the user.");
msgbox ("Some message\nwith two lines.");
msgbox ({"Some message", "with two lines."});
msgbox ("Some message for the user.", "Fancy caption");
## A message dialog box with error icon
msgbox ("Some message for the user.", "Fancy caption", "error");
</pre></div></div>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFerrordlg">errordlg</a>, <a class="ref" href="#XREFhelpdlg">helpdlg</a>, <a class="ref" href="#XREFinputdlg">inputdlg</a>, <a class="ref" href="#XREFlistdlg">listdlg</a>, <a class="ref" href="#XREFquestdlg">questdlg</a>, <a class="ref" href="#XREFwarndlg">warndlg</a>.
</p></dd></dl>
<a class="index-entry-id" id="index-dialog_002c-displaying-a-question-dialog"></a>
<a class="anchor" id="XREFquestdlg"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-questdlg"><span><code class="def-type"><var class="var">btn</var> =</code> <strong class="def-name">questdlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>)</code><a class="copiable-link" href="#index-questdlg"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-questdlg-1"><span><code class="def-type"><var class="var">btn</var> =</code> <strong class="def-name">questdlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>)</code><a class="copiable-link" href="#index-questdlg-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-questdlg-2"><span><code class="def-type"><var class="var">btn</var> =</code> <strong class="def-name">questdlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>, <var class="var">default</var>)</code><a class="copiable-link" href="#index-questdlg-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-questdlg-3"><span><code class="def-type"><var class="var">btn</var> =</code> <strong class="def-name">questdlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>, <var class="var">btn1</var>, <var class="var">btn2</var>, <var class="var">default</var>)</code><a class="copiable-link" href="#index-questdlg-3"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-questdlg-4"><span><code class="def-type"><var class="var">btn</var> =</code> <strong class="def-name">questdlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>, <var class="var">btn1</var>, <var class="var">btn2</var>, <var class="var">btn3</var>, <var class="var">default</var>)</code><a class="copiable-link" href="#index-questdlg-4"> ¶</a></span></dt>
<dd><p>Display <var class="var">msg</var> using a question dialog box and return the caption of
the activated button.
</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.
</p>
<p>The optional <var class="var">title</var> (character string) can be used to specify the
dialog caption. It defaults to <code class="code">"Question Dialog"</code>.
</p>
<p>The dialog may contain two or three buttons which will all close the dialog.
</p>
<p>The string <var class="var">default</var> identifies the default button, which is activated
by pressing the <kbd class="key">ENTER</kbd> key. It must match one of the strings given
in <var class="var">btn1</var>, <var class="var">btn2</var>, or <var class="var">btn3</var>.
</p>
<p>If only <var class="var">msg</var> and <var class="var">title</var> are specified, three buttons with the
default captions <code class="code">"Yes"</code>, <code class="code">"No"</code>, and <code class="code">"Cancel"</code> are used.
</p>
<p>If only two button captions, <var class="var">btn1</var> and <var class="var">btn2</var>, are specified the
dialog will have only these two buttons.
</p>
<p>Examples:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">btn = questdlg ("Close Octave?", "Some fancy title", ...
"Yes", "No", "No");
if (strcmp (btn, "Yes"))
exit ();
endif
</pre></div></div>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFerrordlg">errordlg</a>, <a class="ref" href="#XREFhelpdlg">helpdlg</a>, <a class="ref" href="#XREFinputdlg">inputdlg</a>, <a class="ref" href="#XREFlistdlg">listdlg</a>, <a class="ref" href="#XREFmsgbox">msgbox</a>, <a class="ref" href="#XREFwarndlg">warndlg</a>.
</p></dd></dl>
<a class="index-entry-id" id="index-dialog_002c-displaying-a-warning-dialog"></a>
<a class="anchor" id="XREFwarndlg"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-warndlg"><span><strong class="def-name">warndlg</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-warndlg"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-warndlg-1"><span><strong class="def-name">warndlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>)</code><a class="copiable-link" href="#index-warndlg-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-warndlg-2"><span><strong class="def-name">warndlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>)</code><a class="copiable-link" href="#index-warndlg-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-warndlg-3"><span><strong class="def-name">warndlg</strong> <code class="def-code-arguments">(<var class="var">msg</var>, <var class="var">title</var>, <var class="var">opt</var>)</code><a class="copiable-link" href="#index-warndlg-3"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-warndlg-4"><span><code class="def-type"><var class="var">h</var> =</code> <strong class="def-name">warndlg</strong> <code class="def-code-arguments">(…)</code><a class="copiable-link" href="#index-warndlg-4"> ¶</a></span></dt>
<dd><p>Display a warning dialog box with warning message <var class="var">msg</var> and caption
<var class="var">title</var>.
</p>
<p>The default warning message is
<code class="code">"This is the default warning string."</code> and the default caption is
<code class="code">"Warning Dialog"</code>.
</p>
<p>The warning message may have multiple lines separated by newline characters
("\n"), or it may be a cellstr array with one element for each line.
</p>
<p>The third optional argument <var class="var">opt</var> controls the behavior of the dialog.
For details, see <a class="pxref" href="#XREFmsgbox"><code class="code">msgbox</code></a>.
</p>
<p>The return value <var class="var">h</var> is a handle to the figure object used for
building the dialog.
</p>
<p>Examples:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">warndlg ("Some warning text for the user.");
warndlg ("Some warning text\nwith two lines.");
warndlg ({"Some warning text", "with two lines."});
warndlg ("Some warning text for the user.", "Fancy caption");
</pre></div></div>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFerrordlg">errordlg</a>, <a class="ref" href="#XREFhelpdlg">helpdlg</a>, <a class="ref" href="#XREFmsgbox">msgbox</a>, <a class="ref" href="#XREFinputdlg">inputdlg</a>, <a class="ref" href="#XREFlistdlg">listdlg</a>, <a class="ref" href="#XREFquestdlg">questdlg</a>.
</p></dd></dl>
<a class="index-entry-id" id="index-dialog_002c-displaying-a-font-selection-dialog"></a>
<a class="anchor" id="XREFuisetfont"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-uisetfont"><span><strong class="def-name">uisetfont</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-uisetfont"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uisetfont-1"><span><strong class="def-name">uisetfont</strong> <code class="def-code-arguments">(<var class="var">h</var>)</code><a class="copiable-link" href="#index-uisetfont-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uisetfont-2"><span><strong class="def-name">uisetfont</strong> <code class="def-code-arguments">(<var class="var">fontstruct</var>)</code><a class="copiable-link" href="#index-uisetfont-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uisetfont-3"><span><strong class="def-name">uisetfont</strong> <code class="def-code-arguments">(…, <var class="var">title</var>)</code><a class="copiable-link" href="#index-uisetfont-3"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-uisetfont-4"><span><code class="def-type"><var class="var">fontstruct</var> =</code> <strong class="def-name">uisetfont</strong> <code class="def-code-arguments">(…)</code><a class="copiable-link" href="#index-uisetfont-4"> ¶</a></span></dt>
<dd><p>Open a font selection dialog.
</p>
<p>If the first argument is a handle to a text, axes, or uicontrol object,
pressing the OK button will change the font properties of the object.
</p>
<p>The first argument may also be a structure with fields <code class="code">FontName</code>,
<code class="code">FontWeight</code>, <code class="code">FontAngle</code>, <code class="code">FontUnits</code>, and <code class="code">FontSize</code>,
indicating the initially selected font.
</p>
<p>The title of the dialog window can be specified by using the last argument
<var class="var">title</var>.
</p>
<p>If an output argument <var class="var">fontstruct</var> is requested, the selected font
structure is returned. Otherwise, the font information is displayed
onscreen.
</p>
<p>Programming Note: On systems that don’t use FontConfig natively (all but
Linux), the font cache is built when Octave is installed. You will need to
run <code class="code">system ("fc-cache -fv")</code> manually after installing new fonts.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="GUI-Utility-Functions.html#XREFlistfonts">listfonts</a>, <a class="ref" href="Plot-Annotations.html#XREFtext">text</a>, <a class="ref" href="Creating-Graphics-Objects.html#XREFaxes">axes</a>, <a class="ref" href="UI-Elements.html#XREFuicontrol">uicontrol</a>.
</p></dd></dl>
<p>For creating new dialog types, there is a dialog function.
</p>
<a class="index-entry-id" id="index-dialog_002c-displaying-a-modal-dialog"></a>
<a class="anchor" id="XREFdialog"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-dialog"><span><code class="def-type"><var class="var">h</var> =</code> <strong class="def-name">dialog</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-dialog"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-dialog-1"><span><code class="def-type"><var class="var">h</var> =</code> <strong class="def-name">dialog</strong> <code class="def-code-arguments">("<var class="var">property</var>", <var class="var">value</var>, …)</code><a class="copiable-link" href="#index-dialog-1"> ¶</a></span></dt>
<dd>
<p>Create an empty modal dialog window to which other uicontrols can be added.
</p>
<p>The dialog box is a figure object with properties as recommended for a
dialog box.
</p>
<p>The default properties differing from a figure are:
</p>
<dl class="table">
<dt>buttondownfcn</dt>
<dd><p><code class="code">if isempty (allchild(gcbf)), close (gcbf), endif</code>
</p>
</dd>
<dt>colormap</dt>
<dd><p>[]
</p>
</dd>
<dt>color</dt>
<dd><p>defaultuicontrolbackgroundcolor
</p>
</dd>
<dt>dockcontrols</dt>
<dd><p>off
</p>
</dd>
<dt>handlevisibility</dt>
<dd><p>callback
</p>
</dd>
<dt>integerhandle</dt>
<dd><p>off
</p>
</dd>
<dt>inverthardcopy</dt>
<dd><p>off
</p>
</dd>
<dt>menubar</dt>
<dd><p>none
</p>
</dd>
<dt>numbertitle</dt>
<dd><p>off
</p>
</dd>
<dt>paperpositionmode</dt>
<dd><p>auto
</p>
</dd>
<dt>resize</dt>
<dd><p>off
</p>
</dd>
<dt>windowstyle</dt>
<dd><p>modal
</p>
</dd>
</dl>
<p>Multiple property-value pairs may be specified for the dialog object, but
they must appear in pairs. The full list of properties is documented at
<a class="ref" href="Figure-Properties.html">Figure Properties</a>.
</p>
<p>The return value <var class="var">h</var> is a graphics handle to the created figure.
</p>
<p>Example:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">## create an empty dialog window titled "Dialog Example"
h = dialog ("name", "Dialog Example");
## create a button (default style)
b = uicontrol (h, "string", "OK",
"position", [10 10 150 40],
"callback", "delete (gcf)");
## wait for dialog to resume or close
uiwait (h);
</pre></div></div>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFerrordlg">errordlg</a>, <a class="ref" href="#XREFmsgbox">msgbox</a>, <a class="ref" href="#XREFquestdlg">questdlg</a>, <a class="ref" href="#XREFwarndlg">warndlg</a>, <a class="ref" href="Multiple-Plot-Windows.html#XREFfigure">figure</a>, <a class="ref" href="GUI-Utility-Functions.html#XREFuiwait">uiwait</a>.
</p></dd></dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Progress-Bar.html">Progress Bar</a>, Up: <a href="GUI-Development.html">GUI Development</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
