Programmer Guide/Macro Library/BUTIL: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 8: | Line 8: | ||
|<var>type</var> [<var>buttonlist</var>] | |<var>type</var> [<var>buttonlist</var>] | ||
|Defines the type of the message box and the displayed buttons (see table below).<BR>The <var>buttonlist</var> is the blank seperated list of buttons for <var>type</var> <code>USERDEFINED</code>. | |Defines the type of the message box and the displayed buttons (see table below).<BR>The <var>buttonlist</var> is the blank seperated list of buttons for <var>type</var> <code>USERDEFINED</code>. | ||
| | |||
|- | |- | ||
|<var>text</var> | |<var>text</var> | ||
|The text to be displayed in the message box. | |The text to be displayed in the message box. | ||
| | |||
|- | |- | ||
|<var>title</var> | |<var>title</var> | ||
| Line 33: | Line 35: | ||
|- | |- | ||
|<var>defaultbutton</var> | |<var>defaultbutton</var> | ||
|The index (1, 2, ..) of the default button, which will initially be receiving the focus. Buttons are numbered from left to right | |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 | |1 | ||
|- | |||
!RESULT !!description | |||
|- | |||
|<code>CANCEL</code> ||If the message box was closed using the close button or the <code>ESCAPE</code>-key. | |||
|- | |||
|<code>TIMEOUT</code> ||If a timeout was set and the maximum timout value was reached before a user input. | |||
|- | |||
|<var>button</var> ||The name of the pressed button. | |||
|} | |} | ||
Revision as of 10:10, 11 May 2011
BUTIL MSGBOX read: type [buttons] [ ; text ; title ; maxtime [timestep ; xpos ; ypos ; monitor ; defaultbutton ]
BUTIL MSGBOXEX args: 'type [buttonlist]' 'text' [ 'title' 'maxtime [timestep]' 'xpos' 'ypos' 'monitor' 'defaultbutton' ]
| arg | 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 for type 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. |
