L_AnnSetSecondaryBitmap

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnSetSecondaryBitmap(hObject, pBitmap, uFlags)

HANNOBJECT hObject;	/* handle to the annotation object */
pBITMAPHANDLE pBitmap;	/* pointer to a bitmap */
L_UINT uFlags;	/* flags that indicate which objects to process */

Sets the secondary bitmap used by the specified annotation object.

Parameter	Description
hObject	Handle to the annotation object.
pBitmap	Pointer to a bitmap handle that references the bitmap to be set as the secondary bitmap.
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 ( \| ). The following are valid values:
	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.
	ANNFLAG_CHECKMENU	[0x0020] Process objects only if the ANNAUTOTEXT_MENU_SECONDARYFILE menu item has been selected.

Returns

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

Comments

Only PushPin objects use a secondary bitmap.

A pushpin object has a primary bitmap, (manipulated using L_AnnSetBitmap/L_AnnGetBitmap) when the text is shown, and a secondary bitmap, changed using L_AnnSetSecondaryBitmap. The primary bitmap is shown with the note text. The secondary bitmap is shown by itself when the note is minimized.

In design mode, the PushPin object shows the text and displays the primary bitmap. In run mode, the object shows/hides the text when clicked. The pushpin object has the active mode property. When the mode is ANNACTIVE_ENABLED, the text is shown and the primary bitmap is painted in the top-left corner of the note.

When the mode is ANNACTIVE_DISABLED, the text is hidden and the secondary bitmap is displayed.

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_AnnGetSecondaryBitmap
Topics:	Annotation Functions: Object Properties
	Implementing an Automated Annotation Program
	Implementing a Non-automated Annotation Program
	Altering Annotation Object Settings
	Using Annotation Bitmap Objects
	Annotation Functions (Document/Medical only): Getting and Setting the Object Bitmap Property

Example

L_INT EXT_CALLBACK annSecondCallback(HANNOBJECT    hObject,
                                     pBITMAPHANDLE pBitmap)
{
   BITMAPHANDLE   OldBitmap;
   L_INT          nRet;
   L_UINT         Type;

   L_AnnGetType(hObject, &Type);
   switch(Type)
   {
   case ANNOBJECT_PUSHPIN:
      nRet = L_AnnGetSecondaryBitmap(hObject, &OldBitmap, sizeof(BITMAPHANDLE));
      if (nRet == SUCCESS)
      {
         MessageBox(NULL, TEXT("Secondary bitmap retrieved."), TEXT(""), MB_OK);
         L_AnnSetSecondaryBitmap(hObject, pBitmap, 0);
      }
      else
         MessageBox(NULL, TEXT("Error getting secondary bitmap."), TEXT(""), MB_OK);
      break;
   default:
      MessageBox(NULL, TEXT("Object must be a push pin."), TEXT(""), MB_OK);
   }
   return SUCCESS;
}

 L_INT  AnnSetSecondaryBitmapExample(HANNOBJECT hContainer)/* Container annotation object */
{
   L_INT nRet;
   BITMAPHANDLE NewBitmap;

   nRet = L_LoadBitmap( MAKE_IMAGE_PATH(TEXT("Image2.cmp")), &NewBitmap, sizeof(BITMAPHANDLE), 0,ORDER_BGR, 0, NULL);
   if(nRet != SUCCESS)
      return nRet;

   nRet = L_AnnEnumerate(hContainer, (ANNENUMCALLBACK)annSecondCallback, &NewBitmap, ANNFLAG_RECURSE | ANNFLAG_NOTCONTAINER, 0);
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}