Component/ProgressBar
Namespace
components.progressBar
Constants
The progress bar component module.
Source: lib/modules/components/progressBar.whl, line: 8
| MODULE_COMPONENT_PROGRESS_BAR | 105 |
Module calls for the progress bar component functions.
Source: lib/modules/components/progressBar.whl, line: 11
| PROGRESS_BAR_COMPONENT_SET_HIDDEN | 0 |
| PROGRESS_BAR_COMPONENT_SET_X | 1 |
| PROGRESS_BAR_COMPONENT_SET_Y | 2 |
| PROGRESS_BAR_COMPONENT_SET_WIDTH | 3 |
| PROGRESS_BAR_COMPONENT_SET_VALUE | 4 |
Properties
These properties can be edited with the property editor in the IDE.
| Name | Type | Description |
| name | string | The component name. |
| hidden | boolean | Hide the component. |
| x | number | The left position of the component inside the parent component. |
| y | number | The top position of the component inside the parent component. |
| zIndex | number | The depth of the component related to other components in the parent. |
| width | number | The progress bar width. |
| value | number | The current progress, a value in the range of 0..100. |
Procedures
setHidden
Source: lib/modules/components/progressBar.whl, line: 27
Hide the progress bar.
proc setHidden(number windowHandle, number componentHandle, number tabIndex)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| tabIndex | number | |
setX
Source: lib/modules/components/progressBar.whl, line: 36
Set the x position of the progress bar.
proc setX(number windowHandle, number componentHandle, number x)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| x | number | The x position in pixels. |
setY
Source: lib/modules/components/progressBar.whl, line: 45
Set the y position of the progress bar.
proc setY(number windowHandle, number componentHandle, number y)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| y | number | The y position in pixels. |
setWidth
Source: lib/modules/components/progressBar.whl, line: 54
Set the progress bar width.
proc setWidth(number windowHandle, number componentHandle, number width)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| width | number | The width. |
setValue
Source: lib/modules/components/progressBar.whl, line: 63
Set the progress bar value.
proc setValue(number windowHandle, number componentHandle, number value)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| value | number | The progress in the range of 0..100. |
