CCdlEngine Class Reference

class CCdlEngine : public CCdlEngineBase

The client side CDL engine. This adds all the customisation management functionality over the base class.

Inherits from

Public Member Functions
~CCdlEngine ()
void AddCustomisationChangeObserverL ( MCdlChangeObserver *, TUid )
void AddGeneralChangeObserverL ( MCdlChangeObserver *)
CCdlRefs * AllAvailableRefsLC ()
const CCdlInstance & CustomisationInstance ( TUid )
void EnableGlobalCustomisationL (const CCdlUids &, TBool )
CCdlRefCollection * FileContentsLC (const TDesC &)
void FileNameRelativeToLastAccessedInstance ( TUid , TFileName &)
CCdlNames * FindCustomisationFilesLC ()
CCdlRefs * FindInstancesLC ( TUid )
TAny * GetData ( TUid , TInt )
TCdlEngineFunc * GetFunction ( TUid , TInt )
CCdlRefs * GlobalStateLC (const CCdlUids &)
void HandleAvailableRefsChangeL ()
void HandleGlobalCustomisationChangeL ( TInt )
CCdlEngine & Instance ()
CCdlEngine * InstanceLC ( TBool &)
TBool IsCustomisationStarted (const SCdlInterface *)
TInt IsPluginInRom (const TDesC &, TBool &)
const TCdlRef & LastAccessedRef ( TUid )
TInt LastApiId ()
TInt * LastApiRefL ( TUid )
void LoadCustomisationL (const TCdlRef &)
CCdlRefs * LocalStateLC (const CCdlUids &)
CCdlEngine * NewLC ()
TInt PluginDrive (const TDesC &, TDriveUnit &)
void RemoveChangeObserver ( MCdlChangeObserver *)
void RequireCustomisationL (const SCdlInterface *)
void SetGlobalStateL (const CCdlRefs &)
void SetLastApiId ( TInt )
void SetLocalStateL (const CCdlRefs &)
void StartGlobalCustomisationL ()
CCdlEngine * Static ()
Private Member Functions
CCdlEngine ()
void AddLocalStateToRefsL ( TUid , CCdlRefs *)
void ConstructL ()
void DoSetLocalStateL (const CCdlRefs &, CCdlUids &)
CCdlRefs * GlobalStateLC ( TInt )
const CCdlInstance * LastAccessedInstance ( TUid )
CCdlCustomisationStack * Lookup ( TUid )
CCdlCustomisationStack * LookupOrCreateL ( TUid )
CCdlCustomisationStack & LookupP ( TUid )
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()
CCdlEngineBase::CCdlEngineBase()
CCdlEngineBase::DecRefCount()
CCdlEngineBase::IncRefCount()
CCdlEngineBase::LibMan()const
CCdlEngineBase::~CCdlEngineBase()
Private Member Type Definitions
typedef RHashMap < TUint32 , CCdlCustomisationStack * > CCdlCustomisations
Private Attributes
CCdlChangeMonitor * iChangeMonitor
CCdlCustomisations iCustomisations
CCdlUids iGloballyCustomised
TInt iLastApiId
CCdlChangeObservers iObservers
RCdlSession iServer

Constructor & Destructor Documentation

CCdlEngine()

CCdlEngine ( ) [private]

~CCdlEngine()

~CCdlEngine ( )

Member Functions Documentation

AddCustomisationChangeObserverL(MCdlChangeObserver *, TUid)

void AddCustomisationChangeObserverL ( MCdlChangeObserver * aObserver,
TUid aUid
)

Parameters

MCdlChangeObserver * aObserver
TUid aUid

AddGeneralChangeObserverL(MCdlChangeObserver *)

void AddGeneralChangeObserverL ( MCdlChangeObserver * aObserver )

Parameters

MCdlChangeObserver * aObserver

AddLocalStateToRefsL(TUid, CCdlRefs *)

void AddLocalStateToRefsL ( TUid aUid,
CCdlRefs * aState
) const [private]

Parameters

TUid aUid
CCdlRefs * aState

AllAvailableRefsLC()

CCdlRefs * AllAvailableRefsLC ( ) const

ConstructL()

void ConstructL ( ) [private]

CustomisationInstance(TUid)

const CCdlInstance & CustomisationInstance ( TUid aCdlUid ) const

Parameters

TUid aCdlUid

DoSetLocalStateL(const CCdlRefs &, CCdlUids &)

void DoSetLocalStateL ( const CCdlRefs & aState,
CCdlUids & aChangedUids
) [private]

Parameters

const CCdlRefs & aState
CCdlUids & aChangedUids

EnableGlobalCustomisationL(const CCdlUids &, TBool)

void EnableGlobalCustomisationL ( const CCdlUids & aCdlUids,
TBool aEnabled
)

Parameters

const CCdlUids & aCdlUids
TBool aEnabled

FileContentsLC(const TDesC &)

CCdlRefCollection * FileContentsLC ( const TDesC & aLibName ) [virtual]

Parameters

const TDesC & aLibName

FileNameRelativeToLastAccessedInstance(TUid, TFileName &)

void FileNameRelativeToLastAccessedInstance ( TUid aCdlUid,
TFileName & aFileName
) const

Parameters

TUid aCdlUid
TFileName & aFileName

FindCustomisationFilesLC()

CCdlNames * FindCustomisationFilesLC ( ) const

FindInstancesLC(TUid)

CCdlRefs * FindInstancesLC ( TUid aCdlUid ) const

Parameters

TUid aCdlUid

GetData(TUid, TInt)

TAny * GetData ( TUid aCdlUid,
TInt aApiId
) const

Parameters

TUid aCdlUid
TInt aApiId

GetFunction(TUid, TInt)

TCdlEngineFunc * GetFunction ( TUid aCdlUid,
TInt aApiId
) const

Parameters

TUid aCdlUid
TInt aApiId

GlobalStateLC(const CCdlUids &)

CCdlRefs * GlobalStateLC ( const CCdlUids & aCdlUids ) const

Parameters

const CCdlUids & aCdlUids

GlobalStateLC(TInt)

CCdlRefs * GlobalStateLC ( TInt aSize ) const [private]

Parameters

TInt aSize

HandleAvailableRefsChangeL()

void HandleAvailableRefsChangeL ( )

HandleGlobalCustomisationChangeL(TInt)

void HandleGlobalCustomisationChangeL ( TInt aSize )

Parameters

TInt aSize

Instance()

CCdlEngine & Instance ( ) [static]

InstanceLC(TBool &)

CCdlEngine * InstanceLC ( TBool & aPushed ) [static]

Parameters

TBool & aPushed

IsCustomisationStarted(const SCdlInterface *)

TBool IsCustomisationStarted ( const SCdlInterface * aInterfaceParams ) const

Parameters

const SCdlInterface * aInterfaceParams

IsPluginInRom(const TDesC &, TBool &)

TInt IsPluginInRom ( const TDesC & aFileName,
TBool & aIsInRom
) const [virtual]

Parameters

const TDesC & aFileName
TBool & aIsInRom

LastAccessedInstance(TUid)

const CCdlInstance * LastAccessedInstance ( TUid aCdlUid ) const [private]

Parameters

TUid aCdlUid

LastAccessedRef(TUid)

const TCdlRef & LastAccessedRef ( TUid aCdlUid ) const

Parameters

TUid aCdlUid

LastApiId()

TInt LastApiId ( ) const

LastApiRefL(TUid)

TInt * LastApiRefL ( TUid aCdlUid )

Parameters

TUid aCdlUid

LoadCustomisationL(const TCdlRef &)

void LoadCustomisationL ( const TCdlRef & aRef )

Parameters

const TCdlRef & aRef

LocalStateLC(const CCdlUids &)

CCdlRefs * LocalStateLC ( const CCdlUids & aCdlUids ) const

Parameters

const CCdlUids & aCdlUids

Lookup(TUid)

CCdlCustomisationStack * Lookup ( TUid aCdlUid ) const [private]

Parameters

TUid aCdlUid

LookupOrCreateL(TUid)

CCdlCustomisationStack * LookupOrCreateL ( TUid aCdlUid ) [private]

Parameters

TUid aCdlUid

LookupP(TUid)

CCdlCustomisationStack & LookupP ( TUid aCdlUid ) const [private]

Parameters

TUid aCdlUid

NewLC()

CCdlEngine * NewLC ( ) [static]

PluginDrive(const TDesC &, TDriveUnit &)

TInt PluginDrive ( const TDesC & aFileName,
TDriveUnit & aDrive
) const [virtual]

Parameters

const TDesC & aFileName
TDriveUnit & aDrive

RemoveChangeObserver(MCdlChangeObserver *)

void RemoveChangeObserver ( MCdlChangeObserver * aObserver )

Parameters

MCdlChangeObserver * aObserver

RequireCustomisationL(const SCdlInterface *)

void RequireCustomisationL ( const SCdlInterface * aInterfaceParams )

Parameters

const SCdlInterface * aInterfaceParams

SetGlobalStateL(const CCdlRefs &)

void SetGlobalStateL ( const CCdlRefs & aState )

Parameters

const CCdlRefs & aState

SetLastApiId(TInt)

void SetLastApiId ( TInt aLastApiId ) const [inline]

Parameters

TInt aLastApiId

SetLocalStateL(const CCdlRefs &)

void SetLocalStateL ( const CCdlRefs & aState )

Parameters

const CCdlRefs & aState

StartGlobalCustomisationL()

void StartGlobalCustomisationL ( )

Static()

CCdlEngine * Static ( ) [static]

Member Type Definitions Documentation

Typedef CCdlCustomisations

typedef RHashMap < TUint32 , CCdlCustomisationStack * > CCdlCustomisations [private]

Member Data Documentation

CCdlChangeMonitor * iChangeMonitor

CCdlChangeMonitor * iChangeMonitor [private]

CCdlCustomisations iCustomisations

CCdlCustomisations iCustomisations [private]

CCdlUids iGloballyCustomised

CCdlUids iGloballyCustomised [private]

TInt iLastApiId

TInt iLastApiId [private]

CCdlChangeObservers iObservers

CCdlChangeObservers iObservers [private]

RCdlSession iServer

RCdlSession iServer [private]