RAknIconSrvClient Class Reference

#include <mw/AknIconSrvClient.h>

class RAknIconSrvClient : public RSessionBase

Inherits from

RAknIconSrvClient
- RSessionBase
  - RHandleBase

Public Member Functions
	RAknIconSrvClient()
IMPORT_C TInt	Connect()
TInt	ConnectToServer()
void	DestroyIconData(CAknIconManager &)
IMPORT_C void	Disconnect()
TInt	EnableCache(TBool)
void	FreeBitmap(CAknBitmap &)
TInt	GetContentDimensions(CAknBitmap &, TAknContentDimensions &)
void	GetInitData(TAknIconInitData &)
RAknIconSrvClient *	GetSession()
void	InitializeIconL(CAknBitmap &, CAknBitmap &, TAknContentDimensions &, const TAknIconParams &)
TInt	PreserveIconData(CAknIconManager &)
void	__SERVER_HEAP_FAILNEXT(TInt)
void	__SERVER_HEAP_FAILNEXT_INCREASING(TInt)
void	__SERVER_HEAP_MARK()
void	__SERVER_HEAP_MARKEND()
void	__SERVER_HEAP_RESET()
TInt	__SERVER_HEAP_USED()
void	__SERVER_RESET_DYNAMICALLY_CHANGING_ALLOCATIONS()
void	__SERVER_SET_PREFERRED_ICON_DISPLAY_MODE(TDisplayMode)

Inherited Attributes
	RHandleBase::iHandle

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Detailed Description

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

Since: 3.0

Constructor & Destructor Documentation

RAknIconSrvClient ( )

RAknIconSrvClient

(

)

C++ default constructor.

Member Function Documentation

Connect ( )

IMPORT_C TInt

Connect

(

)

[static]

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

Since: 3.0

Return Value: Symbian OS standard error code.

ConnectToServer ( )

TInt

ConnectToServer

(

)

Connects to server.

Return Value: Symbian OS standard error code .

DestroyIconData ( CAknIconManager & )

void

DestroyIconData

(

CAknIconManager &

aBitmap

)

const

Removes icon data (e.g. SVG-T DOM tree) from the memory.

Parameters
aBitmap	Bitmap.

Disconnect ( )

IMPORT_C void

Disconnect

(

)

[static]

Disconnects the session.

Since: 3.0

EnableCache ( TBool )

TInt

EnableCache

(

TBool

aEnable

)

Enable or disable the AknIcon cache.

Return Value: Symbian OS standard error code .

FreeBitmap ( CAknBitmap & )

void

FreeBitmap

(

CAknBitmap &

aBitmap

)

const

Frees the shared bitmap.

Parameters
aBitmap	Bitmap.

GetContentDimensions ( CAknBitmap &, TAknContentDimensions & )

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

Gets content dimensions of the icon.

Parameters
aBitmap	Bitmap.
aContentDimensions	The content dimensions of an icon.

Return Value: Symbian OS standard error code .

GetInitData ( TAknIconInitData & )

void

GetInitData

(

TAknIconInitData &

aData

)

const

Retrieves initialization data from server side.

Parameters
aData	Initialization data.

GetSession ( )

RAknIconSrvClient *

GetSession

(

)

[static]

Returns the connected server client from TLS.

Return Value: The connected server client from TLS.

Panic Codes
EClientSessionNotConnected

InitializeIconL ( CAknBitmap &, CAknBitmap &, TAknContentDimensions &, const TAknIconParams & )

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.

Parameters
aBitmap	Bitmap.
aMask	Mask of the bitmap.
aContentDimensions	The content dimensions if it is a SVG icon.
aInfo	parameters of the icon.

PreserveIconData ( CAknIconManager & )

TInt

PreserveIconData

(

CAknIconManager &

aBitmap

)

const

Preserves icon data (e.g. SVG-T DOM tree) in memory.

Parameters
aBitmap	Bitmap.

Return Value: Symbian OS standard error code .

__SERVER_HEAP_FAILNEXT ( TInt )

void

__SERVER_HEAP_FAILNEXT

(

TInt

aCount

)

const

__SERVER_HEAP_FAILNEXT_INCREASING ( TInt )

void

__SERVER_HEAP_FAILNEXT_INCREASING

(

TInt

aCount

)

const

__SERVER_HEAP_MARK ( )

void

__SERVER_HEAP_MARK

(

)

const

Test functions (debug only).

__SERVER_HEAP_MARKEND ( )

void

__SERVER_HEAP_MARKEND

(

)

const

__SERVER_HEAP_RESET ( )

void

__SERVER_HEAP_RESET

(

)

const

__SERVER_HEAP_USED ( )

TInt

__SERVER_HEAP_USED

(

)

const

__SERVER_RESET_DYNAMICALLY_CHANGING_ALLOCATIONS ( )

void

__SERVER_RESET_DYNAMICALLY_CHANGING_ALLOCATIONS

(

)

const

__SERVER_SET_PREFERRED_ICON_DISPLAY_MODE ( TDisplayMode )

void

__SERVER_SET_PREFERRED_ICON_DISPLAY_MODE

(

TDisplayMode

aMode

)

const