m-shell.net

Class abgui.ProgressBar

A horizontal or vertical progress bar.

Constructor

function init(desiredSize=[80,16], format=null)
Overridesabguibase.Widget.init()

Initialize a new ProgressBar.
Parameters:
desiredSize – the desired size of progress bar. This also defines the orientation (horizontal or vertical).
format – the format to use for the centered value text. If not null, it must contain a single numeric parameter (typically %d).

Fields

at	The current value.
color	The bar color.
format	The current value label format (for io.format).
max	The maximum value.
min	The minimum value.

Functions

draw()	[Inherited comment] Draw this widget.
incAt(delta=1)	Increment the current value.
setAt(at)	Set the current value.
setMax(max)	Set the maximum value (right or top).
setMin(min)	Set the minimum value (left or bottom).

function setMin(min)

Set the minimum value (left or bottom). Default is 0.
Parameters:
min – the minimum value.

function setMax(max)

Set the maximum value (right or top). Default is 100.
Parameters:
max – the maximum value.

function setAt(at)

Set the current value.
Parameters:
at – the new current value.

function incAt(delta=1)

Increment the current value.
Parameters:
delta – the increment.

function draw()
Overridesabguibase.Widget.draw()

[Inherited comment] Draw this widget. The clip rectangle is set to this widget's rectangle. Override in subclasses to draw their specific view. The default implementation draws the focus.