LAnnotation::GetAutoSnapCursor

#include "ltwrappr.h"

L_INT LAnnotation::GetAutoSnapCursor(pbSnap)

L_BOOL *pbSnap;

/* pointer to a variable */

Gets the behavior of the cursor location when creating annotations using automation in design mode. This function is available in the Document/Medical Toolkits.

Parameter	Description
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

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.

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:	LAnnotation::SetAutoSnapCursor, LAnnAutomation::GetAutoCursor, LAnnotation::SetUserData, LAnnotation::GetUserData, LAnnAutomation::SetAutoCursor, LAnnContainer::RestrictCursor, LAnnotation::GetRestrictToContainer, LAnnotation::SetRestrictToContainer, LAnnotation::GetAutoBackColor, LAnnAutomation::GetAutoContainer, LAnnAutomation::GetAutoDialogFontSize, LAnnAutomation::IsAutoDrawEnabled, LAnnAutomation::IsAutoMenuEnabled, LAnnotation::GetAutoMenuItemEnable, LAnnotation::GetAutoMenuState, LAnnAutomation::GetAutoOptions, LAnnAutomation::GetAutoText, LAnnAutomation::GetAutoTextLen, LAnnAutomation::GetAutoUndoEnable, LAnnotation::SetAutoBackColor, LAnnAutomation::SetAutoContainer, LAnnotation::SetAutoDefaults, LAnnAutomation::SetAutoDialogFontSize, LAnnAutomation::SetAutoDrawEnabled, LAnnAutomation::SetAutoMenuEnabled, LAnnotation::SetAutoMenuItemEnable, LAnnotation::SetAutoMenuState, LAnnAutomation::SetAutoOptions, LAnnAutomation::SetAutoText, LAnnAutomation::SetAutoUndoEnable, LAnnotation::GetOptions, LAnnotation::SetOptions
Topics:	Displaying and Manipulating Annotation Objects
	Obtaining Annotation Object Information
	Annotation Functions: (Document/Medical only) Getting and Setting Cursor Properties
	Key Annotation Features

Example

For an example, refer to LAnnotation::SetAutoSnapCursor.