Component/Circle
Namespace
components.circle
Constants
The form component module.
Source: lib/modules/components/circle.whl, line: 8
| MODULE_COMPONENT_CIRCLE | 97 |
Module calls for the circle component functions.
Source: lib/modules/components/circle.whl, line: 11
CIRCLE_SET_HIDDEN | 0 |
CIRCLE_SET_X | 1 |
CIRCLE_SET_Y | 2 |
CIRCLE_SET_RADIUS | 3 |
CIRCLE_SET_FILL_COLOR | 4 |
CIRCLE_SET_BORDER_COLOR | 5 |
CIRCLE_SET_BORDER_WIDTH | 6 |
CIRCLE_SET_BORDER_RADIUS | 7 |
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. |
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. |
radius | number | The circle radius. |
fillColor | rgb | The fill color in red, green and blue. |
borderColor | rgb | The border color in red, green and blue. |
borderWidth | number | The border width. |
Events
onClick
Called when the circle is clicked.
proc onClick(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the circle. |
onMouseDown
Called when the mouse is pressed on the circle.
proc onMouseDown(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the circle. |
onMouseUp
Called when the mouse is released on the circle.
proc onMouseUp(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the circle. |
onMouseMove
Called when the mouse moves over the circle.
proc onMouseMove(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the circle. |
onMouseOut
Called when the mouse moves out of the circle.
proc onMouseOut(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the circle. |
Procedures
setHidden
Source: lib/modules/components/circle.whl, line: 47
Hide the circle.
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/circle.whl, line: 56
Set the x position of the circle.
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/circle.whl, line: 65
Set the y position of the circle.
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. |
setRadius
Source: lib/modules/components/circle.whl, line: 74
Set the circle width.
proc setRadius(number windowHandle, number componentHandle, number radius)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the window. |
componentHandle | number | The handle of the component. |
radius | number | The circle radius. |
setFillColor
Source: lib/modules/components/circle.whl, line: 83
Set the fill color.
proc setFillColor(number windowHandle, number componentHandle, number red, number green, number blue)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the window. |
componentHandle | number | The handle of the component. |
red | number | The red color component, a value in the range of 0..255. |
green | number | The green color component, a value in the range of 0..255. |
blue | number | The blue color component, a value in the range of 0..255. |
setBorderColor
Source: lib/modules/components/circle.whl, line: 94
Set the border color.
proc setBorderColor(number windowHandle, number componentHandle, number red, number green, number blue)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the window. |
componentHandle | number | The handle of the component. |
red | number | The red color component, a value in the range of 0..255. |
green | number | The green color component, a value in the range of 0..255. |
blue | number | The blue color component, a value in the range of 0..255. |
setBorderWidth
Source: lib/modules/components/circle.whl, line: 105
Set the border width.
proc setBorderWidth(number windowHandle, number componentHandle, number borderWidth)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the window. |
componentHandle | number | The handle of the component. |
borderWidth | number | The border width. |
setBorderRadius
Source: lib/modules/components/circle.whl, line: 114
Set the border radius.
proc setBorderRadius(number windowHandle, number componentHandle, number borderWidth)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the window. |
componentHandle | number | The handle of the component. |
borderWidth | number | The border radius. |