BUTIL
From STX Wiki
Jump to navigationJump to search
MsgBox and MsgBoxEx |
&vbar; | FileDialog |
-- | DirectoryDialog
|
MsgBox
BUTIL MSGBOX type [buttonlist] [ ; text ; title ; maxtime [timestep ; xpos ; ypos ; monitor ; defaultbutton ]
BUTIL MSGBOXEX 'type [buttonlist]' 'text' [ 'title' 'maxtime [timestep]' 'xpos' 'ypos' 'monitor' 'defaultbutton' ]
- Display a message box dialog.
argument | description | default |
---|---|---|
type [buttonlist] | Defines the type of the message box and the displayed buttons (see table below). The buttonlist is the blank seperated list of buttons, if type is set to USERDEFINED .
|
|
text | The text to be displayed in the message box. | |
title | Caption of the message box. | name of the STx application |
maxtime [timestep] | If this argument is a number, it is used as timeout value in seconds. If a timeout is set, a progress bar is displayed and the message box is closed automatically after timeout seconds. The timestep is the time for the progress bar update in seconds (if <1) or milli-seconds (if ≥1). The default timestep is set to 50ms. |
no timeout |
xpos | Horizontal position in pixels or keyword LEFT, RIGHT, CENTER .If xpos is a number it specifies, the offset to the left (≥0) or the right (<0) side of the desktop. |
depends on parent window |
ypos | Vertical position in pixels or keyword TOP, BOTTOM, CENTER .If ypos is a number it specifies, the offset to the top (≥0) or the bottom (<0) of the desktop. |
depends on parent window |
monitor | The index (1, 2, ..) of the monitor to display the message box on. | monitor the mouse is on |
defaultbutton | The index (1, 2, ..) of the default button, which will initially be receiving the focus. Buttons are numbered from left to right, starting with index 1. | 1 |
RESULT | description | |
CANCEL |
If the message box was closed using the close button or the [Escape] -key.
| |
TIMEOUT |
If a timeout was set and the maximum timout value was reached before a user input. | |
button | The name of the pressed button. Note that USERDEFINED buttons using the ampersand & to underline a letter (e.g. &Segment) return the keyword including the ampersand.
|
type | buttons (return values are specified in brackets) |
---|---|
NONE |
no buttons, message box must be closed with the [Escape] -key or by using a timeout
|
Msg or Message |
OK (okay)
|
OkayCancel |
OK (okay), Cancel (cancel)
|
OkayRetryCancel |
OK (okay), Retry (retry) Cancel (cancel)
|
YesNo |
Yes (yes), No (no)
|
YesNoCancel |
Yes (yes), No (no) Cancel (cancel)
|
UserDefined |
buttons are defined by the argument buttonlist |
FileDialog
BUTIL FILEDIALOG type [ ; title ; path ; ftype1 ; ... ]
- General file dialog.
FILEOPENDIALOG [ 'title' 'path' 'ftype1' ... ]
- Dialog to open an existing file
FILENEWDIALOG [ 'title' 'path' 'ftype1' ... ]
- Dialog to create a new file.
argument | description | default |
---|---|---|
type | Selects the action to perform:
|
OPEN
|
title | The caption of the dialog window. | Select File
|
file | The default file or directory. | current directory |
ftype1 ... | Each ftype argument defines one entry of the filetype-combobox of the dialog. Each filetype is defined by the string
| |
RESULT | description | |
path |
The full pathname of the file to be opened or created. | |
empty string | If the dialog was canceled. |
DirectoryDialog
BUTIL DIRECTORYDIALOG [ title ; path ; restore ; sdmode ; sdvalue ]
DIRECTORYDIALOG [ 'title' [ 'path' 'restore' 'sdmode' 'sdvalue' ]
- Dialog to select a directory.
argument | description | default |
---|---|---|
type | Selects the action to perform:
|
OPEN
|
title | The caption of the dialog window. | Select File
|
file | The default file or directory. | current directory |
RESULT | description | |
path |
The full pathname of the file to be opened or created. | |
empty string | If the dialog was canceled. |