Programmer Guide/Macro Library/BUTIL - Revision history

Jw: /* CopyFile, DeleteFile, RenameFile, OpenFile */

2018-08-07T07:14:09Z

CopyFile, DeleteFile, RenameFile, OpenFile

← Older revision		Revision as of 09:14, 7 August 2018
Line 35:		Line 35:
	\|<var>rc</var> \|\|The non-zero error code if the command has failed.		\|<var>rc</var> \|\|The non-zero error code if the command has failed.
	\|}		\|}
	;See also: [[Programmer_Guide/Macro_Library/StdLib#FileToolBox\|FileToolBox]]		;See also: [[Programmer_Guide/Macro_Library/Kernal/StdLib#FileToolBox\|FileToolBox]]

	==EditBox==		==EditBox==

Jw: /* CopyFile, DeleteFile, RenameFile, OpenFile */

2017-06-27T11:21:26Z

CopyFile, DeleteFile, RenameFile, OpenFile

← Older revision		Revision as of 13:21, 27 June 2017
Line 35:		Line 35:
	\|<var>rc</var> \|\|The non-zero error code if the command has failed.		\|<var>rc</var> \|\|The non-zero error code if the command has failed.
	\|}		\|}
	;See also: [[Programmer_Guide/Macro_Library/~~FILETOOLBOX~~\|FileToolBox]]		;See also: [[Programmer_Guide/Macro_Library/StdLib#FileToolBox\|FileToolBox]]

	==EditBox==		==EditBox==

Jw: /* SelectTable */

2017-06-07T07:07:23Z

SelectTable

← Older revision		Revision as of 09:07, 7 June 2017
Line 298:		Line 298:
	<code>ALL</code> → select all entries<BR>		<code>ALL</code> → select all entries<BR>
	<code>TOGGLE</code> → toggle (invert) selection<BR>		<code>TOGGLE</code> → toggle (invert) selection<BR>
	<code>NONE</code> → clear selection, ~~deseclect~~ all entries		<code>NONE</code> → clear selection, deselect all entries
	\|		\|
	\|-		\|-

Toni: /* MsgBox, MsgBoxEx */

2016-02-01T14:46:07Z

MsgBox, MsgBoxEx

← Older revision		Revision as of 16:46, 1 February 2016
Line 214:		Line 214:
	\|}		\|}

	==MsgBox~~, MsgBoxEx~~==		==MsgBox==

	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> ]		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> ]

Toni: /* MsgBox, MsgBoxEx */

2016-01-29T12:43:05Z

MsgBox, MsgBoxEx

← Older revision		Revision as of 14:43, 29 January 2016
Line 218:		Line 218:
	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> ]		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> ]
	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>' ]		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>' ]
			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>' ]
	:Display a message box dialog with a set of pre-defined (depending on <var>type</var>) or user-defined (<var>type</var> = <code>USERDEFINED</code>) buttons.		:Display a message box dialog with a set of pre-defined (depending on <var>type</var>) or user-defined (<var>type</var> = <code>USERDEFINED</code>) buttons.
	{\|class="einrahmen"		{\|class="einrahmen"

Toni: /* MsgBox, MsgBoxEx */

2016-01-29T12:02:39Z

MsgBox, MsgBoxEx

← Older revision		Revision as of 14:02, 29 January 2016
Line 271:		Line 271:
	\|<code>Msg</code> or <code>Message</code> \|\| <code>OK</code> (okay)		\|<code>Msg</code> or <code>Message</code> \|\| <code>OK</code> (okay)
	\|-		\|-
	\|<code>OkayCancel</code> \|\| <code>OK</code> (okay), <code>Cancel</code> (cancel)		\|<code>OkayCancel</code> \|\| <code>OK</code> (okay) or <code>Cancel</code> (cancel)
	\|-		\|-
	\|<code>OkayRetryCancel</code> \|\| <code>OK</code> (okay), <code>Retry</code> (retry) <code>Cancel</code> (cancel)		\|<code>OkayRetryCancel</code> \|\| <code>OK</code> (okay), <code>Retry</code> (retry) or <code>Cancel</code> (cancel)
	\|-		\|-
	\|<code>YesNo</code> \|\| <code>Yes</code> (yes), <code>No</code> (no)		\|<code>YesNo</code> \|\| <code>Yes</code> (yes) or <code>No</code> (no)
	\|-		\|-
	\|<code>YesNoCancel</code> \|\| <code>Yes</code> (yes), <code>No</code> (no) <code>Cancel</code> (cancel)		\|<code>YesNoCancel</code> \|\| <code>Yes</code> (yes), <code>No</code> (no) or <code>Cancel</code> (cancel)
	\|-		\|-
	\|<code>UserDefined</code> \|\| buttons are defined by the argument <var>buttonlist</var>		\|<code>UserDefined</code> \|\| buttons are defined by the argument <var>buttonlist</var>
	\|}		\|}
	;See also:		;See also: [[Programmer_Guide/Macro_Library/UM\|UM or EM]], [[Programmer_Guide/Macro_Library/CONLOG\|ConLog]]

	==SelectTable==		==SelectTable==

Toni: /* MsgBox, MsgBoxEx */

2016-01-29T11:55:54Z

MsgBox, MsgBoxEx

← Older revision		Revision as of 13:55, 29 January 2016
Line 218:		Line 218:
	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> ]		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> ]
	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>' ]		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>' ]
	:Display a message box dialog.		:Display a message box dialog with a set of pre-defined (depending on <var>type</var>) or user-defined (<var>type</var> = <code>USERDEFINED</code>) buttons.
	{\|class="einrahmen"		{\|class="einrahmen"
	!argument !!description !!default		!argument !!description !!default

Toni: /* MsgBox, MsgBoxEx */

2016-01-29T11:52:36Z

MsgBox, MsgBoxEx

← Older revision		Revision as of 13:52, 29 January 2016
Line 216:		Line 216:
	==MsgBox, MsgBoxEx==		==MsgBox, MsgBoxEx==

	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> ]		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> ]
	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>' ]		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>' ]
	:Display a message box dialog.		:Display a message box dialog.

Toni: /* MsgBox, MsgBoxEx */

2016-01-29T11:49:21Z

MsgBox, MsgBoxEx

← Older revision		Revision as of 13:49, 29 January 2016
Line 215:		Line 215:

	==MsgBox, MsgBoxEx==		==MsgBox, MsgBoxEx==

			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> ]
			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>' ]
			:Display a message box dialog.
			{\|class="einrahmen"
			!argument !!description !!default
			\|-
			\|<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, if <var>type</var> is set to <code>USERDEFINED</code>.
			\|
			\|-
			\|<var>text</var>
			\|The text to be displayed in the message box.
			\|
			\|-
			\|<var>title</var>
			\|Caption of the message box.
			\|name of the {{STX}} application
			\|-
			\|<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
			\|-
			\|<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, starting with index 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.<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>
			\|}
			;See also:

	==SelectTable==		==SelectTable==

Toni: /* MsgBox */

2016-01-29T11:48:05Z

MsgBox

← Older revision		Revision as of 13:48, 29 January 2016
Line 238:		Line 238:
	\|}		\|}
	;See also: [[Programmer_Guide/Shell_Items/Table\|TABLE items]]		;See also: [[Programmer_Guide/Shell_Items/Table\|TABLE items]]

	~~==MsgBox==~~
	====<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 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>====
	~~:Display a message box dialog.~~
	~~{\|class="einrahmen"~~
	~~!argument !!description !!default~~
	\|-
	~~\|<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, if <var>type</var> is set to <code>USERDEFINED</code>.
	\|
	\|-
	~~\|<var>text</var>~~
	~~\|The text to be displayed in the message box.~~
	\|
	\|-
	~~\|<var>title</var>~~
	~~\|Caption of the message box.~~
	~~\|name of the {{STX}} application~~
	\|-
	~~\|<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~~
	\|-
	~~\|<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, starting with index 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.<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>~~
	\|}
	~~;See also:~~