Component/StatusLight
Namespace
components.statusLight
Constants
The status light component module.
Source: lib/modules/components/statusLight.whl, line: 8
| MODULE_COMPONENT_STATUS_LIGHT | 104 |
Module calls for the status light component functions.
Source: lib/modules/components/statusLight.whl, line: 11
| STATUS_LIGHT_COMPONENT_SET_HIDDEN | 0 |
| STATUS_LIGHT_COMPONENT_SET_X | 1 |
| STATUS_LIGHT_COMPONENT_SET_Y | 2 |
| STATUS_LIGHT_COMPONENT_SET_COLOR | 3 |
| STATUS_LIGHT_COMPONENT_SET_RGB_COLOR | 4 |
| STATUS_LIGHT_COMPONENT_SET_RGB | 5 |
Properties
These properties can be edited with the property editor in the IDE.
| Name | Type | Description |
| name | string | The component name. |
| 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. |
| color | color | The color of the buttons, available colors are: gray, yellow, green, blue or red. |
| rgbColor | boolean | If this option is selected then the given rgb color will be applied. |
| rgb | rgb | The color in red, green and blue. |
Procedures
setHidden
Source: lib/modules/components/statusLight.whl, line: 28
Hide the status light.
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/statusLight.whl, line: 37
Set the x position of the status light.
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/statusLight.whl, line: 46
Set the y position of the status light.
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. |
setColor
Source: lib/modules/components/statusLight.whl, line: 55
Set the status light color.
proc setColor(number windowHandle, number componentHandle, number color)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| color | number | The status light color. |
setRgbColor
Source: lib/modules/components/statusLight.whl, line: 64
Select RGB color mode.
proc setRgbColor(number windowHandle, number componentHandle, number rgbColor)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| rgbColor | number | |
setRgb
Source: lib/modules/components/statusLight.whl, line: 73
Set the RGB color.
proc setRgb(number windowHandle, number componentHandle, number red, number green, number blue)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| red | number | The red color component, a value in the range of 0..255. |
| green | number | The green color component, a value in the range of 0..255. |
| blue | number | The blue color component, a value in the range of 0..255. |
