Version: | 1.2 |
Status: | N/A |
Date: | February 2002 |
Author: | Rocklyte Systems |
Copyright: | Rocklyte Systems 1996-2002. All rights reserved. |
Short: | Describes the minimum requirements for supporting the available system actions. |
If you're writing a new class, you will need to consider what actions you will need to support, and know what is expected of your source code when you are supporting each action. This document provides you with full details on how your class is expected to handle the various actions, as well as advice on the basic requirements and potential pitfalls.
If you have not read the Class Manual and Class Development Guide yet, make sure that you read these first to develop an understanding on how the action mechanism works internally.
AccessObject Used for intercepting exclusive locks. ActionNotify Used for supporting subscriptions originating from the SubscribeAction() function. Activate Performs the native action of an object. Clear Used for clearing an object's data. Clipboard Used to manage cut, copy and paste operations with Clipboard objects. ClosingTag Provided for the purpose of script execution. CopyData Copies one object's data to another. DataChannel Provides a mechanism for sending formatted data betweeen objects. Deactivate Stops the processing of an object's native action. Disable Disables an object's interactive functionality. Draw Draws an object inside its drawable container. Enable Enables a disabled object. EventMessage Used for supporting event subscriptions originating from the Broadcast class. FieldNotify Used for supporting subscriptions originating from the SubscribeField() function. Flush Flushes buffered data from an object. Focus Used to inform objects that they have the focus. Free This action must be supported for the purposes of resource deallocation. FreeWarning Used for receiving an early warning before an object is freed. GetUnlistedField Used for the purpose of supporting unlisted field settings. HealthCheck This action can be supported in the interests of preventing data corruption to an object. Hide Used for hiding an object from the user. Init Called when an object is initialised. Lock Used when a programmer wants to lock the functionality of an object. LostFocus This action is called when an object loses the user focus. Move Used for moving objects to new coordinates. MoveToBack Moves an object to the back of its container. MoveToFront Moves an object to the front of its container. NewChild Used by classes that need to be alerted when an object receives a new child. NewOwner Called when the owner of an object is about to change. NewObject Called when a new object has been created from a base class. OpeningTag Provided for the purpose of script execution. Query Used to query the information represented by an object. Read Used for reading raw data from an object. Refresh Refreshes the state of an object. ReleaseObject Used for intercepting the release of exclusive locks. Rename Used for renaming objects. Reset Resets an object to its original state. Resize Used for resizing the dimensions of an object. SaveImage Saves an object's image to a data storage object. SaveToObject Saves an object's data to a data storage object. Scroll Scrolls the contents of an object. Seek Seeks to a new position within an object. SetUnlistedField Used for the purpose of supporting unlisted field settings. Show Makes an object visible to the user. Timer This action must be supported if the class requires regular timing messages. Unlock Unlocks an object's functionality. UserClick Used by drawable classes that need to respond to user clicks. UserClickRelease Used by drawable classes that need to respond to user click releases. UserMovement Used for detecting and responding to user movement. Write Used for writing raw data to an object.
Action: | AccessObject | |
Short: | Used for intercepting exclusive locks. | |
|
Action: | ActionNotify | ||||||||||
Short: | Used for supporting subscriptions originating from the SubscribeAction() function. | ||||||||||
Arguments: |
| ||||||||||
|
Action: | Clear | |
Short: | Used for clearing an object's data. | |
|
Action: | Clipboard | |||||||||
Short: | Used to manage cut, copy and paste operations with Clipboard objects. | |||||||||
|
Action: | ClosingTag | |
Short: | Provided for the purpose of script execution. | |
|
Action: | CopyData | ||
Short: | Copies one object's data to another. | ||
Arguments: |
| ||
|
Action: | DataChannel | ||||||||||||
Short: | Provides a mechanism for sending formatted data betweeen objects. | ||||||||||||
Arguments: |
| ||||||||||||
|
Action: | Deactivate | |
Short: | Stops the processing of an object's native action. | |
|
Action: | Disable | |
Short: | Disables an object's interactive functionality. | |
|
Action: | Draw | ||||||||
Short: | Draws an object inside its drawable container. | ||||||||
Arguments: |
| ||||||||
|
Action: | Enable | |
Short: | Enables a disabled object. | |
|
Action: | EventMessage | ||||||||||
Short: | Used for supporting event subscriptions originating from the Broadcast class. | ||||||||||
Arguments: |
| ||||||||||
|
Action: | FieldNotify | ||||
Short: | Used for supporting subscriptions originating from the SubscribeField() function. | ||||
Arguments: |
| ||||
|
Action: | Flush | |
Short: | Flushes buffered data from an object. | |
|
Action: | Focus | |
Short: | Used to inform objects that they have the focus. | |
|
Action: | Free | |
Short: | This action must be supported for the purposes of resource deallocation. | |
|
Action: | FreeWarning | |
Short: | Used for receiving an early warning before an object is freed. | |
|
Action: | GetUnlistedField | ||||||
Short: | Used for the purpose of supporting unlisted field settings. | ||||||
Arguments: |
| ||||||
|
Action: | HealthCheck | |
Short: | This action can be supported in the interests of preventing data corruption to an object. | |
|
Action: | Hide | |
Short: | Used for hiding an object from the user. | |
|
Action: | Init | |
Short: | Called when an object is initialised. | |
|
Action: | Lock | |
Short: | Used when a programmer wants to lock the functionality of an object. | |
|
Action: | LostFocus | |
Short: | This action is called when an object loses the user focus. | |
|
Action: | Move | ||||||
Short: | Used for moving objects to new coordinates. | ||||||
Arguments: |
| ||||||
|
Action: | MoveToBack | |
Short: | Moves an object to the back of its container. | |
|
Action: | MoveToFront | |
Short: | Moves an object to the front of its container. | |
|
Action: | NewChild | ||
Short: | Used by classes that need to be alerted when an object receives a new child. | ||
Arguments: |
| ||
|
Action: | NewOwner | ||||
Short: | Called when the owner of an object is about to change. | ||||
Arguments: |
| ||||
|
Action: | NewObject | |
Short: | Called when a new object has been created from a base class. | |
|
Action: | OpeningTag | |
Short: | Provided for the purpose of script execution. | |
|
Action: | Query | |
Short: | Used to query the information represented by an object. | |
|
Action: | Read | ||||||
Short: | Used for reading raw data from an object. | ||||||
Arguments: |
| ||||||
|
Action: | Refresh | |
Short: | Refreshes the state of an object. | |
|
Action: | ReleaseObject | |
Short: | Used for intercepting the release of exclusive locks. | |
|
Action: | Rename | ||
Short: | Used for renaming objects. | ||
Arguments: |
| ||
|
Action: | Reset | |
Short: | Resets an object to its original state. | |
|
Action: | Resize | ||||||
Short: | Used for resizing the dimensions of an object. | ||||||
Arguments: |
| ||||||
|
Action: | SaveImage | ||
Short: | Saves an object's image to a data storage object. | ||
Arguments: |
| ||
|
Action: | SaveToObject | ||
Short: | Saves an object's data to a data storage object. | ||
Arguments: |
| ||
|
Action: | Scroll | ||||||
Short: | Scrolls the contents of an object. | ||||||
Arguments: |
| ||||||
|
Action: | Seek | ||||
Short: | Seeks to a new position within an object. | ||||
Arguments: |
| ||||
|
Action: | SetUnlistedField | ||||
Short: | Used for the purpose of supporting unlisted field settings. | ||||
Arguments: |
| ||||
|
Action: | Show | |
Short: | Makes an object visible to the user. | |
|
Action: | Timer | ||
Short: | This action must be supported if the class requires regular timing messages. | ||
Arguments: |
| ||
|
Action: | Unlock | |
Short: | Unlocks an object's functionality. | |
|
Action: | UserClick | ||||||||
Short: | Used by drawable classes that need to respond to user clicks. | ||||||||
Arguments: |
| ||||||||
|
Action: | UserClickRelease | ||||||||||||||||
Short: | Used by drawable classes that need to respond to user click releases. | ||||||||||||||||
Arguments: |
| ||||||||||||||||
|
Action: | UserMovement | ||||||||||||||
Short: | Used for detecting and responding to user movement. | ||||||||||||||
Arguments: |
| ||||||||||||||
|
Action: | Write | ||||||
Short: | Used for writing raw data to an object. | ||||||
Arguments: |
| ||||||
|