Mercurial > octave-nkf

comparison doc/interpreter/gui.txi @ 13943:5820f8ce683e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Add undocumented functions to manual for 3.6.0 release * gui.txi: New manual chapter for GUI-related functions * Makefile.am: Add new gui.txi to build * aspell-octave.en.pws: Add new words to spellcheck dictionary * io.txi: Move file I/O dialogs to gui.txi * octave.texi: Add new GUI chapter to manual * strings.txi: Add is_dq_string and is_sq_string to manual * system.txi: Add usejava to manual * guidata.m: Fix incorrect use of @deftypefn * uicontrol.m: Fix incorrect use of @deftypefn * uiresume.m: Fix incorrect use of @deftypefn * uiwait.m: Fix incorrect use of @deftypefn * addpref.m, getpref.m, ispref.m, rmpref.m, setpref.m: Adjust seealso links
author Rik <octave@nomad.inbox5.com>
date Sat, 26 Nov 2011 17:25:05 -0800
parents
children 72c96de7a403
comparison
equal deleted inserted replaced
13942:d672edef956e 13943:5820f8ce683e
1 @c Copyright (C) 2011 Rik Wehbring
2 @c
3 @c This file is part of Octave.
4 @c
5 @c Octave is free software; you can redistribute it and/or modify it
6 @c under the terms of the GNU General Public License as published by the
7 @c Free Software Foundation; either version 3 of the License, or (at
8 @c your option) any later version.
9 @c
10 @c Octave is distributed in the hope that it will be useful, but WITHOUT
11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 @c for more details.
14 @c
15 @c You should have received a copy of the GNU General Public License
16 @c along with Octave; see the file COPYING. If not, see
17 @c <http://www.gnu.org/licenses/>.
18
19 @node GUI Development
20 @chapter GUI Development
21
22 Octave is principally a batch or command-line language. However, it does
23 offer some limited features for constructing graphical interfaces for
24 interacting with users.
25
26 The GUI elements available are I/O dialogs and a progress bar. For example,
27 rather than hardcoding a filename for output results a script can open a dialog
28 box and allow the user to choose a file. Similarly, if a calculation is
29 expected to take a long time a script can display a progress bar.
30
31 Several utility functions make it possible to store private data for use with
32 a GUI which will not pollute the user's variable space.
33
34 Finally, a program written in Octave might want to have long term storage of
35 preferences or state variables. This can be done with user-defined
36 preferences.
37
38 @menu
39 * I/O Dialogs::
40 * Progress Bar::
41 * GUI Utility Functions::
42 * User-Defined Preferences::
43 @end menu
44
45 @node I/O Dialogs
46 @section I/O Dialogs
47
48 Simple dialog menus are available for choosing directories or files. They
49 return a string variable which can then be used with any command requiring
50 a file name.
51
52 @DOCSTRING(uigetdir)
53
54 @DOCSTRING(uigetfile)
55
56 @DOCSTRING(uiputfile)
57
58 @node Progress Bar
59 @section Progress Bar
60 @cindex Progress Bar
61
62 @DOCSTRING(waitbar)
63
64 @node GUI Utility Functions
65 @section GUI Utility Functions
66
67 These functions do not implement a GUI element but are useful when developing
68 programs that do. @strong{Warning:} The functions @code{uiwait},
69 @code{uiresume}, and @code{waitfor} are only available for the FLTK tooolkit.
70
71 @DOCSTRING(guidata)
72
73 @DOCSTRING(guihandles)
74
75 @DOCSTRING(uiwait)
76
77 @DOCSTRING(uiresume)
78
79 @DOCSTRING(waitfor)
80
81 @node User-Defined Preferences
82 @section User-Defined Preferences
83
84 @DOCSTRING(addpref)
85
86 @DOCSTRING(getpref)
87
88 @DOCSTRING(ispref)
89
90 @DOCSTRING(rmpref)
91
92 @DOCSTRING(setpref)
93