changeset 19842:03adada53347

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 07b970d6cdfe
children 0178c5a98d6f
files doc/interpreter/gui.txi doc/interpreter/octave.texi
diffstat 2 files changed, 51 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/gui.txi	Mon Feb 23 23:28:37 2015 -0500
+++ b/doc/interpreter/gui.txi	Mon Feb 23 21:31:53 2015 -0800
@@ -20,13 +20,15 @@
 @chapter GUI Development
 
 Octave is principally a batch or command-line language.  However, it does
-offer some limited features for constructing graphical interfaces for
-interacting with users.
+offer some features for constructing graphical interfaces that interact with
+users.
 
-The GUI elements available are I/O dialogs and a progress bar.  For example,
-rather than hardcoding a filename for output results a script can open a dialog
-box and allow the user to choose a file.  Similarly, if a calculation is
-expected to take a long time a script can display a progress bar.
+The GUI elements available are I/O dialogs, a progress bar, and UI elements
+for plot windows.  For example, rather than hardcoding a filename for output
+results a script can open a dialog box and allow the user to choose a file.
+Similarly, if a calculation is expected to take a long time a script can
+display a progress bar.  The various UI elements can be used to fully customize
+the plot window with menubars, context menus, 
 
 Several utility functions make it possible to store private data for use with
 a GUI which will not pollute the user's variable space.
@@ -38,6 +40,7 @@
 @menu
 * I/O Dialogs::
 * Progress Bar::
+* UI Elements::
 * GUI Utility Functions::
 * User-Defined Preferences::
 @end menu
@@ -61,12 +64,31 @@
 
 @DOCSTRING(waitbar)
 
+@node UI Elements
+@section UI Elements
+
+The ui* series of functions work best with the @code{qt} graphics toolkit,
+although some functionality is available with the @code{fltk} toolkit.  There
+is no support for the @code{gnuplot} toolkit.
+
+@DOCSTRING(uicontextmenu)
+
+@DOCSTRING(uicontrol)
+
+@DOCSTRING(uipanel)
+
+@DOCSTRING(uipushtool)
+
+@DOCSTRING(uitoggletool)
+
+@DOCSTRING(uitoolbar)
+
 @node GUI Utility Functions
 @section GUI Utility Functions
 
 These functions do not implement a GUI element but are useful when developing
-programs that do.  @strong{Warning:} The functions @code{uiwait},
-@code{uiresume}, and @code{waitfor} are only available for the FLTK toolkit.
+programs that do.  The functions @code{uiwait}, @code{uiresume}, and
+@code{waitfor} are only available with the @code{qt} or @code{fltk} toolkits.
 
 @DOCSTRING(desktop)
 
--- a/doc/interpreter/octave.texi	Mon Feb 23 23:28:37 2015 -0500
+++ b/doc/interpreter/octave.texi	Mon Feb 23 21:31:53 2015 -0800
@@ -505,6 +505,7 @@
 * Plot Annotations::
 * Multiple Plots on One Page::
 * Multiple Plot Windows::
+* Manipulation of Plot Objects::
 * Manipulation of Plot Windows::
 * Use of the @code{interpreter} Property::
 * Printing and Saving Plots::
@@ -722,6 +723,25 @@
 * Plotting on top of Images::
 * Color Conversion::
 
+Audio Processing
+
+* Audio File Utilities::
+* Audio Device Information::
+* Audio Player::
+* Audio Recorder::
+* Audio Data Processing::
+
+Audio Player
+
+* Playback::
+* Player Properties::
+
+Audio Recorder
+
+* Recording::
+* Data Retrieval::
+* Recorder Properties::
+
 Object Oriented Programming
 
 * Creating a Class::
@@ -745,6 +765,7 @@
 
 * I/O Dialogs::
 * Progress Bar::
+* UI Elements::
 * GUI Utility Functions::
 * User-Defined Preferences::
 
@@ -894,7 +915,6 @@
 
 * Keywords::
 * Parser::
-
 @end detailmenu
 @end menu