LAnnPushPin::SetBitmap

#include "ltwrappr.h"

virtual L_INT LAnnPushPin::SetBitmap(pBitmap, uFlags=0)

LBitmapBase * pBitmap;	/* pointer to an LBitmapBase object */
pBITMAPHANDLE pBitmap;	/* pointer to the bitmap handle */
L_UINT uFlags;	/* flags that determine the object to process */

Sets the bitmap of the annotation object.

Parameter	Description
pBitmap	Pointer to the bitmap object referencing the bitmap object to assign to the specified object.
pBitmap	Pointer to the bitmap handle referencing the bitmap to assign to the specified object.
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 LAnnotation::IsSelected and LAnnotation::SetSelected functions.
	ANNFLAG_NOINVALIDATE	[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Comments

A pushpin object has a primary bitmap, (manipulated using LAnnPushPin::SetBitmap/LAnnPushPin::GetBitmap) when the text is shown, and a secondary bitmap, manipulated using LAnnPushPin::SetSecondaryBitmap/LAnnPushPin::GetSecondaryBitmap. 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.

Returns

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

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:	Class Members
Topics:	Annotation Functions: Object Properties
	Using Annotation Bitmap Objects

Example

This is an example for both forms of LAnnPushPin::SetBitmap(pBitmap, uFlags=0):

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName
//This example sets the primary and secondary images of a pushpin
//The pushpin is displayed.  The image (primary or secondary) displayed
//depends on the state of the boolean 'm_bPrimary'
//***IMPORTANT: In the OnPaint(), add the following code:
//      RECT rect;
//      m_AnnContainer.GetBoundingRect(&rect) ;
//      HDC hdc = ::GetDC(m_hWnd);
//      m_AnnContainer.Draw(hdc,&rect);
//      ::ReleaseDC(m_hWnd, hdc);
LAnnContainer m_AnnContainer;
L_BOOL m_bPrimary;
L_INT LAnnPushPin_SetBitmapExample(HWND hWnd)
{
   LBitmap MyBitmap;
   ANNRECT annRect;
   LSettings::UnlockSupport(L_SUPPORT_DOCUMENT, L_KEY_DOCUMENT);
   LAnnPushPin *pMyAnnPushPin = new (LAnnPushPin);
   annRect.left = 50;
   annRect.top = 50;
   annRect.right = 170;
   annRect.bottom = 170;
   pMyAnnPushPin->SetRect(&annRect);
   pMyAnnPushPin->SetVisible(TRUE);
   //Set pushpin properties
   LBitmapBase MyBitmapBasePrimary;
   MyBitmapBasePrimary.Load(MAKE_IMAGE_PATH(TEXT("IMAGE1.CMP")));
   pMyAnnPushPin->SetBitmap(&MyBitmapBasePrimary,0);
   //or
   //pMyAnnPushPin->SetBitmap(MyBitmapBasePrimary.GetHandle(),0);
   LBitmapBase MyBitmapBaseSecondary;
   MyBitmapBaseSecondary.Load(MAKE_IMAGE_PATH(TEXT("IMAGE2.CMP")));
   pMyAnnPushPin->SetSecondaryBitmap(&MyBitmapBaseSecondary,0);
   //or
   //pMyAnnPushPin->SetSecondaryBitmap (MyBitmapBaseSecondary.GetHandle(),0);
   //Create container and insert annotation
   m_AnnContainer.Create(hWnd, &annRect, TRUE);
   m_AnnContainer.Insert(*pMyAnnPushPin);
   m_AnnContainer.SetUserMode(ANNUSER_RUN);
   if (m_bPrimary)
      //Draw pushpin with primary bitmap
      pMyAnnPushPin->SetActiveState(ANNACTIVE_ENABLED);
   else
      //Draw pushpin with secondary bitmap
      pMyAnnPushPin->SetActiveState (ANNACTIVE_DISABLED);
   return SUCCESS;
}