IDLitManipulator::OnMouseDown

Syntax | Arguments | Keywords | Version History

The IDLitManipulator::OnMouseDown procedure method is used when a mouse down event occurs on the target IDLitWindow. When applied, this method will perform a select operation on the current contents of the target IDLitWindow.

When overriding this method in a sub-class, this method is normally the first task performed so that the instance data of the object is properly setup.

If the manipulator is in the middle of a mouse-down, mouse-up transaction, the following instance data will be valid:

ButtonPress — Set to the mouse buttons pressed.

nSelectionList — The number of items selected.

pSelectionList — A pointer to the objects current selected in the iTool.

These values can be helpful in performing actions in the manipulator and are automatically managed. See Using Manipulator Public Instance Data (iTool Developer's Guide) for more information.

Syntax

Obj->[IDLitManipulator::]OnMouseDown, Win, X, Y, IButton, KeyMods, NClicks

Arguments

Win

An object reference for the IDLitWindow from which the event came.

X

A floating-point value representing the x-coordinate in the window's coordinates.

Y

A floating-point value representing the y-coordinate in the window's coordinates.

IButton

An integer value representing the mask for the button pressed:

1 = Left

2 = Middle

4 = Right

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

NClicks

An integer value representing number of clicks

Keywords

None

Version History


6.0	Introduced