Mercurial > octave-nkf

comparison doc/interpreter/gui.txi @ 19876:03adada53347

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Add ui* family of functions to Octave manual. * gui.txi: Add text and docstring entries for uicontextmenu, uicontrol, uipanel, uipushtool, uitoggletool, uitoolbar. * octave.texi: Regenerate @detailmenu.
author Rik <rik@octave.org>
date Mon, 23 Feb 2015 21:31:53 -0800
parents 4197fc428c7d
children bf511802add7
comparison
equal deleted inserted replaced
19875:07b970d6cdfe 19876:03adada53347
18 18
19 @node GUI Development 19 @node GUI Development
20 @chapter GUI Development 20 @chapter GUI Development
21 21
22 Octave is principally a batch or command-line language. However, it does 22 Octave is principally a batch or command-line language. However, it does
23 offer some limited features for constructing graphical interfaces for 23 offer some features for constructing graphical interfaces that interact with
24 interacting with users. 24 users.
25 25
26 The GUI elements available are I/O dialogs and a progress bar. For example, 26 The GUI elements available are I/O dialogs, a progress bar, and UI elements
27 rather than hardcoding a filename for output results a script can open a dialog 27 for plot windows. For example, rather than hardcoding a filename for output
28 box and allow the user to choose a file. Similarly, if a calculation is 28 results a script can open a dialog box and allow the user to choose a file.
29 expected to take a long time a script can display a progress bar. 29 Similarly, if a calculation is expected to take a long time a script can
30 display a progress bar. The various UI elements can be used to fully customize
31 the plot window with menubars, context menus,
30 32
31 Several utility functions make it possible to store private data for use with 33 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. 34 a GUI which will not pollute the user's variable space.
33 35
34 Finally, a program written in Octave might want to have long term storage of 36 Finally, a program written in Octave might want to have long term storage of
36 preferences. 38 preferences.
37 39
38 @menu 40 @menu
39 * I/O Dialogs:: 41 * I/O Dialogs::
40 * Progress Bar:: 42 * Progress Bar::
43 * UI Elements::
41 * GUI Utility Functions:: 44 * GUI Utility Functions::
42 * User-Defined Preferences:: 45 * User-Defined Preferences::
43 @end menu 46 @end menu
44 47
45 @node I/O Dialogs 48 @node I/O Dialogs
59 @section Progress Bar 62 @section Progress Bar
60 @cindex Progress Bar 63 @cindex Progress Bar
61 64
62 @DOCSTRING(waitbar) 65 @DOCSTRING(waitbar)
63 66
67 @node UI Elements
68 @section UI Elements
69
70 The ui* series of functions work best with the @code{qt} graphics toolkit,
71 although some functionality is available with the @code{fltk} toolkit. There
72 is no support for the @code{gnuplot} toolkit.
73
74 @DOCSTRING(uicontextmenu)
75
76 @DOCSTRING(uicontrol)
77
78 @DOCSTRING(uipanel)
79
80 @DOCSTRING(uipushtool)
81
82 @DOCSTRING(uitoggletool)
83
84 @DOCSTRING(uitoolbar)
85
64 @node GUI Utility Functions 86 @node GUI Utility Functions
65 @section GUI Utility Functions 87 @section GUI Utility Functions
66 88
67 These functions do not implement a GUI element but are useful when developing 89 These functions do not implement a GUI element but are useful when developing
68 programs that do. @strong{Warning:} The functions @code{uiwait}, 90 programs that do. The functions @code{uiwait}, @code{uiresume}, and
69 @code{uiresume}, and @code{waitfor} are only available for the FLTK toolkit. 91 @code{waitfor} are only available with the @code{qt} or @code{fltk} toolkits.
70 92
71 @DOCSTRING(desktop) 93 @DOCSTRING(desktop)
72 94
73 @DOCSTRING(guidata) 95 @DOCSTRING(guidata)
74 96