This document lists and describes all of the actions that are available in the Pandora Engine. For information on how to execute actions, refer to the Action(), ActionMsg() and ActionTags() functions in the Object Kernel Manual. Please note that the objects created in the Pandora Engine will support only the actions that the developer has deemed to be a requirement. To know outright whether an object supports a particular action, you will need to check its class manual.
Object Management Actions GUI Actions |
General Actions File Actions |
Action: | Activate | |
Short: | Performs the native action of an object. | |
Arguments: | None | |
|
Action: | Clear | |
Short: | Clears an object's data. | |
Arguments: | None | |
|
Action: | Clipboard | |||||||||
Short: | Used to copy and paste information to and from Clipboard objects. | |||||||||
Arguments: |
| |||||||||
|
Action: | ClosingTag | |
Short: | The ClosingTag action is reserved for the use of script-based classes. | |
Arguments: | None | |
|
Action: | CopyData | ||
Short: | This action can be used to copy data from one object to another. | ||
Arguments: |
| ||
|
Action: | DataChannel | ||||||||||||
Short: | The DataChannel action is used to send described data to objects. | ||||||||||||
Arguments: |
| ||||||||||||
| |||||||||||||
| |||||||||||||
| |||||||||||||
| |||||||||||||
| |||||||||||||
|
Action: | Deactivate | |
Short: | Stops an object from performing its native activity. | |
Arguments: | None | |
|
Action: | Disable | |
Short: | Disables an object. | |
Arguments: | None | |
|
Action: | Draw | ||||||||
Short: | Draws object graphics to drawable areas. | ||||||||
Arguments: |
| ||||||||
|
Action: | Enable | |
Short: | Enables a disabled object. | |
Arguments: | None | |
|
Action: | Flush | |
Short: | Flush buffered data from an object. | |
Arguments: | None | |
|
Action: | Focus | |
Short: | The Focus action is used to focus on objects within the user interface. | |
Arguments: | None | |
|
Action: | Free | |
Short: | Frees an object and any of its associated resources. | |
Arguments: | None | |
|
Action: | GetUnlistedField | ||||||
Short: | This action retrieves field values that are not defined by an object's structure. | ||||||
Arguments: |
| ||||||
|
Action: | HealthCheck | |
Short: | Objects that are suspected to be damaged can sometimes be repaired by making a health-check. | |
Arguments: | None | |
|
Action: | Hide | |
Short: | Hides a visible object from the view of the user. | |
Arguments: | None | |
|
Action: | Init | |
Short: | Initialises an object so that it is ready for active use. | |
Arguments: | None | |
|
Action: | Lock | |
Short: | Locks an object's 'physical' position and other attributes. | |
Arguments: | None | |
|
Action: | Move | ||||||
Short: | Moves the physical representation of an object to a new location. | ||||||
Arguments: |
| ||||||
|
Action: | MoveToBack, MoveToFront | |
Short: | Move an object to the back or front of its current location. | |
Arguments: | None | |
|
Action: | MoveToPoint | ||||||||
Short: | Moves the physical representation of an object to a new location. | ||||||||
Arguments: |
| ||||||||
|
Action: | OpeningTag | |
Short: | The OpeningTag action is used to 'execute' objects. | |
Arguments: | None | |
|
Action: | Query | |
Short: | Gets the latest information on a particular object. | |
Arguments: | None | |
|
Action: | Read | ||||||
Short: | Reads raw data information from objects. | ||||||
Arguments: |
| ||||||
|
Action: | Refresh | |
Short: | The Refresh action is used to refresh object states. | |
Arguments: | None | |
|
Action: | Rename | ||
Short: | Renames an object. | ||
Arguments: |
| ||
|
Action: | Reset | |
Short: | Resets an object to its original state. | |
Arguments: | None | |
|
Action: | Resize | ||||||
Short: | Resizes objects that are represented by two or three dimensional graphics. | ||||||
Arguments: |
| ||||||
|
Action: | SaveImage | ||
Short: | Saves an object's image to a destination object. | ||
Arguments: |
| ||
|
Action: | SaveToObject | ||
Short: | Saves an object's data to a destination object. | ||
Arguments: |
| ||
|
Action: | Scroll | ||||||
Short: | Scroll the contents of a container. | ||||||
Arguments: |
| ||||||
|
Action: | Seek | ||||
Short: | Seek to a new position in an object. | ||||
Arguments: |
| ||||
|
Action: | SetUnlistedField | ||||
Short: | This action sets field values that are not defined by an object's structure. | ||||
Arguments: |
| ||||
|
Action: | Show | |
Short: | Makes an object visible to the user. | |
Arguments: | None | |
|
Action: | Unlock | |
Short: | Remove a lock from an object. | |
Arguments: | None | |
|
Action: | UserClick | ||||||||
Short: | Use this action to inform drawable objects that a user click has occurred. | ||||||||
Arguments: |
| ||||||||
|
Action: | UserClickRelease | ||||||||||||||||
Short: | Informs an object that a user click has been released. | ||||||||||||||||
Arguments: |
| ||||||||||||||||
|
Action: | UserMovement | ||||||||||||||
Short: | Used to inform components of user movement. | ||||||||||||||
Arguments: |
| ||||||||||||||
|
Action: | Write | ||||||
Short: | Writes data to objects that provide storage or output services. | ||||||
Arguments: |
| ||||||
|