LAnnContainer::SetSecondaryBitmap

#include "ltwrappr.h"

virtual L_INT LAnnContainer::SetSecondaryBitmap(pBitmap, uFlags)

virtual L_INT LAnnContainer::SetSecondaryBitmap(pBitmap, uFlags)

pBITMAPHANDLE pBitmap;

/* pointer to the bitmap handle */

LBitmapBase * pBitmap;

/* pointer to an LBitmapBase object */

L_UINT uFlags;

/* flags that determine the object to process */

Sets the secondary bitmap of the container object.

Parameter

Description

pBitmap

Pointer to the bitmap handle referencing the secondary bitmap to assign to the specified object.

pBitmap

Pointer to the bitmap object referencing the secondary bitmap object 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.

 

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

A container object has a primary bitmap, (manipulated using LAnnContainer::SetBitmap) when the text is shown, and a secondary bitmap, manipulated using LAnnContainer::SetSecondaryBitmap. 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 container object shows the text and displays the primary bitmap. In run mode, the object shows/hides the text when clicked. The container 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:

Class Members

Topics:

Annotation Functions: Object Properties

 

Using Annotation Bitmap Objects

Example

class LSecAnnContainer : public LAnnContainer
{
public:
   L_INT   m_nObjectCount ;
public:
   LSecAnnContainer(HANNOBJECT hAnnObject);
   virtual ~LSecAnnContainer() ;
   virtual L_INT EnumerateCallBack(HANNOBJECT hObject);
};
LSecAnnContainer::LSecAnnContainer(HANNOBJECT hAnnObject):LAnnContainer(hAnnObject)
{
   m_nObjectCount = 0 ;
}
LSecAnnContainer::~LSecAnnContainer()
{
}
L_INT LSecAnnContainer::EnumerateCallBack(HANNOBJECT hObject)
{
   BITMAPHANDLE   OldBitmap;
   BITMAPHANDLE   NewBitmap;
   L_INT          nRet;
   L_UINT         Type;
   Type = GetType();
   if(Type == ANNOBJECT_PUSHPIN)
   {
      LAnnPushPin MyAnnPushPin(hObject);
      nRet = MyAnnPushPin.GetSecondaryBitmap(&OldBitmap, sizeof(BITMAPHANDLE));
      if (nRet == SUCCESS)
      {
         MessageBox(NULL, TEXT("Secondary bitmap retrieved."), TEXT(""), MB_OK);
         nRet = MyAnnPushPin.GetBitmap(&NewBitmap, sizeof(BITMAPHANDLE));
         if(nRet != SUCCESS)
            return nRet;
         MyAnnPushPin.SetSecondaryBitmap(&NewBitmap, 0);
      }
      else
         MessageBox(NULL, TEXT("Error getting secondary bitmap."), TEXT(""), MB_OK);
   }
   else
      MessageBox(NULL, TEXT("Object must be a push pin."), TEXT(""), MB_OK);
   return SUCCESS;
}
L_INT LAnnContainer_SetSecondaryBitmapExample(LAnnContainer * pAnnContainer)
{
   L_INT nRet;
   LSecAnnContainer MyAnnContainer(pAnnContainer->GetHandle());
   nRet = MyAnnContainer.Load(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\Image2.cmp"));
   if(nRet != SUCCESS)
      return nRet;
   nRet = MyAnnContainer.Enumerate(ANNFLAG_RECURSE | ANNFLAG_NOTCONTAINER, 0);
   return nRet;
}