Programmer Guide/Macro Library/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.



BEGIN

Initialize the progress box and create the progress box window.

Usage:

PROGRESSBOX BEGIN parent|* style textwidth barrange ; title ; text

Parameters:

parent

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

style

This is not used and should be set to 0.

textwidth

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

barrange

The progress bar range. barrange must be <= 0 if no progress bar should be displayed.

title

The dialog window caption.

text

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 PROGRESSBOX!



END

Deletes the progress box.

Usage:

PROGRESSBOX END handle

Parameters:

handle

The handle returned by the call to PROGRESSBOX BEGIN.

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:

PROGRESSBOX SET handle position text

Parameters:

handle

The handle returned by the call to PROGRESSBOX BEGIN.

position

The progress bar position (0 .. progress bar range, as set in PROGRESSBOX BEGIN)

text

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:

PROGRESSBOX SETVALUE handle position

Parameters:

handle

The handle returned by the call to PROGRESSBOX BEGIN.

position

The progress bar position (0 .. progress bar range, as set in PROGRESSBOX BEGIN)

Result:

none



TITLE

Updates the progress box caption.

Usage:

PROGRESSBOX TITLE handle title

Parameters:

handle

The handle returned by the call to PROGRESSBOX BEGIN.

title

The text to display in the progress box window caption.

Result:

none



TEXT

Updates the progress box static text control.

Usage:

PROGRESSBOX TEXT handle text

Parameters:

handle

The handle returned by the call to PROGRESSBOX BEGIN.

text

The text to display in the progress box.

Result:

none

Array