Symbian^3 Application Developer Library >

CAknsMaskedBitmapItemDef Class Reference

class CAknsMaskedBitmapItemDef : public CAknsBitmapItemDef

Masked bitmap item definition. Masked bitmap item definition is derived from CAknsBitmapItemDef but additionally contains a second index specifying the mask. Item type for masked bitmap item definitions is always EAknsITMaskedBitmap .

This is a public class with exported functions. The class is not intended for derivation outside the library.

AknSkinSrv.lib

Since
2.0

Inherits from

Public Member Functions
~CAknsMaskedBitmapItemDef ()
IMPORT_C TInt MaskIndex ()
IMPORT_C CAknsMaskedBitmapItemDef * NewL (const TAknsItemID &, const TDesC &, const TInt , const TInt )
IMPORT_C CAknsMaskedBitmapItemDef * NewL (const TAknsItemID &)
IMPORT_C void SetMaskIndex (const TInt )
Protected Member Functions
CAknsMaskedBitmapItemDef (const TAknsItemType , const TAknsItemID &, const TInt , const TInt )
Inherited Functions
CAknsBitmapItemDef::CAknsBitmapItemDef(const TAknsItemType,const TAknsItemID &,const TInt)
CAknsBitmapItemDef::Filename()const
CAknsBitmapItemDef::Index()const
CAknsBitmapItemDef::NewL(const TAknsItemID &,const TDesC &,const TInt)
CAknsBitmapItemDef::SetFilename(const TDesC &)
CAknsBitmapItemDef::SetFilenameL(const TDesC &)
CAknsBitmapItemDef::SetIndex(const TInt)
CAknsBitmapItemDef::~CAknsBitmapItemDef()
CAknsImageItemDef::Attributes()const
CAknsImageItemDef::CAknsImageItemDef(const TAknsItemType,const TAknsItemID &)
CAknsImageItemDef::SetAttributesL(const TAknsImageAttributeData &)
CAknsImageItemDef::~CAknsImageItemDef()
CAknsItemDef::CAknsItemDef(const TAknsItemType,const TAknsItemID &)
CAknsItemDef::ID()const
CAknsItemDef::LinearOrder(const CAknsItemDef &,const CAknsItemDef &)
CAknsItemDef::Type()const
CAknsItemDef::~CAknsItemDef()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Protected Attributes
TInt iMaskIndex
Inherited Attributes
CAknsBitmapItemDef::iFilename
CAknsBitmapItemDef::iFilenameBuf
CAknsBitmapItemDef::iIndex
CAknsImageItemDef::iAttributeData
CAknsItemDef::iID
CAknsItemDef::iSpare1
CAknsItemDef::iSpare2
CAknsItemDef::iType

Constructor & Destructor Documentation

CAknsMaskedBitmapItemDef(const TAknsItemType, const TAknsItemID &, const TInt, const TInt)

CAknsMaskedBitmapItemDef ( const TAknsItemType aType,
const TAknsItemID & aID,
const TInt aIndex,
const TInt aMaskIndex
) [protected]

C++ constructor for internal use. Constructs masked bitmap item definition object with given ID and bitmap indices. Filename needs to be set separately.

Parameters

const TAknsItemType aType Type of the definition object. While this is always EAknsITMaskedBitmap for CAknsMaskedBitmapItemDef objects, derived classes may specify other values.
const TAknsItemID & aID Item ID of the new item definition.
const TInt aIndex Index of the bitmap of the new item definition.
const TInt aMaskIndex Index of the bitmap mask of the new definition.

~CAknsMaskedBitmapItemDef()

~CAknsMaskedBitmapItemDef ( ) [virtual]

Destructor. Provided for completeness, does not actually do anything.

Member Functions Documentation

MaskIndex()

IMPORT_C TInt MaskIndex ( ) const

Returns bitmap file index for bitmap mask.

Since
2.0

NewL(const TAknsItemID &, const TDesC &, const TInt, const TInt)

IMPORT_C CAknsMaskedBitmapItemDef * NewL ( const TAknsItemID & aID,
const TDesC & aFilename,
const TInt aIndex,
const TInt aMaskIndex
) [static]

Two-phased constructor, complete initialization. Constructs a new masked bitmap item definition object.

Exceptions:
If allocation fails, function leaves with a system-wide error code.

Parameters

const TAknsItemID & aID Item ID of the new object.
const TDesC & aFilename Filename of the bitmap. Internal descriptor is constructed to point to the same data as the given one. Ownership of the original descriptor stays with the caller and it must ensure that the lifetime of the descriptor is appropriate.
const TInt aIndex Index of the bitmap in the bitmap file.
const TInt aMaskIndex Index of the mask in the same bitmap file.

NewL(const TAknsItemID &)

IMPORT_C CAknsMaskedBitmapItemDef * NewL ( const TAknsItemID & aID ) [static]

Two-phased constructor, partial initialization. Constructs a new masked bitmap item definition object. Bitmap filename and indices must be set by SetFilename or SetFilenameL, SetIndex and SetMaskIndex.

Exceptions:
If allocation fails, function leaves with a system-wide error code.

Parameters

const TAknsItemID & aID Item ID of the new object.

SetMaskIndex(const TInt)

IMPORT_C void SetMaskIndex ( const TInt aMaskIndex )

Sets index of mask in the bitmap file for this item definition.

Since
2.0

Parameters

const TInt aMaskIndex New index.

Member Data Documentation

TInt iMaskIndex

TInt iMaskIndex [protected]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.