Wheel IDE

Online demo »

Component/Icon

Namespace
components.icon

Constants

The form component module.
Source: lib/modules/components/icon.whl, line: 8
MODULE_COMPONENT_ICON99

Module calls for the icon component functions.
Source: lib/modules/components/icon.whl, line: 11
ICON_COMPONENT_SET_HIDDEN0
ICON_COMPONENT_SET_X1
ICON_COMPONENT_SET_Y2

Properties

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

NameTypeDescription
namestringThe component name.
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.
iconiconAn icon image which is selectable from a list in the editor.

Events

onClick

Called when the icon is clicked.

proc onClick(number windowHandle)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the parent window of the icon.
onMouseDown

Called when the mouse is pressed on the icon.

proc onMouseDown(number windowHandle)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the parent window of the icon.
onMouseUp

Called when the mouse is released on the icon.

proc onMouseUp(number windowHandle)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the parent window of the icon.
onMouseMove

Called when the mouse moves over the icon.

proc onMouseMove(number windowHandle)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the parent window of the icon.
onMouseOut

Called when the mouse moves out of the icon.

proc onMouseOut(number windowHandle)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the parent window of the icon.

Procedures

setHidden
Source: lib/modules/components/icon.whl, line: 38

Hide the icon.

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

setX
Source: lib/modules/components/icon.whl, line: 47

Set the x position of the icon.

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/icon.whl, line: 56

Set the y position of the icon.

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.