Collapse all Symbian^3 Product Developer Library

CWPEngine Class Reference

class CWPEngine : public CBase

CWPEngine is an engine class used by Provisioning components.

ProvisioningEngine

Since: 2.0

Inherits from

CWPEngine
- CBase

Public Member Functions
	~CWPEngine()
IMPORT_C void	AcceptL(MWPVisitor &)
IMPORT_C MWPBuilder &	Builder()
IMPORT_C TBool	CanSetAsDefault(TInt)
IMPORT_C TInt	ContextDataCountL(TUint32)
IMPORT_C TBool	ContextExistsL(TUint32)
IMPORT_C TBool	ContextExistsL(const TDesC &)
IMPORT_C TUint32	ContextL(const TDesC &)
IMPORT_C HBufC16 *	ContextNameL(TUint32)
IMPORT_C CDesC16Array *	ContextProxiesL(TUint32)
IMPORT_C HBufC16 *	ContextTPSL(TUint32)
IMPORT_C CArrayFix< TUint32 > *	ContextUidsL()
IMPORT_C TUint32	CreateContextL(const TDesC &, const TDesC &, const MDesC16Array &)
IMPORT_C void	CreateLinksL()
IMPORT_C TUint32	CurrentContextL()
IMPORT_C TBool	DeleteContextDataL(TUint32)
IMPORT_C void	DeleteContextL(TUint32)
IMPORT_C TInt	DetailsL(TInt, MWPPairVisitor &)
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C TInt	GetAccessDenied()
IMPORT_C void	ImportDocumentL(const TDesC8 &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C TInt	ItemCount()
IMPORT_C CWPEngine *	NewL()
IMPORT_C CWPEngine *	NewLC()
IMPORT_C void	PopulateL()
IMPORT_C void	RegisterContextObserverL(MWPContextObserver *)
IMPORT_C void	RestoreL(CStreamStore &, TStreamId)
IMPORT_C void	SaveL(TInt)
IMPORT_C void	SetAccessDenied(TBool)
IMPORT_C void	SetAsDefaultL(TInt)
IMPORT_C void	SetCurrentContextL(TUint32)
IMPORT_C TStreamId	StoreL(CStreamStore &)
IMPORT_C const TDesC16 &	SummaryText(TInt)
IMPORT_C const TDesC16 &	SummaryTitle(TInt)
IMPORT_C TInt	UnregisterContextObserver(MWPContextObserver *)

Private Member Functions
	CWPEngine()
CWPAdapterManager &	AdapterManagerL()
void	ConstructL()
MWPContextManager &	ContextManager()
void	ItemIndex(TInt, TInt &, TInt &)

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
TBool	iAccessDenied
CWPAdapterManager *	iAdapters
MWPContextManager *	iManager
CWPRoot *	iRoot

Constructor & Destructor Documentation

CWPEngine()

CWPEngine

(

)

[private]

C++ default constructor.

~CWPEngine()

~CWPEngine

(

)

Destructor.

Member Functions Documentation

AcceptL(MWPVisitor &)

IMPORT_C void

AcceptL

(

MWPVisitor &

aVisitor

)

Accepts a visitor for the contents of the document.

Parameters

MWPVisitor & aVisitor

Visitor is called for each element in the root of the document.

AdapterManagerL()

CWPAdapterManager &

AdapterManagerL

(

)

[private]

Returns an adapter manager.

Builder()

IMPORT_C MWPBuilder &

Builder

(

)

const

Returns a builder to be used for creating the document data.

CanSetAsDefault(TInt)

IMPORT_C TBool

CanSetAsDefault

(

TInt

aItem

)

const

Checks if the setting can be set as default.

Parameters

TInt aItem

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

ContextDataCountL(TUint32)

IMPORT_C TInt

ContextDataCountL

(

TUint32

aUid

)

Deletes a data item from a context.

Parameters

TUint32 aUid

ContextExistsL(TUint32)

IMPORT_C TBool

ContextExistsL

(

TUint32

aUid

)

Checks if a context exists.

Parameters

TUint32 aUid

ContextExistsL(const TDesC &)

IMPORT_C TBool

ContextExistsL

(

const TDesC &

aTPS

)

Checks if a context exists.

Parameters

const TDesC & aTPS

ContextL(const TDesC &)

IMPORT_C TUint32

ContextL

(

const TDesC &

aTPS

)

Returns a specific context.

Parameters

const TDesC & aTPS

TPS whose context should be looked for

ContextManager()

MWPContextManager &

ContextManager

(

)

const [private]

Returns a context manager.

ContextNameL(TUint32)

IMPORT_C HBufC16 *

ContextNameL

(

TUint32

aUid

)

Name of a context.

Parameters

TUint32 aUid

ContextProxiesL(TUint32)

IMPORT_C CDesC16Array *

ContextProxiesL

(

TUint32

aUid

)

TPS of a context.

Parameters

TUint32 aUid

ContextTPSL(TUint32)

IMPORT_C HBufC16 *

ContextTPSL

(

TUint32

aUid

)

TPS of a context.

Parameters

TUint32 aUid

ContextUidsL()

IMPORT_C CArrayFix< TUint32 > *

ContextUidsL

(

)

Number of contexts available.

CreateContextL(const TDesC &, const TDesC &, const MDesC16Array &)

IMPORT_C TUint32	CreateContextL	(	const TDesC &	aName,
			const TDesC &	aTPS,
			const MDesC16Array &	aProxies
		)

Creates a context. Leaves with KErrOverflow if the max. number of contexts has been reached.

Parameters

const TDesC & aName	Name of the context
const TDesC & aTPS	TPS of the context
const MDesC16Array & aProxies	Proxies that can be used in the context

CreateLinksL()

IMPORT_C void

CreateLinksL

(

)

Creates links from logical proxy ids to logical proxies and access point ids to access points. Call this before walking through the document data.

CurrentContextL()

IMPORT_C TUint32

CurrentContextL

(

)

Returns the current context.

DeleteContextDataL(TUint32)

IMPORT_C TBool

DeleteContextDataL

(

TUint32

aUid

)

Deletes a data item from a context.

Parameters

TUint32 aUid

DeleteContextL(TUint32)

IMPORT_C void

DeleteContextL

(

TUint32

aUid

)

Deletes a context.

Parameters

TUint32 aUid

DetailsL(TInt, MWPPairVisitor &)

IMPORT_C TInt	DetailsL	(	TInt	aIndex,
			MWPPairVisitor &	aVisitor
		)

Calls a visitor for each details line of a particular item.

Parameters

TInt aIndex	The number of the item
MWPPairVisitor & aVisitor	The visitor to call

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Stores data to a stream.

Parameters

RWriteStream & aStream

Stream to write to.

GetAccessDenied()

IMPORT_C TInt

GetAccessDenied

(

)

Retutn the status of iAccessDenied variable

ImportDocumentL(const TDesC8 &)

IMPORT_C void

ImportDocumentL

(

const TDesC8 &

aDocument

)

Imports a WBXML document to the engine.

Parameters

const TDesC8 & aDocument

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Loads data from a stream.

Parameters

RReadStream & aStream

Stream to read from.

ItemCount()

IMPORT_C TInt

ItemCount

(

)

const

Returns the number of settings items.

ItemIndex(TInt, TInt &, TInt &)

void	ItemIndex	(	TInt	aGlobalIndex,
			TInt &	aAdapter,
			TInt &	aAdapterIndex
		)	const [private]

Converts an item number into a pair of adapter and adapter local item number.

Parameters

TInt aGlobalIndex	The item number
TInt & aAdapter	Contains adapter number after the call
TInt & aAdapterIndex	Contains adapter local item number after the call

NewL()

IMPORT_C CWPEngine *

NewL

(

)

[static]

Two-phased constructor.

NewLC()

IMPORT_C CWPEngine *

NewLC

(

)

[static]

Two-phased constructor.

PopulateL()

IMPORT_C void

PopulateL

(

)

Populates the adapters with the document contents.

RegisterContextObserverL(MWPContextObserver *)

IMPORT_C void

RegisterContextObserverL

(

MWPContextObserver *

aObserver

)

Parameters

MWPContextObserver * aObserver

The new observer

RestoreL(CStreamStore &, TStreamId)

IMPORT_C void	RestoreL	(	CStreamStore &	aStore,
			TStreamId	aId
		)

Restores the document data from a store.

Parameters

CStreamStore & aStore	The store to read from.
TStreamId aId	The stream id to read

SaveL(TInt)

IMPORT_C void

SaveL

(

TInt

aItem

)

Saves one setting.

Parameters

TInt aItem

Setting number

SetAccessDenied(TBool)

IMPORT_C void

SetAccessDenied

(

TBool

aStatus

)

Sets the iAccessDenied variable

Parameters

TBool aStatus

The status of iAccessDenied variable

SetAsDefaultL(TInt)

IMPORT_C void

SetAsDefaultL

(

TInt

aItem

)

Sets the setting as default.

Parameters

TInt aItem

SetCurrentContextL(TUint32)

IMPORT_C void

SetCurrentContextL

(

TUint32

aUid

)

Sets the current context.

Parameters

TUint32 aUid

StoreL(CStreamStore &)

IMPORT_C TStreamId

StoreL

(

CStreamStore &

aStore

)

const

Stores the document data to a store.

Parameters

CStreamStore & aStore

The store to write to.

SummaryText(TInt)

IMPORT_C const TDesC16 &

SummaryText

(

TInt

aIndex

)

const

Returns a summary text.

Parameters

TInt aIndex

Number of the setting item to read

SummaryTitle(TInt)

IMPORT_C const TDesC16 &

SummaryTitle

(

TInt

aIndex

)

const

Returns a summary title.

Parameters

TInt aIndex

Number of the setting item to read

UnregisterContextObserver(MWPContextObserver *)

IMPORT_C TInt

UnregisterContextObserver

(

MWPContextObserver *

aObserver

)

Unregister an observer to context information.

Parameters

MWPContextObserver * aObserver

The observer to unregister

Member Data Documentation

TBool iAccessDenied

TBool

iAccessDenied

[private]

CWPAdapterManager * iAdapters

CWPAdapterManager *

iAdapters

[private]

MWPContextManager * iManager

MWPContextManager *

iManager

[private]

CWPRoot * iRoot

CWPRoot *

iRoot

[private]