L_AnnGetAutoSnapCursor

#include "l_bitmap.h"

EXT_FUNCTION L_AnnGetAutoSnapCursor(hAutomation, L_BOOL *pbSnap)

HANNOBJECT hAutomation;	/* handle to the automation annotation object */
L_BOOL *pbSnap;	/* pointer to a variable */

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

Parameter	Description
hAutomation	Handle to the automation annotation object.
pbSnap	Pointer to a variable to be updated with a value that indicates whether 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 the cursor will "snap" to the container border, as shown in the following figure):

$image\L_AnnSetAutoSnapCursor.gif$

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.

Platforms

Windows 95 / 98 / Me, Windows 2000 / XP.

See Also

Functions:	L_AnnSetAutoSnapCursor, L_AnnGetAutoCursor, L_AnnSetUserData, L_AnnGetUserData, L_AnnSetAutoCursor, L_AnnRestrictCursor, L_AnnGetRestrictToContainer, L_AnnSetRestrictToContainer, L_AnnSetUserData, L_AnnGetUserData, L_AnnSetAutoCursor, L_AnnRestrictCursor, L_AnnGetRestrictToContainer, L_AnnSetRestrictToContainer, L_AnnGetAutoBackColor, L_AnnGetAutoContainer, L_AnnGetAutoDialogFontSize, L_AnnGetAutoDrawEnable, L_AnnGetAutoMenuEnable, L_AnnGetAutoMenuItemEnable, L_AnnGetAutoMenuState, L_AnnGetAutoOptions, L_AnnGetAutoText, L_AnnGetAutoTextLen, L_AnnGetAutoUndoEnable, L_AnnSetAutoBackColor, L_AnnSetAutoContainer, L_AnnSetAutoDefaults, L_AnnSetAutoDialogFontSize, L_AnnSetAutoDrawEnable, L_AnnSetAutoMenuEnable, L_AnnSetAutoMenuItemEnable, L_AnnSetAutoMenuState, L_AnnSetAutoOptions, L_AnnSetAutoText, L_AnnSetAutoUndoEnable
Topics:	Displaying and Manipulating Annotation Objects
	Altering Annotation Object Settings
	Obtaining Annotation Object Information
	Annotation Functions: Implementing Automation

Example

For an example, refer to L_AnnSetAutoSnapCursor.