Collapse all Symbian^3 Product Developer Library

HSPluginSettingsIf::CHomescreenSettings Class Reference

class HSPluginSettingsIf::CHomescreenSettings : public CBase

Wrapper for hsps liw service

HomeScreenSettingsIf.lib

Since: S60 v5.0

Inherits from

HSPluginSettingsIf::CHomescreenSettings
- CBase

Public Member Functions
IMPORT_C void	AddObserverL(MHomeScreenSettingsObserver *)
IMPORT_C TInt	GetSettingsL(const TDesC8 &, RPointerArray< CItemMap > &)
IMPORT_C void	InitializeL(const TDesC8 &)
IMPORT_C CHomescreenSettings *	Instance()
IMPORT_C void	RemoveObserver(MHomeScreenSettingsObserver *)
IMPORT_C TInt	SetSettingsL(const TDesC8 &, const RPointerArray< CItemMap > &, const TBool)
IMPORT_C void	UnInitialize()

Protected Member Functions
	CHomescreenSettings()
	~CHomescreenSettings()
void	ConstructL(const TDesC8 &)
void	FillMapFromItemL(CLiwDefaultMap &, const CItemMap &)
void	FillMapFromPropertiesL(CLiwDefaultList &, const RPointerArray< CPropertyMap > &)
TInt	HandleNotifyL(TInt, TInt, CLiwGenericParamList &, const CLiwGenericParamList &)
CHomescreenSettings *	NewL(const TDesC8 &)
CHomescreenSettings *	NewLC(const TDesC8 &)
void	ProcessConfItemPropertiesL(const CLiwList &, CItemMap &)
void	ProcessConfigurationSettingsL(const CLiwList &, CHspsConfiguration &)
TInt	SetPluginSettingsL(const TDesC8 &, const RPointerArray< CItemMap > &, const TDesC8 &)

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

Private Attributes
MLiwInterface *	iHspsInterface
CLiwCriteriaItem *	iHspsService
RPointerArray< MHomeScreenSettingsObserver >	iObservers
CLiwServiceHandler *	iServiceHandler
TInt	iTransactionId

Constructor & Destructor Documentation

CHomescreenSettings()

CHomescreenSettings

(

)

[protected]

Constructor.

~CHomescreenSettings()

~CHomescreenSettings

(

)

[protected, virtual]

Destructor.

Member Functions Documentation

AddObserverL(MHomeScreenSettingsObserver *)

IMPORT_C void

AddObserverL

(

MHomeScreenSettingsObserver *

aObserver

)

Add observer

Parameters

MHomeScreenSettingsObserver * aObserver

Observer to be added.

ConstructL(const TDesC8 &)

void

ConstructL

(

const TDesC8 &

aAppUid

)

[protected]

Second phase constructor

Parameters

const TDesC8 & aAppUid

Application uid in integer format

FillMapFromItemL(CLiwDefaultMap &, const CItemMap &)

void	FillMapFromItemL	(	CLiwDefaultMap &	aMap,
			const CItemMap &	aItemMap
		)	[protected]

Fills liw map from given item

Parameters

CLiwDefaultMap & aMap	liw item map to fill in
const CItemMap & aItemMap	item map

FillMapFromPropertiesL(CLiwDefaultList &, const RPointerArray< CPropertyMap > &)

void	FillMapFromPropertiesL	(	CLiwDefaultList &	aInPropertyMapList,
			const RPointerArray< CPropertyMap > &	aProperties
		)	[protected]

Fills liw map from given item properties

Parameters

CLiwDefaultList & aInPropertyMapList
const RPointerArray< CPropertyMap > & aProperties

GetSettingsL(const TDesC8 &, RPointerArray< CItemMap > &)

IMPORT_C TInt	GetSettingsL	(	const TDesC8 &	aPluginId,
			RPointerArray< CItemMap > &	aSettings
		)

From MHomescreenSettingsIf Stores defined plugin s settings. Plugin is identified with unique plugin ID used in application s configuration

Parameters

const TDesC8 & aPluginId	Pluging s ID which settings are stored
RPointerArray< CItemMap > & aSettings	List of item maps

HandleNotifyL(TInt, TInt, CLiwGenericParamList &, const CLiwGenericParamList &)

TInt	HandleNotifyL	(	TInt	aCmdId,
			TInt	aEventId,
			CLiwGenericParamList &	aEventParamList,
			const CLiwGenericParamList &	aInParamList
		)	[protected]

From MLiwNotifyCallback Handle HSPS notifications

Parameters

TInt aCmdId	Command id
TInt aEventId	Event id
CLiwGenericParamList & aEventParamList	Event parameters
const CLiwGenericParamList & aInParamList	In parameters

InitializeL(const TDesC8 &)

IMPORT_C void

InitializeL

(

const TDesC8 &

aAppUid

)

[static]

Initialize settings api.

There must be one UnInitialize call for each Initialize call in order to prevent memory leaking. (Implementation contains reference counting)

Parameters

const TDesC8 & aAppUid

Instance()

IMPORT_C CHomescreenSettings *

Instance

(

)

[static]

Get instance to settings API.

InitializeL must be called before calling this method. Otherwise NULL is returned. InitializeL and Instance must be called within same thread since TLS is used to storage instance data.

NewL(const TDesC8 &)

CHomescreenSettings *

NewL

(

const TDesC8 &

aAppUid

)

[protected, static]

Two-phased constructor.

Parameters

const TDesC8 & aAppUid

Application uid in integer format

NewLC(const TDesC8 &)

CHomescreenSettings *

NewLC

(

const TDesC8 &

aAppUid

)

[protected, static]

Two-phased constructor.

Parameters

const TDesC8 & aAppUid

Application uid in integer format

ProcessConfItemPropertiesL(const CLiwList &, CItemMap &)

void	ProcessConfItemPropertiesL	(	const CLiwList &	aPropertyMapList,
			CItemMap &	aItemMap
		)	[protected]

Processes all items' properties configuration

Parameters

const CLiwList & aPropertyMapList	input properties
CItemMap & aItemMap	output item

ProcessConfigurationSettingsL(const CLiwList &, CHspsConfiguration &)

void	ProcessConfigurationSettingsL	(	const CLiwList &	aItemList,
			CHspsConfiguration &	aTarget
		)	[protected]

Processes all items configuration setting

Parameters

const CLiwList & aItemList	item list
CHspsConfiguration & aTarget	output hsps configuration

RemoveObserver(MHomeScreenSettingsObserver *)

IMPORT_C void

RemoveObserver

(

MHomeScreenSettingsObserver *

aObserver

)

Remove observer

Parameters

MHomeScreenSettingsObserver * aObserver

Observer to be removed.

SetPluginSettingsL(const TDesC8 &, const RPointerArray< CItemMap > &, const TDesC8 &)

TInt	SetPluginSettingsL	(	const TDesC8 &	aPluginId,
			const RPointerArray< CItemMap > &	aSettings,
			const TDesC8 &	aStoringParam
		)	[protected]

Sets plugin settings

Parameters

const TDesC8 & aPluginId	plugin id
const RPointerArray< CItemMap > & aSettings	array of items to set
const TDesC8 & aStoringParam	parameter to tell whether plugin configuration need to be saved.

SetSettingsL(const TDesC8 &, const RPointerArray< CItemMap > &, const TBool)

IMPORT_C TInt	SetSettingsL	(	const TDesC8 &	aPluginId,
			const RPointerArray< CItemMap > &	aSettings,
			const TBool	aStoringParam
		)

From MHomescreenSettingsIf Stores defined plugin s settings. Plugin is identified with unique plugin ID used in application s configuration

Parameters

const TDesC8 & aPluginId	Pluging s ID which settings are stored
const RPointerArray< CItemMap > & aSettings	List of item maps
const TBool aStoringParam	parameter to tell whether plugin configuration need to be saved also if parameter is ETrue.

UnInitialize()

IMPORT_C void

UnInitialize

(

)

[static]

Uninitialize settings api.

There must be one UnInitialize call for each Initialize call in order to prevent memory leaking. (Implementation contains reference counting)

Member Data Documentation

MLiwInterface * iHspsInterface

MLiwInterface *

iHspsInterface

[private]

Owned. Provides hsps services.

CLiwCriteriaItem * iHspsService

CLiwCriteriaItem *

iHspsService

[private]

Owned. HSPS SAPI service.

RPointerArray< MHomeScreenSettingsObserver > iObservers

RPointerArray< MHomeScreenSettingsObserver >

iObservers

[private]

CLiwServiceHandler * iServiceHandler

CLiwServiceHandler *

iServiceHandler

[private]

Owned. SAPI service handler.

TInt iTransactionId

TInt

iTransactionId

[private]