Programmer Guide/Macro Library/BUTIL: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
==<code>BUTIL MSGBOXEX args: '<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 args: '<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" | ||
!arg !description !default | !arg !!description !!default | ||
|- | |- | ||
|<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>. | ||
|- | |- | ||
|<var>text<var> | |<var>text</var> | ||
| | |The text to be displayed in the message box. | ||
|- | |- | ||
|<var>title</var> | |<var>title</var> | ||
| | |Caption of the message box. | ||
|name of the {{STX}} application | |name of the {{STX}} application | ||
|- | |- | ||
|<var>maxtime</var> [<var>timestep</var>] | |<var>maxtime</var> [<var>timestep</var>] | ||
| | |If this argument is a number, it is used as timeout value in seconds.<BR>If a timeout is set, a progress bar is displayed and the message box is closed automatically after <var>timeout</var> seconds. The <var>timestep</var> is the time for the progress bar update in seconds (if <1) or milli-seconds (if ≥1). The default <var>timestep</var> is set to 50ms. | ||
|no timeout | |no timeout | ||
|- | |||
|<var>xpos</var> | |||
|Horizontal position in pixels or keyword <code>LEFT, RIGHT, CENTER</code>.<BR>If <var>xpos</var> is a number it specifies, the offset to the left (≥0) or the right (<0) side of the desktop. | |||
|depends on parent window | |||
|- | |||
|<var>ypos</var> | |||
|Vertical position in pixels or keyword <code>TOP, BOTTOM, CENTER</code>.<BR>If <var>ypos</var> is a number it specifies, the offset to the top (≥0) or the bottom (<0) of the desktop. | |||
|depends on parent window | |||
|- | |||
|<var>monitor</var> | |||
|The index (1, 2, ..) of the monitor to display the message box on. | |||
|monitor the mouse is on | |||
|- | |||
|<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 and starts with index 1. | |||
|1 | |||
|} | |} | ||
Revision as of 10:03, 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 and starts with index 1. | 1 |
