GrandMA2 LUA Reference

• Index

Contents

• Functions

Modules

• gma.canbus
• gma.gui
• gma.gui.progress
• gma.
• gma.network
• gma.show.getobj
• gma.show
• gma.show.property
• gma.timestamp
• gma.user

Module gma.gui.progress

Progressbar related GMA LUA functions

Functions

gma.gui.progress.start (progress_name)	Create a new progress bar.
gma.gui.progress.stop (progress_handle)	Close an existing progress bar.
gma.gui.progress.settext (progress_handle, text)	Set the sub-title of a progress bar.
gma.gui.progress.setrange (progress_handle, from, to)	Set the min/max range of a progress bar.
gma.gui.progress.set (progress_handle, value)	Sets the position/progress of the progress bar.

Functions

gma.gui.progress.start (progress_name)

Create a new progress bar.

Please note there is no way for the user to close an open progress bar, therefore stop() MUST be called!

Parameters:

• progress_name string Main title of the progress bar.

  Respects the \n, \f, \r escape sequences but treats them all identically.

  Respects \t but renders very wierd.

  Respects \, ', \".

  Does NOT respect [, ]

Returns:

number Unique handle to reference the progressbar by.

See also:

gma.gui.progress.stop

gma.gui.progress.stop (progress_handle)

Close an existing progress bar.

Since there is no way for a user to close a progress bar, this MUST be called!

Parameters:

• progress_handle number Handle returned by start()

gma.gui.progress.settext (progress_handle, text)

Set the sub-title of a progress bar.

Parameters:

• progress_handle number Handle returned by start().
• text string String to set as the sub-title for the progress bar.

  Respects the \n, \f, \r escape sequences but treats them all identically.

  Respects \t but renders very weird.

  Respects \, ', \".

  Does NOT respect [, ]

gma.gui.progress.setrange (progress_handle, from, to)

Set the min/max range of a progress bar.

Parameters:

• progress_handle number Handle returned by start().
• from number Minimum value of the progress bar range.
• to number Maximum value of the progress bar range.

gma.gui.progress.set (progress_handle, value)

Sets the position/progress of the progress bar.

Parameters:

• progress_handle number Handle returned by start().
• value number Position to set progress bar to.

  A value less than the minimum value will appear to have no progress. A value greater than the maximum value will appear beyond the end of the progress bar.