Programmer Guide/Macro Library/BUTIL: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
==<code>BUTIL MSGBOX <var>type</var> [<var>buttonlist</var>] [ ; <var>text</var> ; <var>title</var> ; <var>maxtime</var> [<var>timestep</var> ; <var>xpos</var> ; <var>ypos</var> ; <var>monitor</var> ; <var>defaultbutton</var> ]</code>== | |||
==<code>BUTIL MSGBOX <var>type</var> [<var> | |||
==<code>BUTIL MSGBOXEX '<var>type</var> [<var>buttonlist</var>]' '<var>text</var>' [ '<var>title</var>' '<var>maxtime</var> [<var>timestep</var>]' '<var>xpos</var>' '<var>ypos</var>' '<var>monitor</var>' '<var>defaultbutton</var>' ]</code>== | ==<code>BUTIL MSGBOXEX '<var>type</var> [<var>buttonlist</var>]' '<var>text</var>' [ '<var>title</var>' '<var>maxtime</var> [<var>timestep</var>]' '<var>xpos</var>' '<var>ypos</var>' '<var>monitor</var>' '<var>defaultbutton</var>' ]</code>== | ||
{|class="einrahmen" | {|class="einrahmen" | ||
| Line 40: | Line 39: | ||
!RESULT !!description | !RESULT !!description | ||
|- | |- | ||
|<code>CANCEL</code> ||If the message box was closed using the close button or the <code> | |<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. | |<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.<BR>Note that USERDEFINED buttons using the ampersand | |<var>button</var> ||The name of the pressed button.<BR>Note that <code>USERDEFINED</code> buttons using the ampersand & to underline a letter (e.g. &Segment) return the keyword including the ampersand. | ||
|} | |||
{|class="einrahmen" | |||
!<var>type</var> !!buttons (return values are specified in brackets) | |||
|<code>NONE</code> || no buttons, message box must be closed with the <code>[Escape]</code>-key or by using a timeout | |||
|- | |||
|<code>Msg</code> or <code>Message</code> || <code>OK</code> (okay) | |||
|- | |||
|<code>OkayCancel</code> || <code>OK</code> (okay), <code>Cancel</code> (cancel) | |||
|- | |||
|<code>OkayRetryCancel</code> || <code>OK</code> (okay), <code>Retry</code> (retry) <code>Cancel</code> (cancel) | |||
|- | |||
|<code>YesNo</code> || <code>Yes</code> (yes), <code>No</code> (no) | |||
|- | |||
|<code>YesNoCancel</code> || <code>Yes</code> (yes), <code>No</code> (no) <code>Cancel</code> (cancel) | |||
|- | |||
|<code>UserDefined</code> || buttons are defined by the argument <var>buttonlist</var> | |||
|} | |} | ||
Revision as of 10:27, 11 May 2011
BUTIL MSGBOX type [buttonlist] [ ; text ; title ; maxtime [timestep ; xpos ; ypos ; monitor ; defaultbutton ]
BUTIL MSGBOXEX '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. 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 |
