Component/Rectangle

Namespace

Constants

MODULE_COMPONENT_RECTANGLE

96

RECTANGLE_SET_HIDDEN	0
RECTANGLE_SET_X	1
RECTANGLE_SET_Y	2
RECTANGLE_SET_WIDTH	3
RECTANGLE_SET_HEIGHT	4
RECTANGLE_SET_FILL_COLOR	5
RECTANGLE_SET_BORDER_COLOR	6
RECTANGLE_SET_BORDER_WIDTH	7
RECTANGLE_SET_BORDER_RADIUS	8

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.
width	number	The rectangle width.
height	number	The rectangle height.
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.
borderRadius	number	The border radius, this value can give the rectangle rounded corners.

Events

onClick

Called when the rectangle is clicked.

proc onClick(number windowHandle)

Name	Type	Description
windowHandle	number	The handle of the parent window of the rectangle.

onMouseDown

Called when the mouse is pressed on the rectangle.

proc onMouseDown(number windowHandle)

Name	Type	Description
windowHandle	number	The handle of the parent window of the rectangle.

onMouseUp

Called when the mouse is released on the rectangle.

proc onMouseUp(number windowHandle)

Name	Type	Description
windowHandle	number	The handle of the parent window of the rectangle.

onMouseMove

Called when the mouse moves over the rectangle.

proc onMouseMove(number windowHandle)

Name	Type	Description
windowHandle	number	The handle of the parent window of the rectangle.

onMouseOut

Called when the mouse moves out of the rectangle.

proc onMouseOut(number windowHandle)

Name	Type	Description
windowHandle	number	The handle of the parent window of the rectangle.

---

Procedures

setHidden

Hide the rectangle.

proc setHidden(number windowHandle, number componentHandle, number hidden)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
hidden	number	Hidden TRUE or FALSE.

---

setX

Set the x position of the rectangle.

proc setX(number windowHandle, number componentHandle, number x)

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

Set the y position of the rectangle.

proc setY(number windowHandle, number componentHandle, number y)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
y	number	The y position in pixels.

---

setWidth

Set the rectangle width.

proc setWidth(number windowHandle, number componentHandle, number width)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
width	number	The rectangle width.

---

setHeight

Set the rectangle height.

proc setHeight(number windowHandle, number componentHandle, number height)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
height	number	The rectangle height.

---

setFillColor

Set the fill color.

proc setFillColor(number windowHandle, number componentHandle, number red, number green, number blue)

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

Set the border color.

proc setBorderColor(number windowHandle, number componentHandle, number red, number green, number blue)

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

Set the border width.

proc setBorderWidth(number windowHandle, number componentHandle, number borderWidth)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
borderWidth	number	The border width.

---

setBorderRadius

Set the border radius.

proc setBorderRadius(number windowHandle, number componentHandle, number borderRadius)

Name	Type	Description
windowHandle	number	The handle of the window.
componentHandle	number	The handle of the component.
borderRadius	number

---