In This Topic ▼

LAnnotation::GetAutoSnapCursor

Summary

Gets the behavior of the cursor location when creating annotations using automation in design mode.

Syntax

#include "ltwrappr.h"

L_INT LAnnotation::GetAutoSnapCursor(pbSnap)

Parameters

L_BOOL *pbSnap

Pointer to a variable to be updated with a value that indicates whether or not to restrict the cursor location during annotation creation in design mode. Possible values are:

Value	Meaning
TRUE	The cursor location will snap to on or within the annotation container.
FALSE	The cursor location is not restricted.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function gets the automation cursor behavior when clicking outside the container. It has no effect on the behavior of the cursor when clicking inside the container. When creating annotations using automation in design mode, the user first chooses an annotation tool. Next the user clicks the mouse in the window containing the image, either on or outside the container (annotation image).

If cursor snapping is enabled and the user clicks outside the container as shown in this figure.

If cursor snapping is disabled and the user clicks outside the container but in the window, drawing of the annotation object begins with the annotation object outside of the container.

The default for behavior is to have cursor snapping enabled.