Component/Timeout
Namespace
components.timeout
Constants
The timeout component module.
Source: lib/modules/components/timeout.whl, line: 8
| MODULE_COMPONENT_TIMEOUT | 133 |
Module calls for timeout component functions.
Source: lib/modules/components/timeout.whl, line: 11
| TIMEOUT_COMPONENT_SET_TIME | 0 |
| TIMEOUT_COMPONENT_START | 1 |
| TIMEOUT_COMPONENT_CANCEL | 2 |
Properties
These properties can be edited with the property editor in the IDE.
| Name | Type | Description |
| name | string | The component name. |
| y | number | The top position of the component icon, this only applies to the icon in design mode. |
| time | number | The timeout time in milliseconds. |
Events
onTimeout
Called when timeout time is expired.
proc onTimeout(number windowHandle)
Parameters:
| Name | Type | Description |
| windowHandle | number | The handle of the parent window of the timeout component. |
Procedures
setTime
Source: lib/modules/components/timeout.whl, line: 24
Set the timeout time.
proc setTime(number windowHandle, number componentHandle, number time)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
| time | number | The timeout time in milli seconds. |
start
Source: lib/modules/components/timeout.whl, line: 33
Start the timeout.
proc start(number windowHandle, number componentHandle)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
cancel
Source: lib/modules/components/timeout.whl, line: 41
Cancel the timeout.
proc cancel(number windowHandle, number componentHandle)
Parameters:
| Name | Type | Description |
|---|
| windowHandle | number | The handle of the window. |
| componentHandle | number | The handle of the component. |
