L_AnnSetPointerOptions

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetPointerOptions(hObject, pOptions, uFlags)

HANNOBJECT hObject;

handle to the annotation object

pANNPOINTEROPTIONS pOptions;

pointer to a structure that specifies pointer options

L_UINT uFlags;

flags that determine which objects to process

Sets the pointer options for the Pointer or Automation objects.

Parameter Description
hObject Handle to the annotation object.
pOptions Pointer to an ANNPOINTEROPTIONS structure that specifies the pointer options to set
uFlags Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( | ). Possible values are:
  Value Meaning
  0 Process only the specified object.
  ANNFLAG_SELECTED [0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the L_AnnGetSelected and L_AnnSetSelected functions.
  ANNFLAG_NOTTHIS [0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.
  ANNFLAG_RECURSE [0x0008] Process objects within a container, and within any subcontainers, down to any level.
  ANNFLAG_NOTCONTAINER [0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.
  ANNFLAG_NOINVALIDATE [0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To use this function, declare a variable of type ANNPOINTEROPTIONS, and pass the address of this variable to the pOptions parameter.

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

Win32, x64.

See Also

Functions:

L_AnnGetPointerOptions

Topics:

Annotation Functions: Object Properties

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

 

Implementing an Automated Annotation Program

 

Implementing a Non-automated Annotation Program

 

Altering Annotation Object Settings

Example

This example displays the existing ANNOJBECT_POINTER head settings, and then changes them so that the pointer head is larger than the default Note that by setting nPointerHeadM to 0, the pointer head size is independent of the line width.

L_INT AnnSetPointerOptionsExample(HANNOBJECT hObject) 
{ 
   L_INT nRet = TRUE; 
   ANNPOINTEROPTIONS options; 
 
   L_TCHAR szMsg[200]; 
 
   memset(&options, 0, sizeof(options)); 
   options.uStructSize = sizeof(options); 
   options.uFlags = ANNPOINTER_HEAD; 
   nRet = L_AnnGetPointerOptions (hObject, &options, sizeof(options)); 
   if (nRet!= SUCCESS) 
      return nRet; 
   wsprintf(szMsg, TEXT("Old Pointer Options: nPointerHeadM[%d] nPointerHeadB[%d]"), 
      options.nPointerHeadM, 
      options.nPointerHeadB); 
 
   MessageBox(NULL, szMsg, _T("Notice"), MB_OK); 
 
   // Change the pointer options 
   options.nPointerHeadM = 0; 
   options.nPointerHeadB = 10; 
 
   nRet = L_AnnSetPointerOptions(hObject, &options, 0); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   nRet = L_AnnGetPointerOptions (hObject, &options, sizeof(options)); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   wsprintf(szMsg, TEXT("New Pointer Options: nPointerHeadM[%d] nPointerHeadB[%d]"), 
      options.nPointerHeadM, 
      options.nPointerHeadB 
      ); 
    
   MessageBox(NULL, szMsg, _T("Notice"), MB_OK); 
   return nRet; 
} 

Help Version 20.0.2018.2.25
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help