octave_packages/zenity-0.5.7/doc-cache

   1 # Created by Octave 3.6.1, Mon Apr 16 18:53:51 2012 UTC <root@brouzouf>
   2 # name: cache
   3 # type: cell
   4 # rows: 3
   5 # columns: 9
   6 # name: <cell-element>
   7 # type: sq_string
   8 # elements: 1
   9 # length: 15
  10 zenity_calendar
  11
  12
  13 # name: <cell-element>
  14 # type: sq_string
  15 # elements: 1
  16 # length: 395
  17  -- Function File: D = zenity_calendar(TITLE, DAY, MONTH, YEAR)
  18      Displays a date selection window.  The variable TITLE sets the
  19      title of the calendar.  The optional arguments DAY, MONTH, and
  20      YEAR changes the standard selected date.
  21
  22      See also: zenity_list, zenity_progress, zenity_entry,
  23      zenity_message, zenity_text_info, zenity_file_selection,
  24      zenity_notification
  25
  26
  27
  28
  29
  30 # name: <cell-element>
  31 # type: sq_string
  32 # elements: 1
  33 # length: 33
  34 Displays a date selection window.
  35
  36
  37
  38 # name: <cell-element>
  39 # type: sq_string
  40 # elements: 1
  41 # length: 12
  42 zenity_entry
  43
  44
  45 # name: <cell-element>
  46 # type: sq_string
  47 # elements: 1
  48 # length: 533
  49  -- Function File: S = zenity_entry(TEXT, ENTRY_TEXT, PASSWORD)
  50      Displays a text entry dialog.  The variable TEXT sets the title of
  51      the dialog, and the ENTRY_TEXT variable sets the default value of
  52      the text entry field. If the PASSWORD variable is non-empty the
  53      value of the text entry field will not be displayed on the screen.
  54      All arguments are optional.
  55
  56      See also: zenity_calendar, zenity_list, zenity_progress,
  57      zenity_message, zenity_text_info, zenity_file_selection,
  58      zenity_notification
  59
  60
  61
  62
  63
  64 # name: <cell-element>
  65 # type: sq_string
  66 # elements: 1
  67 # length: 29
  68 Displays a text entry dialog.
  69
  70
  71
  72 # name: <cell-element>
  73 # type: sq_string
  74 # elements: 1
  75 # length: 21
  76 zenity_file_selection
  77
  78
  79 # name: <cell-element>
  80 # type: sq_string
  81 # elements: 1
  82 # length: 668
  83  -- Function File: zenity_file_selection (TITLE, OPTION1, ...)
  84      Opens a file selection dialog.  The variable TITLE sets the title
  85      of the file selection window.  The optional string arguments can be
  86     `save'
  87           The file selection dialog is a dialog for saving files.
  88
  89     `multiple'
  90           It is possible to select multiple files.
  91
  92     `directory'
  93           It is possible to select directories as well as files.
  94
  95     `Anything else'
  96           The argument will be the default selected file.
  97      and `error'.
  98
  99      See also: zenity_calendar, zenity_list, zenity_progress,
 100      zenity_entry, zenity_message, zenity_text_info, zenity_notification
 101
 102
 103
 104
 105
 106 # name: <cell-element>
 107 # type: sq_string
 108 # elements: 1
 109 # length: 30
 110 Opens a file selection dialog.
 111
 112
 113
 114 # name: <cell-element>
 115 # type: sq_string
 116 # elements: 1
 117 # length: 11
 118 zenity_list
 119
 120
 121 # name: <cell-element>
 122 # type: sq_string
 123 # elements: 1
 124 # length: 1613
 125  -- Function File: S = zenity_list(TITLE, COLUMNS, DATA, OPTIONS1, ...)
 126      Displays a graphical list of data.  The variable TITLE sets the
 127      title of the list. The variable COLUMNS must be a cell array of
 128      strings of length N containing the headers of the list. The
 129      variable DATA must be cell array of strings of length NxM
 130      containing the data of the list.
 131
 132      The code
 133           zenity_list("Age versus Height", {"Age", "Height"},
 134           {"10", "20"; "120cm", "180cm"})
 135      produces a list of the data. The user can select a row in the
 136      table, and it's first value will be returned by the function when
 137      the user closes the window.
 138
 139      It's possible to alter the behaviour of the list window by passing
 140      more than three arguments to the funtion. Theese optional string
 141      arguments can be
 142     `checklist'
 143           The first row in the list will be a check box. The first
 144           value of each data row must be either "TRUE" or "FALSE".
 145
 146     `radiolist'
 147           The first row in the list will be a radio list. The first
 148           value of each data row must be either "TRUE" or "FALSE".
 149
 150     `editable'
 151           The values of the list will be editable by the user.
 152
 153     `A numeric value'
 154           The value returned by the function will be the value of this
 155           column of the user selected row.
 156
 157     `all'
 158           The value returned by the function will be the entire row
 159           selected by the user.
 160
 161      See also: zenity_calendar, zenity_progress, zenity_entry,
 162      zenity_message, zenity_text_info, zenity_file_selection,
 163      zenity_notification
 164
 165
 166
 167
 168
 169 # name: <cell-element>
 170 # type: sq_string
 171 # elements: 1
 172 # length: 34
 173 Displays a graphical list of data.
 174
 175
 176
 177 # name: <cell-element>
 178 # type: sq_string
 179 # elements: 1
 180 # length: 14
 181 zenity_message
 182
 183
 184 # name: <cell-element>
 185 # type: sq_string
 186 # elements: 1
 187 # length: 637
 188  -- Function File: zenity_message (TEXT, TYPE)
 189      Displays a graphical message dialog.  The variable TEXT sets the
 190      message of the dialog, and the optional variable TYPE sets the
 191      type of the message.  TYPE must be one of the following strings
 192      `error', `info', `question', and `warning'. The default value of
 193      TYPE is `info'. Retuns the value `status' which is 0 for 'Ok' and
 194      1 for 'Cancel' button selection; a value of -1 indicates a failure
 195      of dialog box.
 196
 197      See also: zenity_calendar, zenity_list, zenity_progress,
 198      zenity_entry, zenity_text_info, zenity_file_selection,
 199      zenity_notification
 200
 201
 202
 203
 204
 205 # name: <cell-element>
 206 # type: sq_string
 207 # elements: 1
 208 # length: 36
 209 Displays a graphical message dialog.
 210
 211
 212
 213 # name: <cell-element>
 214 # type: sq_string
 215 # elements: 1
 216 # length: 19
 217 zenity_notification
 218
 219
 220 # name: <cell-element>
 221 # type: sq_string
 222 # elements: 1
 223 # length: 457
 224  -- Function File: zenity_notification (TEXT, ICON)
 225      Displays an icon with a text in the notification area.  The
 226      variable TEXT sets the text in the notification area, and the
 227      optional variable ICON determines which icon to show.  ICON can be
 228      either `info', `warning', `question', and `error'.
 229
 230      See also: zenity_calendar, zenity_list, zenity_progress,
 231      zenity_entry, zenity_message, zenity_text_info,
 232      zenity_file_selection
 233
 234
 235
 236
 237
 238 # name: <cell-element>
 239 # type: sq_string
 240 # elements: 1
 241 # length: 54
 242 Displays an icon with a text in the notification area.
 243
 244
 245
 246 # name: <cell-element>
 247 # type: sq_string
 248 # elements: 1
 249 # length: 15
 250 zenity_progress
 251
 252
 253 # name: <cell-element>
 254 # type: sq_string
 255 # elements: 1
 256 # length: 1142
 257  -- Function File: H = zenity_progress(TITLE, OPTION1, OPTION2)
 258  -- Function File: zenity_progress (H, PROGRESS)
 259  -- Function File: zenity_progress (H, PROGRESS, TEXT)
 260      Displays a graphical progress bar.  If the first argument is
 261      either non-present or a string, a new progress bar is created and
 262      a handle is returned. If the first argument is a string it will be
 263      used as the title of the progress bar. The two optional arguments
 264      OPTION1 and OPTION2 can be
 265     `auto-close'
 266           The progress bar will be closed when it reaches 100.
 267
 268     `pulsate'
 269           The progress bar will pulsate.
 270
 271      If the first argument is a handle to a progress bar and the second
 272      argument is an integer, the progress bar will set its current value
 273      to the given integer. If the second argument is a string, the text
 274      of the progress bar will be set to the given string.  It is
 275      possible to pass both an integer and a string to the function in
 276      one function call.
 277
 278      See also: zenity_calendar, zenity_list, zenity_entry,
 279      zenity_message, zenity_text_info, zenity_file_selection,
 280      zenity_notification
 281
 282
 283
 284
 285
 286 # name: <cell-element>
 287 # type: sq_string
 288 # elements: 1
 289 # length: 34
 290 Displays a graphical progress bar.
 291
 292
 293
 294 # name: <cell-element>
 295 # type: sq_string
 296 # elements: 1
 297 # length: 12
 298 zenity_scale
 299
 300
 301 # name: <cell-element>
 302 # type: sq_string
 303 # elements: 1
 304 # length: 1064
 305  -- Function File: OUTPUT = zenity_scale(TITLE,TEXT, VALUE, MINVAL,
 306           MAXVAL,STEP,PRINT_PARTIAL,HIDEVAL)
 307      Displays a selection scale (range widget) window.  Allows the user
 308      to choose a parameter within the set ranges, and sets default
 309      value, and step sizes.  The variable TITLE sets the title of the
 310      window.  The variable TEXT sets the label of the range widget.
 311      The other arguments VALUE, MINVAL,MAXVAL, STEP, PRINT_PARTIAL, and
 312      HIDEVAL.  The range widget can be used to select anywhere from
 313      MINVAL to MAXVAL values in increments of STEP. The variable
 314      PRINT_PARTIAL and HIDEVAL are boolean flags to partial and hidden
 315      views of the value on the range widget.  The first 3 parameters
 316      are essential, while the remaining parameters MINVAL,
 317      MAXVAL,STEP,PRINT_PARTIAL,HIDEVAL if not specified take on default
 318      values of 0,100,1,false,false respectively.
 319
 320      See also: zenity_list, zenity_progress, zenity_entry,
 321      zenity_message, zenity_text_info, zenity_file_selection,
 322      zenity_notification
 323
 324
 325
 326
 327
 328 # name: <cell-element>
 329 # type: sq_string
 330 # elements: 1
 331 # length: 49
 332 Displays a selection scale (range widget) window.
 333
 334
 335
 336 # name: <cell-element>
 337 # type: sq_string
 338 # elements: 1
 339 # length: 16
 340 zenity_text_info
 341
 342
 343 # name: <cell-element>
 344 # type: sq_string
 345 # elements: 1
 346 # length: 560
 347  -- Function File: S = zenity_text_info(TITLE, TEXT, EDITABLE)
 348      Display a large amount of text in a graphical display.  The title
 349      of the display window is set with the variable TITLE, and the
 350      actual text ti display is set with the variable TEXT.  If the
 351      optional argument EDITABLE is given the displayed text is
 352      editable. In this case the altered text is returned from the
 353      function.
 354
 355      See also: zenity_calendar, zenity_list, zenity_progress,
 356      zenity_entry, zenity_message, zenity_file_selection,
 357      zenity_notification
 358
 359
 360
 361
 362
 363 # name: <cell-element>
 364 # type: sq_string
 365 # elements: 1
 366 # length: 54
 367 Display a large amount of text in a graphical display.
 368
 369
 370
 371
 372