]> Creatis software - CreaPhase.git/blobdiff - octave_packages/zenity-0.5.7/doc-cache
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / zenity-0.5.7 / doc-cache
diff --git a/octave_packages/zenity-0.5.7/doc-cache b/octave_packages/zenity-0.5.7/doc-cache
new file mode 100644 (file)
index 0000000..3ee565e
--- /dev/null
@@ -0,0 +1,372 @@
+# Created by Octave 3.6.1, Mon Apr 16 18:53:51 2012 UTC <root@brouzouf>
+# name: cache
+# type: cell
+# rows: 3
+# columns: 9
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 15
+zenity_calendar
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 395
+ -- Function File: D = zenity_calendar(TITLE, DAY, MONTH, YEAR)
+     Displays a date selection window.  The variable TITLE sets the
+     title of the calendar.  The optional arguments DAY, MONTH, and
+     YEAR changes the standard selected date.
+
+     See also: zenity_list, zenity_progress, zenity_entry,
+     zenity_message, zenity_text_info, zenity_file_selection,
+     zenity_notification
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 33
+Displays a date selection window.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 12
+zenity_entry
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 533
+ -- Function File: S = zenity_entry(TEXT, ENTRY_TEXT, PASSWORD)
+     Displays a text entry dialog.  The variable TEXT sets the title of
+     the dialog, and the ENTRY_TEXT variable sets the default value of
+     the text entry field. If the PASSWORD variable is non-empty the
+     value of the text entry field will not be displayed on the screen.
+     All arguments are optional.
+
+     See also: zenity_calendar, zenity_list, zenity_progress,
+     zenity_message, zenity_text_info, zenity_file_selection,
+     zenity_notification
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 29
+Displays a text entry dialog.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 21
+zenity_file_selection
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 668
+ -- Function File: zenity_file_selection (TITLE, OPTION1, ...)
+     Opens a file selection dialog.  The variable TITLE sets the title
+     of the file selection window.  The optional string arguments can be
+    `save'
+          The file selection dialog is a dialog for saving files.
+
+    `multiple'
+          It is possible to select multiple files.
+
+    `directory'
+          It is possible to select directories as well as files.
+
+    `Anything else'
+          The argument will be the default selected file.
+     and `error'.
+
+     See also: zenity_calendar, zenity_list, zenity_progress,
+     zenity_entry, zenity_message, zenity_text_info, zenity_notification
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 30
+Opens a file selection dialog.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 11
+zenity_list
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 1613
+ -- Function File: S = zenity_list(TITLE, COLUMNS, DATA, OPTIONS1, ...)
+     Displays a graphical list of data.  The variable TITLE sets the
+     title of the list. The variable COLUMNS must be a cell array of
+     strings of length N containing the headers of the list. The
+     variable DATA must be cell array of strings of length NxM
+     containing the data of the list.
+
+     The code
+          zenity_list("Age versus Height", {"Age", "Height"},
+          {"10", "20"; "120cm", "180cm"})
+     produces a list of the data. The user can select a row in the
+     table, and it's first value will be returned by the function when
+     the user closes the window.
+
+     It's possible to alter the behaviour of the list window by passing
+     more than three arguments to the funtion. Theese optional string
+     arguments can be
+    `checklist'
+          The first row in the list will be a check box. The first
+          value of each data row must be either "TRUE" or "FALSE".
+
+    `radiolist'
+          The first row in the list will be a radio list. The first
+          value of each data row must be either "TRUE" or "FALSE".
+
+    `editable'
+          The values of the list will be editable by the user.
+
+    `A numeric value'
+          The value returned by the function will be the value of this
+          column of the user selected row.
+
+    `all'
+          The value returned by the function will be the entire row
+          selected by the user.
+
+     See also: zenity_calendar, zenity_progress, zenity_entry,
+     zenity_message, zenity_text_info, zenity_file_selection,
+     zenity_notification
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 34
+Displays a graphical list of data.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 14
+zenity_message
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 637
+ -- Function File: zenity_message (TEXT, TYPE)
+     Displays a graphical message dialog.  The variable TEXT sets the
+     message of the dialog, and the optional variable TYPE sets the
+     type of the message.  TYPE must be one of the following strings
+     `error', `info', `question', and `warning'. The default value of
+     TYPE is `info'. Retuns the value `status' which is 0 for 'Ok' and
+     1 for 'Cancel' button selection; a value of -1 indicates a failure
+     of dialog box.
+
+     See also: zenity_calendar, zenity_list, zenity_progress,
+     zenity_entry, zenity_text_info, zenity_file_selection,
+     zenity_notification
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 36
+Displays a graphical message dialog.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 19
+zenity_notification
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 457
+ -- Function File: zenity_notification (TEXT, ICON)
+     Displays an icon with a text in the notification area.  The
+     variable TEXT sets the text in the notification area, and the
+     optional variable ICON determines which icon to show.  ICON can be
+     either `info', `warning', `question', and `error'.
+
+     See also: zenity_calendar, zenity_list, zenity_progress,
+     zenity_entry, zenity_message, zenity_text_info,
+     zenity_file_selection
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 54
+Displays an icon with a text in the notification area.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 15
+zenity_progress
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 1142
+ -- Function File: H = zenity_progress(TITLE, OPTION1, OPTION2)
+ -- Function File: zenity_progress (H, PROGRESS)
+ -- Function File: zenity_progress (H, PROGRESS, TEXT)
+     Displays a graphical progress bar.  If the first argument is
+     either non-present or a string, a new progress bar is created and
+     a handle is returned. If the first argument is a string it will be
+     used as the title of the progress bar. The two optional arguments
+     OPTION1 and OPTION2 can be
+    `auto-close'
+          The progress bar will be closed when it reaches 100.
+
+    `pulsate'
+          The progress bar will pulsate.
+
+     If the first argument is a handle to a progress bar and the second
+     argument is an integer, the progress bar will set its current value
+     to the given integer. If the second argument is a string, the text
+     of the progress bar will be set to the given string.  It is
+     possible to pass both an integer and a string to the function in
+     one function call.
+
+     See also: zenity_calendar, zenity_list, zenity_entry,
+     zenity_message, zenity_text_info, zenity_file_selection,
+     zenity_notification
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 34
+Displays a graphical progress bar.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 12
+zenity_scale
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 1064
+ -- Function File: OUTPUT = zenity_scale(TITLE,TEXT, VALUE, MINVAL,
+          MAXVAL,STEP,PRINT_PARTIAL,HIDEVAL)
+     Displays a selection scale (range widget) window.  Allows the user
+     to choose a parameter within the set ranges, and sets default
+     value, and step sizes.  The variable TITLE sets the title of the
+     window.  The variable TEXT sets the label of the range widget.
+     The other arguments VALUE, MINVAL,MAXVAL, STEP, PRINT_PARTIAL, and
+     HIDEVAL.  The range widget can be used to select anywhere from
+     MINVAL to MAXVAL values in increments of STEP. The variable
+     PRINT_PARTIAL and HIDEVAL are boolean flags to partial and hidden
+     views of the value on the range widget.  The first 3 parameters
+     are essential, while the remaining parameters MINVAL,
+     MAXVAL,STEP,PRINT_PARTIAL,HIDEVAL if not specified take on default
+     values of 0,100,1,false,false respectively.
+
+     See also: zenity_list, zenity_progress, zenity_entry,
+     zenity_message, zenity_text_info, zenity_file_selection,
+     zenity_notification
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 49
+Displays a selection scale (range widget) window.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 16
+zenity_text_info
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 560
+ -- Function File: S = zenity_text_info(TITLE, TEXT, EDITABLE)
+     Display a large amount of text in a graphical display.  The title
+     of the display window is set with the variable TITLE, and the
+     actual text ti display is set with the variable TEXT.  If the
+     optional argument EDITABLE is given the displayed text is
+     editable. In this case the altered text is returned from the
+     function.
+
+     See also: zenity_calendar, zenity_list, zenity_progress,
+     zenity_entry, zenity_message, zenity_file_selection,
+     zenity_notification
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 54
+Display a large amount of text in a graphical display.
+
+
+
+
+