kCADEventIDSpecialClick - 4D CAD Reference

Next: kCADEventIDUndoRedo, Previous: kCADEventIDScroll, Up: Events

7.22 kCADEventIDSpecialClick

kCADEventPhaseDuring

Clicking with the mouse in Special click mode triggers a kCADEventIDSpecialClick event. Handling this event is left to the application, there is no default action.

IO Parameter Type Description
in theCADArea longint Area ID
in theEventID longint kCADEventIDSpecialClick
in theEventPhase longint kCADEventPhaseDuring
in theEventData1 longint Object ID clicked on, or 0
in theEventData2 longint kCADTrue if the click was within the drawing plane, kCADFalse if not
in theEventData3 longint kCADTrue if the mouse cursor is snapped, kCADFalse if not
in theEventData4 longint Target object scope, initially empty. If you add objects to this scope, they will be removed by a successive undo action
in theMouseX real Mouse X-coordinate, optionally snapped
in theMouseY real Mouse Y-coordinate, optionally snapped
in theEventValue1 real Unsnapped mouse X-coordinate
in theEventValue2 real Unsnapped mouse Y-coordinate
in theKeyAsciiValue integer 0
in theModifiers longint Sum of pressed modifier keys, a mask of modifier key constants (also see CADGetAreaPrefs and CADSetAreaPrefs)
in theTickCount longint Tick count of the system software (a tick is a 1/60th of a second)
out theEventResult longint Set to kCADEventResultTriggerUndoRedo to trigger an undo and redo. Set to kCADEventResultTriggerUndoOnly to trigger an undo only. Set to kCADEventResultTriggerNone to trigger nothing.
Set to kCADEventResultTriggerTrackObj, kCADEventResultTriggerTrackX, kCADEventResultTriggerTrackY or kCADEventResultTriggerTrackXY, to trigger kCADEventPhaseTrack event phases while the mouse button has not been released. Optionally add kCADEventResultTriggerIdle to also trigger kCADEventIDIdle events during the track.
The default undo action removes those objects that were added to the target object scope.

kCADEventPhaseTrack

kCADEventPhaseTrack events are triggered by the application in the kCADEventPhaseDuring phase above.

The application will continue to receive kCADEventPhaseTrack events until it cancels the track (by passing kCADEventResultDoFilter in theEventResult) or until the user releases the mouse button.

In both cases, one extra kCADEventPhaseTrack event will be generated, with theEventData4 set to kCADFalse, to finish the track.

IO	Parameter	Type	Description
in	`theCADArea`	`longint`	Area ID
in	`theEventID`	`longint`	`kCADEventIDSpecialClick`
in	`theEventPhase`	`longint`	`kCADEventPhaseDuring`
in	`theEventData1`	`longint`	Object ID clicked on, or 0
in	`theEventData2`	`longint`	`kCADTrue` if the click was within the drawing plane, `kCADFalse` if not
in	`theEventData3`	`longint`	`kCADTrue` if the mouse cursor is snapped, `kCADFalse` if not
in	`theEventData4`	`longint`	Target object scope, initially empty. If you add objects to this scope, they will be removed by a successive undo action
in	`theMouseX`	`real`	Mouse X-coordinate, optionally snapped
in	`theMouseY`	`real`	Mouse Y-coordinate, optionally snapped
in	`theEventValue1`	`real`	Unsnapped mouse X-coordinate
in	`theEventValue2`	`real`	Unsnapped mouse Y-coordinate
in	`theKeyAsciiValue`	`integer`	0
in	`theModifiers`	`longint`	Sum of pressed modifier keys, a mask of modifier key constants (also see `CADGetAreaPrefs` and `CADSetAreaPrefs`)
in	`theTickCount`	`longint`	Tick count of the system software (a tick is a 1/60th of a second)
out	`theEventResult`	`longint`	Set to `kCADEventResultTriggerUndoRedo` to trigger an undo and redo. Set to `kCADEventResultTriggerUndoOnly` to trigger an undo only. Set to `kCADEventResultTriggerNone` to trigger nothing. Set to `kCADEventResultTriggerTrackObj`, `kCADEventResultTriggerTrackX`, `kCADEventResultTriggerTrackY` or `kCADEventResultTriggerTrackXY`, to trigger `kCADEventPhaseTrack` event phases while the mouse button has not been released. Optionally add `kCADEventResultTriggerIdle` to also trigger `kCADEventIDIdle` events during the track. The default undo action removes those objects that were added to the target object scope.