IDLitManipulator::RegisterCursor

IDLitManipulator::RegisterCursor

The IDLitManipulator::RegisterCursor procedure method defines the appearance and name of a cursor associated with the manipulator.

Syntax

Obj->[IDLitManipulator::]RegisterCursor, ArrCursor, Name [, /DEFAULT]

Return Value

None

Arguments

ArrCursor

This must be a 16 element string array of 16 characters each that represents a window cursor. The array can consist of the "#" character, space and non-space characters, and optionally, a "$" character as follows:

The "#" characters define the black outline of the cursor.

Any non-space characters define the shape of the white mask. Adding a mask ensures the cursor's visibility in light and dark areas of a visualization.

The "$" defines a hot spot.

See CREATE_CURSOR for more information on the structure of the cursor array.

Name

A string value identifying the cursor.

Note

This name should be returned by the GetCursorType function method for your manipulator.

Keywords

DEFAULT

Set this keyword to specify this cursor as the default cursor for the manipulator. If no cursor is specified as the default cursor, then the standard arrow is used.

Note

This will be the cursor used if the GetCursorType method returns a null string.

Example

The RegisterCursor method is typically called within the scope of a manipulator's initialization so that the cursor appears when the manipulator (my_manip) is activated. The following code defines the appearance of the manipulator cursor and sets it as the default.

; Define the default cursor for this manipulation. 
strArray = [ $ 
      '                ', $ 
      '                ', $ 
      '                ', $ 
      '                ', $ 
      '                ', $ 
      '  .#.      .#.  ', $ 
      ' .#..........#. ', $ 
      '.##############.', $ 
      '###....$.....###', $ 
      '.##############.', $ 
      ' .#..........#. ', $ 
      '  .#.      .#.  ', $ 
      '                ', $ 
      '                ', $ 
      '                ', $ 
      '                '] 
 
; Register the new cursor with the manipulator. 
my_manip->RegisterCursor, strArray, 'SCROLL', /DEFAULT

Version History

Introduced: 6.1