| Chapter 38. gaugelib | ||
|---|---|---|
 | Part III. SIMPOL-Language Libraries |  |
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 meparentlefttopwidthheightrangetitleshowcancelbuttonknowntotalusenativegaugeerror
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| me | None | gaugedialog | |
| parent | None | type(wxdialogparent) | |
| left | 1 | integer | |
| top | 1 | integer | |
| width | 350 | integer | |
| height | 150 | integer | |
| range | None | integer | |
| title | None | string | |
| showcancelbutton | .true | boolean | |
| knowntotal | .true | boolean | |
| usenativegauge | .true | boolean | |
| error | None | integer |
Properties
| Property | Type | Description |
|---|---|---|
| close | function | |
| currentposition | integer | |
| d | wxdialog | |
| f | wxform | |
| forwards | boolean | |
| height | integer | |
| knowntotal | boolean | |
| left | integer | |
| parent | type(wxdialogparent) | |
| range | integer | |
| setgaugeposition | function | |
| setrange | function | |
| settitle | function | |
| setupforunknownpos | function | |
| show | function | |
| showcancelbutton | boolean | |
| solid | boolean | |
| title | string | |
| top | integer | |
| type | type | |
| usenativegauge | boolean | |
| usercanceled | boolean | |
| width | integer |
Methods
close()
Description
Prototype
gaugedialogvar.close (
gaugedialog me
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| me | None | gaugedialog |
setgaugeposition()
Description
Prototype
gaugedialogvar.setgaugeposition (
gaugedialog meposition
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| me | None | gaugedialog | |
| position | None | integer |
setrange()
Description
Prototype
gaugedialogvar.setrange (
gaugedialog merange
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| me | None | gaugedialog | |
| range | None | integer |
settitle()
Description
Prototype
gaugedialogvar.settitle (
gaugedialog metext
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| me | None | gaugedialog | |
| text | None | string |
setupforunknownpos()
Description
Prototype
gaugedialogvar.setupforunknownpos (
gaugedialog me
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| me | None | gaugedialog |
show()
Description
Prototype
gaugedialogvar.show (
gaugedialog me
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| me | None | gaugedialog |