Wheel IDE

Online demo »

Component/SelectButton

Namespace
components.selectButton

Constants

The form module.
Source: lib/modules/components/selectButton.whl, line: 8
MODULE_COMPONENT_SELECT_BUTTON66

Module calls for button component functions.
Source: lib/modules/components/selectButton.whl, line: 11
SELECT_BUTTON_COMPONENT_SET_HIDDEN0
SELECT_BUTTON_COMPONENT_SET_DISABLED1
SELECT_BUTTON_COMPONENT_SET_X2
SELECT_BUTTON_COMPONENT_SET_Y3
SELECT_BUTTON_COMPONENT_SET_COLOR4
SELECT_BUTTON_COMPONENT_SET_ACTIVE5
SELECT_BUTTON_COMPONENT_GET_ACTIVE6

Properties

These properties can be edited with the property editor in the IDE.

NameTypeDescription
namestringThe component name.
hiddenbooleanHide the component.
disabledbooleanDisable the component.
xnumberThe left position of the component inside the parent component.
ynumberThe top position of the component inside the parent component.
zIndexnumberThe depth of the component related to other components in the parent.
colorcolorThe color of the buttons, available colors are: gray, yellow, green, blue or red.
optionsstringA list of button titles.

Events

onChange

Called when an other button is selected.

proc onChange(number windowHandle, number value)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the parent window of the selectButton.
valuenumberIndex of the selected button, the index of the first button is 0, the second is 1, etc..
onFocus

Called when the selectButton is focussed.

proc onFocus(number windowHandle)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the parent window of the selectButton.
onBlur

Called when the selectButton looses focus.

proc onBlur(number windowHandle)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the parent window of the selectButton.

Procedures

setHidden
Source: lib/modules/components/selectButton.whl, line: 40

Hide the select button.

proc setHidden(number windowHandle, number componentHandle, number hidden)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
hiddennumberHidden TRUE or FALSE.

setDisabled
Source: lib/modules/components/selectButton.whl, line: 49

Disable the select button.

proc setDisabled(number windowHandle, number componentHandle, number disabled)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
disablednumberDisabled TRUE or FALSE.

setX
Source: lib/modules/components/selectButton.whl, line: 58

Set the x position of the select button.

proc setX(number windowHandle, number componentHandle, number x)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
xnumberThe x position in pixels.

setY
Source: lib/modules/components/selectButton.whl, line: 67

Set the y position of the select button.

proc setY(number windowHandle, number componentHandle, number y)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
ynumberThe y position in pixels.

setColor
Source: lib/modules/components/selectButton.whl, line: 76

Set the select button color.

proc setColor(number windowHandle, number componentHandle, number color)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
colornumberThe button color.

setActive
Source: lib/modules/components/selectButton.whl, line: 85

Set the active button.

proc setActive(number windowHandle, number componentHandle, number active)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
activenumberThe active button.

getActive
Source: lib/modules/components/selectButton.whl, line: 94

Get the active button.

proc getActive(number windowHandle, number componentHandle)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
Return: The active button.