Programmer Guide/Macro Library/PROGRESSBOX - Revision history

Jw: /* Result: */

2017-03-22T10:48:24Z

Result:

← Older revision		Revision as of 12:48, 22 March 2017
Line 151:		Line 151:
	=====Result:=====		=====Result:=====

	~~none~~		An empty string or a message from the progress dialog

	Array		Array

Jw at 10:32, 21 March 2017

2017-03-21T10:32:32Z

← Older revision		Revision as of 12:32, 21 March 2017
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	{{TOC limit\|2}}		{{TOC limit\|3}}
	==PROGRESSBOX==		==PROGRESSBOX==

	This is a simple implementation of a progress bar dialog which can be used to display information about a running process. Most progress dialogs in {{STX}} use this function.		This is a simple implementation of a progress bar dialog which can be used to display information about a running process. Most progress dialogs in {{STX}} use this function.

	==BEGIN==		===BEGIN===

	Initialize the progress box and create the progress box window.		Initialize the progress box and create the progress box window.
Line 43:		Line 43:
	The progress box handle; This result value must be used as the handle for all other calls to [[Programmer Guide/Macro Library/PROGRESSBOX\|PROGRESSBOX]]!		The progress box handle; This result value must be used as the handle for all other calls to [[Programmer Guide/Macro Library/PROGRESSBOX\|PROGRESSBOX]]!

			===END===
	==END==

	Deletes the progress box.		Deletes the progress box.
Line 62:		Line 61:
	none		none

			===SET===
	==SET==

	Updates the progress bar position and text and checks if user input is available (e.g. Escape-key, close progress dialog, ...). If user input is available, the message is returned.		Updates the progress bar position and text and checks if user input is available (e.g. Escape-key, close progress dialog, ...). If user input is available, the message is returned.
Line 89:		Line 87:
	An empty string or a message from the progress dialog		An empty string or a message from the progress dialog

			===SETVALUE===
	==SETVALUE==

	Updates progress bar position.		Updates progress bar position.
Line 111:		Line 108:

	none		none


	==TITLE==		===TITLE===

	Updates the progress box caption.		Updates the progress box caption.
Line 135:		Line 131:
	none		none

			===TEXT===


	==TEXT==

	Updates the progress box static text control.		Updates the progress box static text control.

Jw at 10:31, 21 March 2017

2017-03-21T10:31:25Z

← Older revision		Revision as of 12:31, 21 March 2017
Line 1:		Line 1:

	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{TOC limit\|2}}
	==PROGRESSBOX==		==PROGRESSBOX==

	This is a simple implementation of a progress bar dialog which can be used to display information about a running process. Most progress dialogs in {{STX}} use this function.		This is a simple implementation of a progress bar dialog which can be used to display information about a running process. Most progress dialogs in {{STX}} use this function.


	==BEGIN==		==BEGIN==

Christian: Text replace - "S_TOOLS-STx" to "{{STX}}"

2011-04-05T15:57:29Z

Text replace - "S_TOOLS-STx" to "{{STX}}"

← Older revision		Revision as of 17:57, 5 April 2011
Line 4:		Line 4:
	==PROGRESSBOX==		==PROGRESSBOX==

	This is a simple implementation of a progress bar dialog which can be used to display information about a running process. Most progress dialogs in ~~S_TOOLS-STx~~ use this function.		This is a simple implementation of a progress bar dialog which can be used to display information about a running process. Most progress dialogs in {{STX}} use this function.

Admin: 1 revision: Initial import

2010-11-18T16:31:27Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)

Unknown user: initial import

1970-01-01T00:00:00Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}

==PROGRESSBOX==

This is a simple implementation of a progress bar dialog which can be used to display information about a running process. Most progress dialogs in S_TOOLS-STx use this function.

==BEGIN==

Initialize the progress box and create the progress box window.

=====Usage:=====

<code>PROGRESSBOX BEGIN <var>parent</var>|* <var>style</var> <var>textwidth</var> <var>barrange</var> ; <var>title</var> ; <var>text</var></code>

=====Parameters:=====

;<var>parent</var>

:The name of the parent display or dialog item or an asterisk.

;<var>style</var>

:This is not used and should be set to <code>0.</code>

;<var>textwidth</var>

:The number of text characters used for the text control (static).

;<var>barrange</var>

:The progress bar range. <var>barrange</var> must be <= 0 if no progress bar should be displayed.

;<var>title</var>

:The dialog window caption.

;<var>text</var>

:The text to be displayed in the dialog.

=====Result:=====

The progress box handle; This result value must be used as the handle for all other calls to [[Programmer Guide/Macro Library/PROGRESSBOX|PROGRESSBOX]]!

==END==

Deletes the progress box.

=====Usage:=====

<code>PROGRESSBOX END <var>handle</var></code>

=====Parameters:=====

;<var>handle</var>

:The handle returned by the call to <code>PROGRESSBOX BEGIN</code>.

=====Result:=====

none

==SET==

Updates the progress bar position and text and checks if user input is available (e.g. Escape-key, close progress dialog, ...). If user input is available, the message is returned.

=====Usage:=====

<code>PROGRESSBOX SET <var>handle</var> <var>position</var> <var>text</var></code>

=====Parameters:=====

;<var>handle</var>

:The handle returned by the call to <code>PROGRESSBOX BEGIN</code>.

;<var>position</var>

:The progress bar position (0 .. progress bar range, as set in <code>PROGRESSBOX BEGIN</code>)

;<var>text</var>

:The text to display in the progress box.

=====Result:=====

An empty string or a message from the progress dialog

==SETVALUE==

Updates progress bar position.

=====Usage:=====

<code>PROGRESSBOX SETVALUE <var>handle</var> <var>position</var></code>

=====Parameters:=====

;<var>handle</var>

:The handle returned by the call to <code>PROGRESSBOX BEGIN</code>.

;<var>position</var>

:The progress bar position (0 .. progress bar range, as set in <code>PROGRESSBOX BEGIN</code>)

=====Result:=====

none

==TITLE==

Updates the progress box caption.

=====Usage:=====

<code>PROGRESSBOX TITLE <var>handle</var> <var>title</var></code>

=====Parameters:=====

;<var>handle</var>

:The handle returned by the call to <code>PROGRESSBOX BEGIN</code>.

;<var>title</var>

:The text to display in the progress box window caption.

=====Result:=====

none

==TEXT==

Updates the progress box static text control.

=====Usage:=====

<code>PROGRESSBOX TEXT <var>handle</var> <var>text</var></code>

=====Parameters:=====

;<var>handle</var>

:The handle returned by the call to <code>PROGRESSBOX BEGIN</code>.

;<var>text</var>

:The text to display in the progress box.

=====Result:=====

none

Array