LAnnContainer::GetFillMode

#include "ltwrappr.h"

virtual L_UINT LAnnContainer::GetFillMode(puFillMode, pnAlpha)

L_UINT * puFillMode;

/* pointer to a variable to be updated with the fill mode */

L_INT * pnAlpha;

/* pointer to a variable to be updated with the alpha value */

Gets the fill mode and alpha of the specified annotation object.

NOTE: THIS FUNCTION IS NOW INHERITED DIRECTLY FROM THE PARENT LANNOTATION CLASS.

Parameter

Description

puFillMode

Pointer to a variable to be updated with the object's fill mode constant. Possible fill mode values are:

 

Value

Meaning

 

ANNMODE_TRANSPARENT

[0] Transparent

 

ANNMODE_TRANSLUCENT

[1] Translucent

 

ANNMODE_OPAQUE

[2] Opaque

 

ANNMODE_ALPHA

[3] Alpha

pnAlpha

Pointer to a variable to be updated with the objects alpha value. This is only valid if the fill mode puFillMode is updated with is ANNMODE_ALPHA. Possible values range from 0 255 where:

 

Value

Meaning

 

0

Transparent background.

 

255

Opaque background.

Returns

The object's fill mode constant. Possible values are:

Value

Meaning

ANNMODE_TRANSPARENT

[0] Transparent

ANNMODE_TRANSLUCENT

[1] Translucent

ANNMODE_OPAQUE

[2] Opaque

Comments

To see the possible fill modes and patterns, refer to Illustration of Fill Options for Annotations.

Default is transparent.

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

Example

L_INT LAnnContainer_GetFillModeExample(LAnnContainer  * pAnnObject)
{
   L_INT nRet;
   L_UINT uFillMode; /* Object fill mode */
   /* Set the fill mode to transparent, unless it already is */
   nRet = pAnnObject->GetFillMode(&uFillMode, NULL);
   if (nRet != SUCCESS)
      return nRet;
   if (uFillMode == ANNMODE_TRANSPARENT)
      MessageBox (NULL, TEXT("Already transparent"), TEXT("Notice"), MB_OK);
   else
   {
      nRet = pAnnObject->SetFillMode(uFillMode, ANNMODE_TRANSPARENT, 0);
      if(nRet != SUCCESS)
         return nRet;
   }
   return SUCCESS;
}