SIMPOL Documentation

Chapter 38. gaugelib

The gaugelib library includes two gauge dialog implementations, one of which allows multiple gauges to be shown in the same dialog and managed separately. These dialogs can be used to provide a progress meter as feedback during routines.

gaugedialog

Description

Type Tags

None

Object Value

Objects of type gaugedialog have no value, and it is an error to try to get or set this value.

gaugedialog.new()

Description

Prototype

gaugedialog.new ( gaugedialog me, type(wxdialogparent) parent, integer left, integer top, integer width, integer height, integer range, string title, boolean showcancelbutton, boolean knowntotal, boolean usenativegauge, integer error )

Parameters

ParameterDefault valueType nameDescription
meNonegaugedialog
parentNonetype(wxdialogparent)
left1integer
top1integer
width350integer
height150integer
rangeNoneinteger
titleNonestring
showcancelbutton.trueboolean
knowntotal.trueboolean
usenativegauge.trueboolean
errorNoneinteger

Properties

PropertyTypeDescription
closefunction
currentpositioninteger
dwxdialog
fwxform
forwardsboolean
heightinteger
knowntotalboolean
leftinteger
parenttype(wxdialogparent)
rangeinteger
setgaugepositionfunction
setrangefunction
settitlefunction
setupforunknownposfunction
showfunction
showcancelbuttonboolean
solidboolean
titlestring
topinteger
typetype
usenativegaugeboolean
usercanceledboolean
widthinteger

Methods

close()

Description

Prototype

gaugedialogvar.close ( gaugedialog me )

Parameters
ParameterDefault valueType nameDescription
meNonegaugedialog

setgaugeposition()

Description

Prototype

gaugedialogvar.setgaugeposition ( gaugedialog me, integer position )

Parameters
ParameterDefault valueType nameDescription
meNonegaugedialog
positionNoneinteger

setrange()

Description

Prototype

gaugedialogvar.setrange ( gaugedialog me, integer range )

Parameters
ParameterDefault valueType nameDescription
meNonegaugedialog
rangeNoneinteger

settitle()

Description

Prototype

gaugedialogvar.settitle ( gaugedialog me, string text )

Parameters
ParameterDefault valueType nameDescription
meNonegaugedialog
textNonestring

setupforunknownpos()

Description

Prototype

gaugedialogvar.setupforunknownpos ( gaugedialog me )

Parameters
ParameterDefault valueType nameDescription
meNonegaugedialog

show()

Description

Prototype

gaugedialogvar.show ( gaugedialog me )

Parameters
ParameterDefault valueType nameDescription
meNonegaugedialog