RAknIconSrvClient Class Reference

API published in: S60 2nd Ed FP 3

Link against: aknicon.lib

Capability Information

Required Capabilities

None

#include <akniconsrvclient.h>

Detailed Description

A client-side handle to a session with an icon server which allows handling icons (bitmaps).


Public Member Functions
	RAknIconSrvClient ()
	C++ default constructor.
void	InitializeIconL (CAknBitmap &aBitmap, CAknBitmap &aMask, TAknContentDimensions &aContentDimensions, const TAknIconParams &aInfo) const
	Initializes the given bitmap and mask according to the member data stored in them and the given pixel size.
void	FreeBitmap (CAknBitmap &aBitmap) const
	Frees the shared bitmap.
TInt	GetContentDimensions (CAknBitmap &aBitmap, TAknContentDimensions &aContentDimensions) const
	Gets content dimensions of the icon.
TInt	PreserveIconData (CAknIconManager &aBitmap) const
	Preserves icon data (e.g.
void	DestroyIconData (CAknIconManager &aBitmap) const
	Removes icon data (e.g.
void	GetInitData (TAknIconInitData &aData) const
	Retrieves initialization data from server side.
void	__SERVER_HEAP_MARK () const
	Test functions (debug only).
void	__SERVER_HEAP_MARKEND () const
void	__SERVER_HEAP_FAILNEXT (TInt aCount) const
void	__SERVER_HEAP_FAILNEXT_INCREASING (TInt aCount) const
void	__SERVER_HEAP_RESET () const
void	__SERVER_RESET_DYNAMICALLY_CHANGING_ALLOCATIONS () const
TInt	__SERVER_HEAP_USED () const
void	__SERVER_SET_PREFERRED_ICON_DISPLAY_MODE (TDisplayMode aMode) const
TInt	ConnectToServer ()
	Connects to server.
TInt	EnableCache (TBool aEnable)
	Enable or disable the AknIcon cache.
Static Public Member Functions
static IMPORT_C TInt	Connect ()
	Connects AknIconSrv session.
static IMPORT_C void	Disconnect ()
	Disconnects the session.
static RAknIconSrvClient *	GetSession ()
	Returns the connected server client from TLS.

Constructor & Destructor Documentation

RAknIconSrvClient::RAknIconSrvClient

(

)

C++ default constructor.

Member Function Documentation

void RAknIconSrvClient::__SERVER_HEAP_FAILNEXT

void RAknIconSrvClient::__SERVER_HEAP_FAILNEXT_INCREASING

void RAknIconSrvClient::__SERVER_HEAP_MARK

(

)

const

Test functions (debug only).

void RAknIconSrvClient::__SERVER_HEAP_MARKEND

(

)

const

void RAknIconSrvClient::__SERVER_HEAP_RESET

(

)

const

TInt RAknIconSrvClient::__SERVER_HEAP_USED

(

)

const

void RAknIconSrvClient::__SERVER_RESET_DYNAMICALLY_CHANGING_ALLOCATIONS

(

)

const

void RAknIconSrvClient::__SERVER_SET_PREFERRED_ICON_DISPLAY_MODE

static IMPORT_C TInt RAknIconSrvClient::Connect ( ) [static]

Connects AknIconSrv session.

It is stored in TLS. Application framework calls this in application startup.

Returns:: Symbian OS standard error code.

TInt RAknIconSrvClient::ConnectToServer

(

)

Connects to server.

Returns:: Symbian OS standard error code .

void RAknIconSrvClient::DestroyIconData

Removes icon data (e.g.

SVG-T DOM tree) from the memory.

Parameters:

aBitmap

Bitmap.

static IMPORT_C void RAknIconSrvClient::Disconnect ( ) [static]

Disconnects the session.

TInt RAknIconSrvClient::EnableCache

Enable or disable the AknIcon cache.

Returns:: Symbian OS standard error code .

void RAknIconSrvClient::FreeBitmap

Frees the shared bitmap.

Parameters:

aBitmap

Bitmap.

TInt RAknIconSrvClient::GetContentDimensions	(	CAknBitmap &	aBitmap,
		TAknContentDimensions &	aContentDimensions
	)	const

Gets content dimensions of the icon.

Parameters:

`[in]`	aBitmap	Bitmap.
`[out]`	aContentDimensions	The content dimensions of an icon.

Returns:: Symbian OS standard error code .

void RAknIconSrvClient::GetInitData

Retrieves initialization data from server side.

Parameters:

[out] aData Initialization data.

static RAknIconSrvClient* RAknIconSrvClient::GetSession ( ) [static]

Returns the connected server client from TLS.

Returns:: The connected server client from TLS.

Panic:: EClientSessionNotConnected Connect() has not been called successfully earlier.

void RAknIconSrvClient::InitializeIconL	(	CAknBitmap &	aBitmap,
		CAknBitmap &	aMask,
		TAknContentDimensions &	aContentDimensions,
		const TAknIconParams &	aInfo
	)	const

Initializes the given bitmap and mask according to the member data stored in them and the given pixel size.

Parameters:

`[in]`	aBitmap	Bitmap.
`[in]`	aMask	Mask of the bitmap.
`[out]`	aContentDimensions	The content dimensions if it is a SVG icon.
	aInfo	parameters of the icon.