C++ Syntax

__int32

MKI_InputPointInitProc(

__int32 f_nCommandID,

__int32 f_nPointIndex,

MKI_CONST_POINT_REF f_rPoint );

typedef __int32

(*MKI_INPUTPOINTINIT_PROC)(

__int32 f_nCommandID,

__int32 f_nPointIndex,

MKI_CONST_POINT_REF f_rPoint );

This procedure is called during the execution of an external command, i.e. a command that is handled by a plug-in.

Parameters

CommandID

[__int32] Identifier of the current command. Valid range: 0 <= Value < MKI_PLUGIN_MENU_MAX.

PointIndex

[__int32] Zero-based index of the point that is currently entered. Valid range: 0 <= Value < MKI_INPUT_MAX.

Point

[MKI_CONST_POINT_REF] Coordinates of the current mouse position in internal [mm] (relative to the page center, scale-independent).

Return Value

Should return one of the following values:

MKI_INPUT_OK

Point initialization successful, continue point entry.

MKI_INPUT_CANCEL

Cancel the complete command (usually due to user termination).

MKI_INPUT_NEXT

Continue immediately with the next point.

MKI_INPUT_FINISH

Finish the command (even though not all points have been entered!).

Comment

This procedure is called each time the entry of a point is initialized. At this time, the plug-in could initialize data required for further handling of this point input, or it can display a dialog window to allow the user to select parameters or a special way to continue.

If the command requires a variable number of points, this procedure must return MKI_INPUT_FINISH if the command shall be finished now. Returning MKI_INPUT_OK will continue with the next point entry.

The name MKI_InputPointInitProc is only a placeholder, the procedure may have any name.