#include "ltwrappr.h"

virtual L_INT LAnnContainer::RestrictCursor(lpRect, pPoint, prcOldClip, bRestrictClient)

LPRECT lpRect;

pointer to a RECT structure


pointer to a POINT structure

LPRECT prcOldClip;

pointer a RECT structure that contains the previous clip rectangle

L_BOOL bRestrictClient;

flag that specifies whether the cursor is restricted to the client window

Restricts the mouse cursor in conjunction with annotation objects.

Parameter Description
lpRect Pointer to a RECT structure that contains the rectangle within which the cursor is restricted.
pPoint Pointer to a POINT structure that contains the point around which the lpRect rectangle is centered.
prcOldClip Pointer to a RECT structure that contains the previous clip rectangle.
bRestrictClient Flag that specifies whether the cursor is restricted to the client window. Possible values are:
  Value Meaning
  TRUE Restrict the cursor to the client window.
  FALSE Do not restrict the cursor to the client window.



The function was successful.

< 1

An error occurred. Refer to Return Codes.


This function is used to restrict the mouse cursor. It should be used when creating custom annotation objects.

Calling this function always restricts the mouse cursor to the annotation container. However, depending on the arguments passed, the mouse cursor can be restricted further .

This function can be used in the following ways:


Required DLLs and Libraries


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


Win32, x64.

See Also


Class Members, LAnnotation::SetAutoSnapCursor, LAnnotation::GetAutoSnapCursor


Annotation Functions Realizing to a Bitmap


Annotation Functions: Implementing Custom Annotations


Annotation Functions: Creating Custom Annotations


Displaying and Manipulating Annotation Objects


// Example for LAnnContainer::Convert, LAnnContainer::RestrictCursor // This example restricts the cursor to 10 pixels on either side // of the bounding box of the annotation object. For example, // if the object is a rectangle, the mouse cursor will be restricted // to an area that is 10 pixels larger than the rectangle. 
L_INT LAnnContainer_RestrictCursorExample(LAnnContainer *pLContainer) 
   L_INT nRet; 
   L_UINT uType; 
   ANNRECT arcBounds; 
   RECT rcBounds; 
   HANNOBJECT hContainer; 
   RECT rcClipOld; 
   uType = pLContainer->GetType(); 
      nRet = pLContainer->GetTopContainer(&hContainer); 
      if(nRet != SUCCESS) 
         return nRet; 
      nRet = pLContainer->GetRect(&arcBounds, NULL); 
      if(nRet != SUCCESS) 
         return nRet; 
      nRet = pLContainer->Convert((LPPOINT)&rcBounds, (pANNPOINT)&arcBounds, 2, ANNCONVERT_TO_CLIENT); 
      if(nRet != SUCCESS) 
         return nRet; 
      rcBounds.left -= 10; -= 10; 
      rcBounds.right += 10; 
      rcBounds.bottom += 10; 
      nRet = pLContainer->RestrictCursor(&rcBounds,  NULL, &rcClipOld, FALSE); 
      if(nRet != SUCCESS) 
         return nRet; 
      // When done with restricting cursor, call the line below 
      // ClipCursor(&rcClipOld); 
      return FAILURE; 
   return SUCCESS; 

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C++ Class Library Help