Wheel IDE

Online demo »

Component/Image

Namespace
components.image

Constants

The form component module.
Source: lib/modules/components/image.whl, line: 8
MODULE_COMPONENT_IMAGE98

Module calls for image component functions.
Source: lib/modules/components/image.whl, line: 11
IMAGE_COMPONENT_SET_HIDDEN0
IMAGE_COMPONENT_SET_X1
IMAGE_COMPONENT_SET_Y2
IMAGE_COMPONENT_SET_WIDTH3
IMAGE_COMPONENT_SET_HEIGHT4
IMAGE_COMPONENT_SET_SRC5

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.
naturalSizebooleanIf this option is selected then the original format of the image is used and the width and height values are ignored.
widthnumberThe image width.
heightnumberThe image height.
srcstringThe 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:
NameTypeDescription
windowHandlenumberThe handle of the parent window of the image.
onMouseDown

Called when the mouse is pressed on the image.

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

Called when the mouse is released on the image.

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

Called when the mouse moves over the image.

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

Called when the mouse moves out of the image.

proc onMouseOut(number windowHandle)
Parameters:
NameTypeDescription
windowHandlenumberThe 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:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
hiddennumberHidden 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:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
xnumberThe 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:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
ynumberThe 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:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
widthnumberThe image width.

setHeight
Source: lib/modules/components/image.whl, line: 81

Set the image height.

proc setHeight(number windowHandle, number componentHandle, number height)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
heightnumberThe image height.

setSrc
Source: lib/modules/components/image.whl, line: 90

Set the source location.

proc setSrc(number windowHandle, number componentHandle, string src)
Parameters:
NameTypeDescription
windowHandlenumberThe handle of the window.
componentHandlenumberThe handle of the component.
srcstringThe location of the image file.