RAknIconSrvClient Class Reference

class RAknIconSrvClient : public RSessionBase

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

Since
3.0

Inherits from

Public Member Functions
RAknIconSrvClient()
IMPORT_C TIntConnect()
TInt ConnectToServer()
voidDestroyIconData(CAknIconManager &)
IMPORT_C voidDisconnect()
TInt EnableCache(TBool)
voidFreeBitmap(CAknBitmap &)
TInt GetContentDimensions(CAknBitmap &, TAknContentDimensions &)
voidGetInitData(TAknIconInitData &)
RAknIconSrvClient *GetSession()
voidInitializeIconL(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 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()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
TInt iConnections
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RAknIconSrvClient()

RAknIconSrvClient()

C++ default constructor.

Member Functions Documentation

Connect()

IMPORT_C TIntConnect()[static]

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

Since
3.0

ConnectToServer()

TInt ConnectToServer()

Connects to server.

DestroyIconData(CAknIconManager &)

voidDestroyIconData(CAknIconManager &aBitmap)const

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

Parameters

CAknIconManager & aBitmapBitmap.

Disconnect()

IMPORT_C voidDisconnect()[static]
Disconnects the session.
Since
3.0

EnableCache(TBool)

TInt EnableCache(TBoolaEnable)

Enable or disable the AknIcon cache.

Parameters

TBool aEnable

FreeBitmap(CAknBitmap &)

voidFreeBitmap(CAknBitmap &aBitmap)const

Frees the shared bitmap.

Parameters

CAknBitmap & aBitmapBitmap.

GetContentDimensions(CAknBitmap &, TAknContentDimensions &)

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

Gets content dimensions of the icon.

Parameters

CAknBitmap & aBitmapBitmap.
TAknContentDimensions & aContentDimensionsThe content dimensions of an icon.

GetInitData(TAknIconInitData &)

voidGetInitData(TAknIconInitData &aData)const

Retrieves initialization data from server side.

Parameters

TAknIconInitData & aDataInitialization data.

GetSession()

RAknIconSrvClient *GetSession()[static]

Returns the connected server client from TLS.

panic
EClientSessionNotConnected Connect() has not been called successfully earlier.

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

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

CAknBitmap & aBitmapBitmap.
CAknBitmap & aMaskMask of the bitmap.
TAknContentDimensions & aContentDimensionsThe content dimensions if it is a SVG icon.
const TAknIconParams & aInfoparameters of the icon.

PreserveIconData(CAknIconManager &)

TInt PreserveIconData(CAknIconManager &aBitmap)const

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

Parameters

CAknIconManager & aBitmapBitmap.

__SERVER_HEAP_FAILNEXT(TInt)

void__SERVER_HEAP_FAILNEXT(TIntaCount)const

Parameters

TInt aCount

__SERVER_HEAP_FAILNEXT_INCREASING(TInt)

void__SERVER_HEAP_FAILNEXT_INCREASING(TIntaCount)const

Parameters

TInt aCount

__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(TDisplayModeaMode)const

Parameters

TDisplayMode aMode

Member Data Documentation

TInt iConnections

TInt iConnections[private]