IDLitManipulator::GetCursorType

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitManipulator::GetCursorType function method retrieves the name of the cursor to display for the manipulator. The name of the cursor can be used with the SetCurrentCursor method of the IDLitWindow component.

The system will use this method to automatically change the cursor when the mouse traverses the contents of a visualization window. As the mouse transverses the window, the name for the hit item that is part of the current selection group is retrieved and passed to this routine. This action gives the manipulator the ability to change cursors depending on the area of the visualization the cursor is over.

Syntax

Result = Obj->[IDLitManipulator::]GetCursorType(TypeIn, KeyMods)

Return Value

Returns a string containing the name of the cursor. If nothing is matched, an empty string is returned.

Note
This name is defined during cursor registration using the IDLitManipulator::RegisterCursor method.

Arguments

TypeIn

A string variable containing the name of the portion of the selection visual for which the cursor is being requested.

KeyMods

An integer representing the keyboard modifiers for the button. These can have one of the following values

1 = SHIFT Key

2 = CTRL Key

4 = CAPS LOCK key

8 = ALT key

Keywords

None

Version History