Name: | Pointer |
Version: | 1.0 |
ID: | ID_POINTER |
Status: | Unspecified |
Category: | Graphics |
Date: | July 2004 |
Author: | Rocklyte Systems |
Copyright: | Rocklyte Systems (c) 1998-2004. All rights reserved. |
Short: | Used to support mouse pointers. |
The Pointer class is used to provide the computer user with a means of interacting with the graphical interface. Traditionally the pointer is controlled by an attached mouse device, but the use of a keyboard, joystick or other device is acceptable. The pointer class operates in 3 dimensions (X, Y, Z) and the Z axis is typically controlled by a mouse wheel.
A pointer object should usually be created at boot-up unless you don't want a pointer in your system (e.g. for keyboard-only input). Not creating a pointer will also mean that the system will not support user-click and user-movement management, unless you have some other means of achieving this. It is recommended that when creating a pointer at boot-up you give it a name of "SystemPointer". This is a system-wide standard that makes it easier for other objects to find the pointing device. If you give it a different name then the pointer will effectively be hidden from other objects.
The Pointer class manages action-events such as UserMovement, UserClick and UserClickRelease. These actions are called and passed to other objects on the desktop as appropriate.
The Pointer class supports the following actions:
DataChannel This action can be used to send fake input to a pointer object. Hide Hides the pointer from the display. Move Moves the position of a pointer to a new location. MoveToPoint Moves the position of a pointer to a new location. Reset Resets the pointer settings back to the default. SaveToObject Saves the current pointer settings to another object. Show Shows the pointer if it is not already on the display. UserClick Customised click messages can be passed to the pointer through this action.
The Pointer class implements the following methods:
HardwareCursor Enables the hardware cursor if the software cursor is currently active. SoftwareCursor Forces use of the software cursor instead of the hardware cursor.
The Pointer object consists of the following public fields:
ButtonOrder Defines the order in which mouse buttons are interpreted. ButtonState Indicates the current button-press state. Cursor Sets the pointer image, selected from the pre-defined graphics bank. Input Declares the I/O object to read movement from. MaxSpeed Restricts the maximum speed of a pointer's movement. OverObject Readable field that gives the ID of the object under the pointer. OverX The horizontal position of the Pointer with respect to the object underneath the hot-spot. OverY The vertical position of the Pointer with respect to the object underneath the hot-spot. OverZ The position of the Pointer within an object. Speed Speed multiplier for Pointer movement. Theme The pointer graphics theme is defined in this field. XCoord Defines the horizontal position of the Pointer within its master container. YCoord Defines the vertical position of the Pointer within its master container. ZCoord Defines the depth-based position of the Pointer within its master container.
Action: | Move | |
Short: | Moves the position of a pointer to a new location. | |
|
Action: | MoveToPoint | |
Short: | Moves the position of a pointer to a new location. | |
|
Method: | SoftwareCursor() | |
Short: | Forces use of the software cursor instead of the hardware cursor. | |
|
Field: | ButtonOrder | |
Short: | Defines the order in which mouse buttons are interpreted. | |
Type: | STRING | |
Status: | Get/Set | |
|
Field: | ButtonState | |
Short: | Indicates the current button-press state. | |
Type: | LONG | |
Status: | Get | |
|
Field: | Cursor | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Short: | Sets the pointer image, selected from the pre-defined graphics bank. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Type: | LONG | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Prefix: | PTR | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Status: | Read/Init | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Field: | Input | |
Short: | Declares the I/O object to read movement from. | |
Type: | OBJECTID | |
Status: | Init | |
|
Field: | MaxSpeed | |
Short: | Restricts the maximum speed of a pointer's movement. | |
Type: | LONG | |
Status: | Read/Write | |
|
Field: | OverObject | |
Short: | Readable field that gives the ID of the object under the pointer. | |
Type: | OBJECTID | |
Status: | Read | |
|
Field: | OverX | |
Short: | The horizontal position of the Pointer with respect to the object underneath the hot-spot. | |
Type: | LONG | |
Status: | Read | |
|
Field: | OverY | |
Short: | The vertical position of the Pointer with respect to the object underneath the hot-spot. | |
Type: | LONG | |
Status: | Read | |
|
Field: | OverZ | |
Short: | The position of the Pointer within an object. | |
Type: | LONG | |
Status: | Read Only | |
|
Field: | Speed | |
Short: | Speed multiplier for Pointer movement. | |
Type: | LONG | |
Status: | Read/Write | |
|
Field: | Theme | |
Short: | The pointer graphics theme is defined in this field. | |
Type: | STRING | |
Status: | Get/Set | |
|
Field: | XCoord | |
Short: | Defines the horizontal position of the Pointer within its master container. | |
Type: | LONG | |
Status: | Read/Write | |
|
Field: | YCoord | |
Short: | Defines the vertical position of the Pointer within its master container. | |
Type: | LONG | |
Status: | Read/Write | |
|
Field: | ZCoord | |
Short: | Defines the depth-based position of the Pointer within its master container. | |
Type: | LONG | |
Status: | Read | |
|