Collapse all Symbian^3 Product Developer Library

CAknIconManager Class Reference

class CAknIconManager : public CBase

Inherits from

CAknIconManager
- CBase

Public Member Functions
	~CAknIconManager()
TInt	BitmapId()
TInt	Check(const TSize &, TScaleMode, TInt)
void	DestroyIconData()
void	DisableCompression()
void	ExcludeFromCache()
TInt	GetContentDimensions(TAknContentDimensions &)
void	GetFileName(TDes &)
void	GetFullFileName(TDes &)
void	GetFullMifFileName(TDes &)
TRgb	GetIconColor()
void	GetInitializedParams(TAknIconParams &)
TInt	IconIdToIndex(TInt)
TInt	InitializeIcon(const TSize &, TScaleMode)
TInt	InitializeIcon(const TSize &, TScaleMode, TInt)
TBool	IsCompressionDisabled()
TBool	IsDefaultIconDirUsed()
TBool	IsExcludedFromCache()
TBool	IsMbmIcon()
TInt	MaskId()
CAknIconManager *	NewL(const TDesC &, const TInt16, const TInt16)
void	PreinitializeIconL()
void	PreserveIconData()
void	Ref()
TInt	ScaleMode()
void	SetBitmap(CAknBitmap *)
void	SetDefaultIconDirUsed()
void	SetIconColor(const TRgb)
void	SetInitializedParams(const TAknIconParams &)
void	SetMask(CAknBitmap *)
void	SetObserver(MAknIconObserver *)
void	Unref(const CAknBitmap &)

Protected Member Functions
	CAknIconManager()
void	ClearDisableCompressionCleanUp()
void	ClearIconDataPreserved()
TBool	GetAppIcon()
void	InitIconFileNameL(const TDesC &)
TBool	IsAnimated()
TBool	IsAppIcon()
TBool	IsCompressionDisabledCleanUp()
TBool	IsFileExtRemoved()
TBool	IsIconDataPreserved()
void	ReleaseFileHandle()
void	SetAnimated()
void	SetAppIcon(TBool)
void	SetDisableCompressionCleanUp()
void	SetFileExtRemoved()
void	SetIconDataPreserved()

Private Member Functions
void	AppendFileExtension(TDes &)
void	BitmapChanged()
void	ChangeFileExtension(TDes &)
void	CleanupReleaseFileHandle(TAny *)
void	ConstructL(const TDesC &, const TInt16, const TInt16)
void	DeleteIconFormatHandler()
void	DoInitializeIconL(const TSize &, TScaleMode, TInt)
RFile *	FileHandleL(MAknIconFileProvider::TIconFileType)
RFile *	FileHandleL()
void	GetContentDimensionsL(TAknContentDimensions &)
void	HandleError(TInt)
TBool	HasValidFileExtension(const TDesC &)
void	InitializeAnimatedIconL(const TAknIconParams &)
void	InitializeIconL(const TSize &, TScaleMode, TInt)
void	LoadBitmapIconL()
void	LoadIconLocationInfoL(const TDesC &)
void	LoadIfBitmapIconL()
void	PrepareAnimatedIconL(TBool)
CAknIconLoader *	PrepareAnimatedIconLC()
void	RetrieveIconLocationInfoL()

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()

Protected Member Enumerations
enum	TFlags { EFlagUsesDefaultIconDir = 0x0001, EFlagIconDataPreserved = 0x0002, EFlagAnimated = 0x0004, EFlagFileExtRemoved = 0x0008, EFlagExcludeFromCache = 0x0010, EFlagDisableCompression = 0x0020, EFlagDisableCompressionCleanUp = 0x0040 }

Protected Attributes
TBool	iAppIcon
CAknBitmap *	iBitmap
TInt16	iBitmapId
TRgb	iColor
TAknContentDimensions	iContentDimensions
HBufC *	iFileName
TInt	iFlags
MAknIconFormatHandler *	iHandler
TInt	iInitializedAngle
TRgb	iInitializedColor
TInt	iInitializedMode
TSize	iInitializedSize
TSize	iLoadedSize
CAknBitmap *	iMask
TInt16	iMaskId
MAknIconObserver *	iObserver
TInt16	iOriginalMaskId
TInt	iRefCount

Constructor & Destructor Documentation

CAknIconManager()

CAknIconManager

(

)

[protected]

C++ default constructor.

~CAknIconManager()

~CAknIconManager

(

)

Destructor.

Member Functions Documentation

AppendFileExtension(TDes &)

void

AppendFileExtension

(

TDes &

aFileName

)

const [private]

Parameters

TDes & aFileName

BitmapChanged()

void

BitmapChanged

(

)

[private]

BitmapId()

TInt

BitmapId

(

)

const [inline]

ChangeFileExtension(TDes &)

void

ChangeFileExtension

(

TDes &

aFileName

)

const [private]

Parameters

TDes & aFileName

Check(const TSize &, TScaleMode, TInt)

TInt	Check	(	const TSize &	aSize,
			TScaleMode	aMode,
			TInt	aAngle = 0
		)

Parameters

const TSize & aSize
TScaleMode aMode
TInt aAngle = 0

CleanupReleaseFileHandle(TAny *)

void

CleanupReleaseFileHandle

(

TAny *

aParam

)

[private, static]

Cleanup function that calls ReleaseFileHandle.

Parameters

TAny * aParam

ClearDisableCompressionCleanUp()

void

ClearDisableCompressionCleanUp

(

)

[protected, inline]

ClearIconDataPreserved()

void

ClearIconDataPreserved

(

)

[protected, inline]

ConstructL(const TDesC &, const TInt16, const TInt16)

void	ConstructL	(	const TDesC &	aFileName,
			const TInt16	aBitmapId,
			const TInt16	aMaskId
		)	[private]

2nd phase constructor.

Parameters

const TDesC & aFileName
const TInt16 aBitmapId
const TInt16 aMaskId

DeleteIconFormatHandler()

void

DeleteIconFormatHandler

(

)

[private, inline]

DestroyIconData()

void

DestroyIconData

(

)

DisableCompression()

void

DisableCompression

(

)

[inline]

DoInitializeIconL(const TSize &, TScaleMode, TInt)

void	DoInitializeIconL	(	const TSize &	aSize,
			TScaleMode	aMode,
			TInt	aAngle
		)	[private, virtual]

Initializes the icon with the given parameters.

Parameters

const TSize & aSize
TScaleMode aMode
TInt aAngle

ExcludeFromCache()

void

ExcludeFromCache

(

)

[inline]

FileHandleL(MAknIconFileProvider::TIconFileType)

RFile *

FileHandleL

(

MAknIconFileProvider::TIconFileType

aType

)

[private, virtual]

Returns opened file handle to the icon file, if such is supplied by the client.

Parameters

MAknIconFileProvider::TIconFileType aType

FileHandleL()

RFile *

FileHandleL

(

)

[private]

GetAppIcon()

TBool

GetAppIcon

(

)

const [protected, inline]

GetContentDimensions(TAknContentDimensions &)

TInt

GetContentDimensions

(

TAknContentDimensions &

aContentDimensions

)

Parameters

TAknContentDimensions & aContentDimensions

GetContentDimensionsL(TAknContentDimensions &)

void

GetContentDimensionsL

(

TAknContentDimensions &

aContentDimensions

)

[private]

Parameters

TAknContentDimensions & aContentDimensions

GetFileName(TDes &)

void

GetFileName

(

TDes &

aFileName

)

const

Parameters

TDes & aFileName

GetFullFileName(TDes &)

void

GetFullFileName

(

TDes &

aFileName

)

const

Parameters

TDes & aFileName

GetFullMifFileName(TDes &)

void

GetFullMifFileName

(

TDes &

aFileName

)

const

Parameters

TDes & aFileName

GetIconColor()

TRgb

GetIconColor

(

)

const

GetInitializedParams(TAknIconParams &)

void

GetInitializedParams

(

TAknIconParams &

aInfo

)

const [inline]

Parameters

TAknIconParams & aInfo

HandleError(TInt)

void

HandleError

(

TInt

aError

)

[private]

Parameters

TInt aError

HasValidFileExtension(const TDesC &)

TBool

HasValidFileExtension

(

const TDesC &

aFileName

)

const [private, inline]

Parameters

const TDesC & aFileName

IconIdToIndex(TInt)

TInt

IconIdToIndex

(

TInt

aId

)

const

Parameters

TInt aId

InitIconFileNameL(const TDesC &)

void

InitIconFileNameL

(

const TDesC &

aFileName

)

[protected]

Parameters

const TDesC & aFileName

InitializeAnimatedIconL(const TAknIconParams &)

void

InitializeAnimatedIconL

(

const TAknIconParams &

aInfo

)

[private]

Parameters

const TAknIconParams & aInfo

InitializeIcon(const TSize &, TScaleMode)

TInt	InitializeIcon	(	const TSize &	aSize,
			TScaleMode	aMode
		)

Parameters

const TSize & aSize
TScaleMode aMode

InitializeIcon(const TSize &, TScaleMode, TInt)

TInt	InitializeIcon	(	const TSize &	aSize,
			TScaleMode	aMode,
			TInt	aAngle
		)

Parameters

const TSize & aSize
TScaleMode aMode
TInt aAngle

InitializeIconL(const TSize &, TScaleMode, TInt)

void	InitializeIconL	(	const TSize &	aSize,
			TScaleMode	aMode,
			TInt	aAngle
		)	[private]

Checks if the icon is already initialized with the given parameters, and if not, initializes it.

Parameters

const TSize & aSize
TScaleMode aMode
TInt aAngle

IsAnimated()

TBool

IsAnimated

(

)

const [protected, inline]

IsAppIcon()

TBool

IsAppIcon

(

)

const [protected, inline]

IsCompressionDisabled()

TBool

IsCompressionDisabled

(

)

const [inline]

IsCompressionDisabledCleanUp()

TBool

IsCompressionDisabledCleanUp

(

)

const [protected, inline]

IsDefaultIconDirUsed()

TBool

IsDefaultIconDirUsed

(

)

const [inline]

IsExcludedFromCache()

TBool

IsExcludedFromCache

(

)

const [inline]

IsFileExtRemoved()

TBool

IsFileExtRemoved

(

)

const [protected, inline]

IsIconDataPreserved()

TBool

IsIconDataPreserved

(

)

const [protected, inline]

IsMbmIcon()

TBool

IsMbmIcon

(

)

const

LoadBitmapIconL()

void

LoadBitmapIconL

(

)

[private, virtual]

Loads a bitmap icon.

LoadIconLocationInfoL(const TDesC &)

void

LoadIconLocationInfoL

(

const TDesC &

aFileName

)

[private]

Parameters

const TDesC & aFileName

LoadIfBitmapIconL()

void

LoadIfBitmapIconL

(

)

[private]

Loads icon from MBM file if it is a bitmap icon.

MaskId()

TInt

MaskId

(

)

const [inline]

NewL(const TDesC &, const TInt16, const TInt16)

CAknIconManager *	NewL	(	const TDesC &	aFileName,
			const TInt16	aBitmapId,
			const TInt16	aMaskId
		)	[static]

Parameters

const TDesC & aFileName
const TInt16 aBitmapId
const TInt16 aMaskId

PreinitializeIconL()

void

PreinitializeIconL

(

)

Loads MBM icons. Sets MIF icon handles to valid empty CFbsBitmap handles.

PrepareAnimatedIconL(TBool)

void

PrepareAnimatedIconL

(

TBool

bAnimationReady = EFalse

)

[private]

Parameters

TBool bAnimationReady = EFalse

PrepareAnimatedIconLC()

CAknIconLoader *

PrepareAnimatedIconLC

(

)

[private]

PreserveIconData()

void

PreserveIconData

(

)

Ref()

void

Ref

(

)

ReleaseFileHandle()

void

ReleaseFileHandle

(

)

[protected, virtual]

This is called, when the file handle is no longer required, and should be closed.

RetrieveIconLocationInfoL()

void

RetrieveIconLocationInfoL

(

)

[private]

ScaleMode()

TInt

ScaleMode

(

)

const

SetAnimated()

void

SetAnimated

(

)

[protected, inline]

SetAppIcon(TBool)

void

SetAppIcon

(

TBool

aAppIcon

)

[protected, inline]

Parameters

TBool aAppIcon

SetBitmap(CAknBitmap *)

void

SetBitmap

(

CAknBitmap *

aBitmap

)

Parameters

CAknBitmap * aBitmap

SetDefaultIconDirUsed()

void

SetDefaultIconDirUsed

(

)

[inline]

SetDisableCompressionCleanUp()

void

SetDisableCompressionCleanUp

(

)

[protected, inline]

SetFileExtRemoved()

void

SetFileExtRemoved

(

)

[protected, inline]

SetIconColor(const TRgb)

void

SetIconColor

(

const TRgb

aColor

)

Parameters

const TRgb aColor

SetIconDataPreserved()

void

SetIconDataPreserved

(

)

[protected, inline]

SetInitializedParams(const TAknIconParams &)

void

SetInitializedParams

(

const TAknIconParams &

aInfo

)

[inline]

Parameters

const TAknIconParams & aInfo

SetMask(CAknBitmap *)

void

SetMask

(

CAknBitmap *

aMask

)

Parameters

CAknBitmap * aMask

SetObserver(MAknIconObserver *)

void

SetObserver

(

MAknIconObserver *

aObserver

)

Parameters

MAknIconObserver * aObserver

Unref(const CAknBitmap &)

void

Unref

(

const CAknBitmap &

aBitmap

)

Parameters

const CAknBitmap & aBitmap

Member Enumerations Documentation

Enum TFlags

Enumerators

EFlagUsesDefaultIconDir = 0x0001
EFlagIconDataPreserved = 0x0002
EFlagAnimated = 0x0004
EFlagFileExtRemoved = 0x0008
EFlagExcludeFromCache = 0x0010
EFlagDisableCompression = 0x0020
EFlagDisableCompressionCleanUp = 0x0040

Member Data Documentation

TBool iAppIcon

TBool

iAppIcon

[protected]

CAknBitmap * iBitmap

CAknBitmap *

iBitmap

[protected]

TInt16 iBitmapId

TInt16

iBitmapId

[protected]

TRgb iColor

TRgb

iColor

[protected]

TAknContentDimensions iContentDimensions

TAknContentDimensions

iContentDimensions

[protected]

HBufC * iFileName

HBufC *

iFileName

[protected]

TInt iFlags

TInt

iFlags

[protected]

MAknIconFormatHandler * iHandler

MAknIconFormatHandler *

iHandler

[protected]

TInt iInitializedAngle

TInt

iInitializedAngle

[protected]

TRgb iInitializedColor

TRgb

iInitializedColor

[protected]

TInt iInitializedMode

TInt

iInitializedMode

[protected]

TSize iInitializedSize

TSize

iInitializedSize

[protected]

TSize iLoadedSize

TSize

iLoadedSize

[protected]

CAknBitmap * iMask

CAknBitmap *

iMask

[protected]

TInt16 iMaskId

TInt16

iMaskId

[protected]

MAknIconObserver * iObserver

MAknIconObserver *

iObserver

[protected]

TInt16 iOriginalMaskId

TInt16

iOriginalMaskId

[protected]

TInt iRefCount

TInt

iRefCount

[protected]