Wheel IDE

Online demo »

Component/Circle

Namespace
components.circle

Constants

The form component module.
Source: lib/modules/components/circle.whl, line: 8
MODULE_COMPONENT_CIRCLE97

Module calls for the circle component functions.
Source: lib/modules/components/circle.whl, line: 11
CIRCLE_SET_HIDDEN0
CIRCLE_SET_X1
CIRCLE_SET_Y2
CIRCLE_SET_RADIUS3
CIRCLE_SET_FILL_COLOR4
CIRCLE_SET_BORDER_COLOR5
CIRCLE_SET_BORDER_WIDTH6
CIRCLE_SET_BORDER_RADIUS7

Properties

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

NameTypeDescription
namestringThe component name.
hiddenbooleanHide 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.
radiusnumberThe circle radius.
fillColorrgbThe fill color in red, green and blue.
borderColorrgbThe border color in red, green and blue.
borderWidthnumberThe border width.

Events

onClick

Called when the circle is clicked.

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

Called when the mouse is pressed on the circle.

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

Called when the mouse is released on the circle.

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

Called when the mouse moves over the circle.

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

Called when the mouse moves out of the circle.

proc onMouseOut(number windowHandle)
Parameters:
NameTypeDescription
windowHandlenumberThe 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:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
hiddennumberHidden 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:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
xnumberThe 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:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
ynumberThe 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:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
radiusnumberThe 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:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
rednumberThe red color component, a value in the range of 0..255.
greennumberThe green color component, a value in the range of 0..255.
bluenumberThe 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:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
rednumberThe red color component, a value in the range of 0..255.
greennumberThe green color component, a value in the range of 0..255.
bluenumberThe 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:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
borderWidthnumberThe border width.

setBorderRadius
Source: lib/modules/components/circle.whl, line: 114

Set the border radius.

proc setBorderRadius(number windowHandle, number componentHandle, number borderWidth)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
borderWidthnumberThe border radius.