Symbian^3 Application Developer Library >

CPbk2IconInfo Class Reference

class CPbk2IconInfo : public CBase

Phonebook 2 icon information. Responsible for reading the icon information from a PBK2_ICON_INFO resource structure.

Inherits from

Public Member Functions
~CPbk2IconInfo ()
TAknsItemID ColorId ()
TInt ColorIndex ()
TInt DefaultColorIndex ()
const CFbsBitmap * ExternalBitmap ()
TSize ExternalIconSize ()
const CFbsBitmap * ExternalMask ()
TInt IconId ()
TBool IsIconExternal ()
TInt MaskId ()
const TDesC & MbmFileName ()
CPbk2IconInfo * NewLC ( TResourceReader &, CDesCArray &)
IMPORT_C CPbk2IconInfo * NewLC ( TPbk2IconId , const CFbsBitmap *, const CFbsBitmap *, const TSize )
IMPORT_C CPbk2IconInfo * NewLC ( TPbk2IconId , TInt , TInt , TPtrC , TAknsItemID , TAknsItemID , TInt , TInt )
const TPbk2IconId & Pbk2IconId ()
TAknsItemID SkinId ()
Private Member Functions
CPbk2IconInfo ()
CPbk2IconInfo ( TPbk2IconId , TInt , TInt , TPtrC , TAknsItemID , TAknsItemID , TInt , TInt )
CPbk2IconInfo ( TPbk2IconId , const CFbsBitmap *, const CFbsBitmap *, const TSize )
void ConstructL ( TResourceReader &, CDesCArray &)
Inherited Functions
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()
Private Attributes
TAknsItemID iColorId
TInt iColorIndex
TInt iDefaultColorIndex
const CFbsBitmap * iExternalBitmap
TBool iExternalBitmaps
TSize iExternalIconSize
const CFbsBitmap * iExternalMask
TInt iIconId
TInt iMaskId
TPtrC iMbmFileName
TPbk2IconId iPbk2IconId
TAknsItemID iSkinId

Constructor & Destructor Documentation

CPbk2IconInfo()

CPbk2IconInfo ( ) [private]

CPbk2IconInfo(TPbk2IconId, TInt, TInt, TPtrC, TAknsItemID, TAknsItemID, TInt, TInt)

CPbk2IconInfo ( TPbk2IconId aPbk2IconId,
TInt aIconId,
TInt aMaskId,
TPtrC aMbmFileName,
TAknsItemID aSkinId,
TAknsItemID aColorId,
TInt aColorIndex,
TInt aDefaultColorIndex
) [private]

Parameters

TPbk2IconId aPbk2IconId
TInt aIconId
TInt aMaskId
TPtrC aMbmFileName
TAknsItemID aSkinId
TAknsItemID aColorId
TInt aColorIndex
TInt aDefaultColorIndex

CPbk2IconInfo(TPbk2IconId, const CFbsBitmap *, const CFbsBitmap *, const TSize)

CPbk2IconInfo ( TPbk2IconId aPbk2IconId,
const CFbsBitmap * aBitmap,
const CFbsBitmap * aMask,
const TSize aSize
) [private]

Parameters

TPbk2IconId aPbk2IconId
const CFbsBitmap * aBitmap
const CFbsBitmap * aMask
const TSize aSize

~CPbk2IconInfo()

~CPbk2IconInfo ( )

Destructor.

Member Functions Documentation

ColorId()

TAknsItemID ColorId ( ) const

Returns this icon's color table id.

ColorIndex()

TInt ColorIndex ( ) const

Returns this icon's index in the color table.

ConstructL(TResourceReader &, CDesCArray &)

void ConstructL ( TResourceReader & aReader,
CDesCArray & aMbmFileNames
) [private]

Parameters

TResourceReader & aReader
CDesCArray & aMbmFileNames

DefaultColorIndex()

TInt DefaultColorIndex ( ) const

Returns this icon default color index. TRgb value can be retrieved using AKN_LAF_COLOR_STATIC macro.

ExternalBitmap()

const CFbsBitmap * ExternalBitmap ( ) const

Returns external bitmap. This is used when icon is provided by an external provider (e.g a branding package).

ExternalIconSize()

TSize ExternalIconSize ( ) const

Returns external icon size. This is used when icon is provided by an external provider (e.g a branding package).

ExternalMask()

const CFbsBitmap * ExternalMask ( ) const

Returns external bitmap mask. This is used when icon is provided by an external provider (e.g a branding package).

IconId()

TInt IconId ( ) const

Returns this icon's id in the bitmap file.

IsIconExternal()

TBool IsIconExternal ( ) const

Check if icon is not own.

MaskId()

TInt MaskId ( ) const

Returns this icon's mask id in the bitmap file.

MbmFileName()

const TDesC & MbmFileName ( ) const

Returns the bitmap file name of this icon.

NewLC(TResourceReader &, CDesCArray &)

CPbk2IconInfo * NewLC ( TResourceReader & aReader,
CDesCArray & aMbmFileNames
) [static]

Creates a new instance of this class.

Parameters

TResourceReader & aReader Resource reader pointed to a PBK2_ICON_INFO resource.
CDesCArray & aMbmFileNames Descriptor array for bitmap file names.

NewLC(TPbk2IconId, const CFbsBitmap *, const CFbsBitmap *, const TSize)

IMPORT_C CPbk2IconInfo * NewLC ( TPbk2IconId aPbk2IconId,
const CFbsBitmap * aBitmap,
const CFbsBitmap * aMask,
const TSize aSize
) [static]

Creates a new instance of this class.

Parameters

TPbk2IconId aPbk2IconId Phonebook icon id.
const CFbsBitmap * aBitmap Bitmap.
const CFbsBitmap * aMask Mask.
const TSize aSize Size to use.

NewLC(TPbk2IconId, TInt, TInt, TPtrC, TAknsItemID, TAknsItemID, TInt, TInt)

IMPORT_C CPbk2IconInfo * NewLC ( TPbk2IconId aPbk2IconId,
TInt aIconId,
TInt aMaskId,
TPtrC aMbmFileName,
TAknsItemID aSkinId,
TAknsItemID aColorId,
TInt aColorIndex,
TInt aDefaultColorIndex
) [static]

Creates a new instance of this class.

Parameters

TPbk2IconId aPbk2IconId Phonebook icon id.
TInt aIconId Icon bitmap id.
TInt aMaskId Mask bitmap id.
TPtrC aMbmFileName Mbm file name.
TAknsItemID aSkinId Skin id.
TAknsItemID aColorId skin color table id.
TInt aColorIndex Index of the icon color in color table.
TInt aDefaultColorIndex Index of the default color.

Pbk2IconId()

const TPbk2IconId & Pbk2IconId ( ) const

Returns the unique Phonebook 2 icon id of this icon.

SkinId()

TAknsItemID SkinId ( ) const

Returns this icon's skin id.

Member Data Documentation

TAknsItemID iColorId

TAknsItemID iColorId [private]

TInt iColorIndex

TInt iColorIndex [private]

TInt iDefaultColorIndex

TInt iDefaultColorIndex [private]

const CFbsBitmap * iExternalBitmap

const CFbsBitmap * iExternalBitmap [private]

TBool iExternalBitmaps

TBool iExternalBitmaps [private]

TSize iExternalIconSize

TSize iExternalIconSize [private]

const CFbsBitmap * iExternalMask

const CFbsBitmap * iExternalMask [private]

TInt iIconId

TInt iIconId [private]

TInt iMaskId

TInt iMaskId [private]

TPtrC iMbmFileName

TPtrC iMbmFileName [private]

TPbk2IconId iPbk2IconId

TPbk2IconId iPbk2IconId [private]

TAknsItemID iSkinId

TAknsItemID iSkinId [private]

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.