Component/Radio
Namespace
components.radio
Constants
The form module.
Source: lib/modules/components/radio.whl, line: 8
Module calls for the radio component functions.
Source: lib/modules/components/radio.whl, line: 11
RADIO_COMPONENT_SET_HIDDEN | 0 |
RADIO_COMPONENT_SET_DISABLED | 1 |
RADIO_COMPONENT_SET_X | 2 |
RADIO_COMPONENT_SET_Y | 3 |
RADIO_COMPONENT_SET_VALUE | 4 |
RADIO_COMPONENT_GET_VALUE | 5 |
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. |
disabled | boolean | Disable 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. |
items | list | A list of selectable items. |
value | number | The selected item. |
horizontal | boolean | Display the items on a single line or underneath each other. |
Events
onChange
Called when an other item is selected.
proc onChange(number windowHandle, number value)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the radio. |
value | number | Index of the selected item, the index of the first item is 0, the second is 1, etc.. |
onFocus
Called when the radio is focussed.
proc onFocus(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the radio. |
onBlur
Called when the radio looses focus.
proc onBlur(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the radio. |
Procedures
setHidden
Source: lib/modules/components/radio.whl, line: 40
Hide the radio component.
proc setHidden(number windowHandle, number componentHandle, number hidden)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the window. |
componentHandle | number | The handle of the component. |
hidden | number | Hidden TRUE or FALSE. |
setDisabled
Source: lib/modules/components/radio.whl, line: 49
Disable the radio component.
proc setDisabled(number windowHandle, number componentHandle, number disabled)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the window. |
componentHandle | number | The handle of the component. |
disabled | number | Disabled TRUE or FALSE. |
setX
Source: lib/modules/components/radio.whl, line: 58
Set the x position of the radio component.
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/radio.whl, line: 67
Set the y position of the radio component.
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. |
setValue
Source: lib/modules/components/radio.whl, line: 76
Set the 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 active item. |
getValue
Source: lib/modules/components/radio.whl, line: 85
Get the value.
proc getValue(number windowHandle, number componentHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the window. |
componentHandle | number | The handle of the component. |
Return: The value.