Component/Image
Namespace
components.image
Constants
The form component module.
Source: lib/modules/components/image.whl, line: 8
Module calls for image component functions.
Source: lib/modules/components/image.whl, line: 11
IMAGE_COMPONENT_SET_HIDDEN | 0 |
IMAGE_COMPONENT_SET_X | 1 |
IMAGE_COMPONENT_SET_Y | 2 |
IMAGE_COMPONENT_SET_WIDTH | 3 |
IMAGE_COMPONENT_SET_HEIGHT | 4 |
IMAGE_COMPONENT_SET_SRC | 5 |
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. |
naturalSize | boolean | If this option is selected then the original format of the image is used and the width and height values are ignored. |
width | number | The image width. |
height | number | The image height. |
src | string | The path and filename, when the http:// then the image will be downloaded else the file is loaded from the project location. |
Events
onClick
Called when the image is clicked.
proc onClick(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the image. |
onMouseDown
Called when the mouse is pressed on the image.
proc onMouseDown(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the image. |
onMouseUp
Called when the mouse is released on the image.
proc onMouseUp(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the image. |
onMouseMove
Called when the mouse moves over the image.
proc onMouseMove(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the image. |
onMouseOut
Called when the mouse moves out of the image.
proc onMouseOut(number windowHandle)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the parent window of the image. |
Procedures
setHidden
Source: lib/modules/components/image.whl, line: 45
Hide the image.
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/image.whl, line: 54
Set the x position of the image.
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/image.whl, line: 63
Set the y position of the image.
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. |
setWidth
Source: lib/modules/components/image.whl, line: 72
Set the image width.
proc setWidth(number windowHandle, number componentHandle, number width)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the window. |
componentHandle | number | The handle of the component. |
width | number | The image width. |
setHeight
Source: lib/modules/components/image.whl, line: 81
Set the image height.
proc setHeight(number windowHandle, number componentHandle, number height)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the window. |
componentHandle | number | The handle of the component. |
height | number | The image height. |
setSrc
Source: lib/modules/components/image.whl, line: 90
Set the source location.
proc setSrc(number windowHandle, number componentHandle, string src)
Parameters:
Name | Type | Description |
windowHandle | number | The handle of the window. |
componentHandle | number | The handle of the component. |
src | string | The location of the image file. |