Wheel IDE

Online demo »

Component/Dropdown

Namespace
components.dropdown

Constants

The form module.
Source: lib/modules/components/dropdown.whl, line: 8
MODULE_COMPONENT_DROPDOWN69

Module calls for the dropdown component functions.
Source: lib/modules/components/dropdown.whl, line: 11
DROPDOWN_COMPONENT_SET_HIDDEN0
DROPDOWN_COMPONENT_SET_DISABLED1
DROPDOWN_COMPONENT_SET_X2
DROPDOWN_COMPONENT_SET_Y3
DROPDOWN_COMPONENT_SET_VALUE4
DROPDOWN_COMPONENT_GET_VALUE5
DROPDOWN_COMPONENT_CLEAR6
DROPDOWN_COMPONENT_ADD_ITEM7

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.
itemslistA list of selectable items.
valuenumberThe selected item.

Events

onChange

Called when an other item is selected.

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

Called when the dropdown is focussed.

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

Called when the dropdown looses focus.

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

Procedures

setHidden
Source: lib/modules/components/dropdown.whl, line: 41

Hide the dropdown component.

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/dropdown.whl, line: 50

Disable the dropdown component.

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/dropdown.whl, line: 59

Set the x position of the dropdown component.

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/dropdown.whl, line: 68

Set the y position of the dropdown component.

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.

setValue
Source: lib/modules/components/dropdown.whl, line: 77

Set the value.

proc setValue(number windowHandle, number componentHandle, number value)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
valuenumberThe active item.

getValue
Source: lib/modules/components/dropdown.whl, line: 86

Get the value.

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


clear
Source: lib/modules/components/dropdown.whl, line: 95

Clear the dropdown list.

proc clear(number windowHandle, number componentHandle)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.

addItem
Source: lib/modules/components/dropdown.whl, line: 103

Add an item to the dropdown list.

proc addItem(number windowHandle, number componentHandle, number value, string text)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
valuenumber
textstring