Component/Icon
Namespace
components.icon
Constants
The form component module.
Source: lib/modules/components/icon.whl, line: 8
Module calls for the icon component functions.
Source: lib/modules/components/icon.whl, line: 11
ICON_COMPONENT_SET_HIDDEN | 0 |
ICON_COMPONENT_SET_X | 1 |
ICON_COMPONENT_SET_Y | 2 |
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. |
icon | icon | An icon image which is selectable from a list in the editor. |
Events
onClick
Called when the icon is clicked.
proc onClick(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the icon. |
onMouseDown
Called when the mouse is pressed on the icon.
proc onMouseDown(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the icon. |
onMouseUp
Called when the mouse is released on the icon.
proc onMouseUp(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the icon. |
onMouseMove
Called when the mouse moves over the icon.
proc onMouseMove(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the icon. |
onMouseOut
Called when the mouse moves out of the icon.
proc onMouseOut(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The 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:
Name | Type | Description |
windowHandle | number | The handle of the window. |
componentHandle | number | The handle of the component. |
hidden | number | Hidden 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:
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/icon.whl, line: 56
Set the y position of the icon.
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. |