Collapse all Symbian^3 Product Developer Library

CWPAdapter Class Reference

class CWPAdapter : public CBase

CWPAdapter has to be implemented by each adapter. CWPAdapter contains only pure virtual methods, which must be implemented by adapters, and inline methods, which can be used by adapters or engine. Inlining prevents circular binary dependency.

ProvisioningEngine

Since: 2.0

Inherits from

CWPAdapter
- CBase

Public Member Functions
	~CWPAdapter()
TBool	CanSetAsDefault(TInt)
TInt	ContextExtension(MWPContextExtension *&)
TInt	DetailsL(TInt, MWPPairVisitor &)
void	GetSavingInfoL(TInt, RPointerArray< HBufC8 > &)
TInt	ItemCount()
void	ListL(RImplInfoPtrArray &)
IMPORT_C CWPAdapter *	NewL(const TUid &)
void	SaveL(TInt)
void	SavingFinalizedL()
void	SetAsDefaultL(TInt)
void	SettingsSavedL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
const TDesC16 &	SummaryText(TInt)
const TDesC16 &	SummaryTitle(TInt)
void	VisitL(CWPCharacteristic &)
void	VisitL(CWPParameter &)
void	VisitLinkL(CWPCharacteristic &)

Protected Member Functions
	CWPAdapter()

Private Member Functions
TInt	Reserved_1()

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

Protected Attributes
TUid	iDtor_ID_Key

Constructor & Destructor Documentation

CWPAdapter()

IMPORT_C

CWPAdapter

(

)

[protected]

C++ constructor.

~CWPAdapter()

IMPORT_C

~CWPAdapter

(

)

Destructor.

Member Functions Documentation

CanSetAsDefault(TInt)

TBool

CanSetAsDefault

(

TInt

aItem

)

const [pure virtual]

Returns ETrue if the adapter can set the settings as default.

Parameters

TInt aItem

ContextExtension(MWPContextExtension *&)

TInt

ContextExtension

(

MWPContextExtension *&

)

[inline, virtual]

Returns a pointer to a context extension.

Parameters

MWPContextExtension *&

DetailsL(TInt, MWPPairVisitor &)

TInt	DetailsL	(	TInt	aItem,
			MWPPairVisitor &	aVisitor
		)	[pure virtual]

Calls the pair visitor for each detail line of an item.

Parameters

TInt aItem	Item whose details are needed
MWPPairVisitor & aVisitor	Pair visitor

GetSavingInfoL(TInt, RPointerArray< HBufC8 > &)

void	GetSavingInfoL	(	TInt	,
			RPointerArray< HBufC8 > &
		)	[inline, virtual]

Gets the saving information from the adapter that has saved settings.

Parameters

TInt
RPointerArray< HBufC8 > &

ItemCount()

TInt

ItemCount

(

)

const [pure virtual]

Check the number of settings items.

ListL(RImplInfoPtrArray &)

void

ListL

(

RImplInfoPtrArray &

aImplInfoArray

)

[static]

Lists all CWPAdapter implementations.

Parameters

RImplInfoPtrArray & aImplInfoArray

Array to be filled with implementations

NewL(const TUid &)

IMPORT_C CWPAdapter *

NewL

(

const TUid &

aImplementationUid

)

[static]

Two-phased constructor.

Parameters

const TUid & aImplementationUid

The implementation UID of the adapter to be created.

Reserved_1()

TInt

Reserved_1

(

)

[private, inline, virtual]

SaveL(TInt)

void

SaveL

(

TInt

aItem

)

[pure virtual]

Saves one setting handled by the adapter.

Parameters

TInt aItem

SavingFinalizedL()

void

SavingFinalizedL

(

)

[inline, virtual]

Informs the adapters of the finalization of saving.

SetAsDefaultL(TInt)

void

SetAsDefaultL

(

TInt

aItem

)

[pure virtual]

Adapter sets the settings as default.

Parameters

TInt aItem

SettingsSavedL(const TDesC8 &, const TDesC8 &, const TDesC8 &)

void	SettingsSavedL	(	const TDesC8 &	,
			const TDesC8 &	,
			const TDesC8 &
		)	[inline, virtual]

Informs the adapters of the saved settings.

Parameters

const TDesC8 &
const TDesC8 &
const TDesC8 &

SummaryText(TInt)

const TDesC16 &

SummaryText

(

TInt

aIndex

)

const [pure virtual]

Returns the text of the nth summary line.

Parameters

TInt aIndex

Number of summary line

SummaryTitle(TInt)

const TDesC16 &

SummaryTitle

(

TInt

aIndex

)

const [pure virtual]

Returns the title of the nth summary line.

Parameters

TInt aIndex

Number of summary line

VisitL(CWPCharacteristic &)

void

VisitL

(

CWPCharacteristic &

aCharacteristic

)

[pure virtual]

Parameters

CWPCharacteristic & aCharacteristic

VisitL(CWPParameter &)

void

VisitL

(

CWPParameter &

aParameter

)

[pure virtual]

Parameters

CWPParameter & aParameter

VisitLinkL(CWPCharacteristic &)

void

VisitLinkL

(

CWPCharacteristic &

aCharacteristic

)

[pure virtual]

Parameters

CWPCharacteristic & aCharacteristic

Member Data Documentation

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[protected]