Collapse all Symbian^3 Product Developer Library

CContextPlugin Class Reference

class CContextPlugin : public CBase

This class implements the context plugin interface.

Inherits from

CContextPlugin
- CBase

Public Member Functions
	~CContextPlugin()
void	ContextSnapshot(MContextPluginObserver &, CHarvesterData &)
void	ContextSnapshot(MContextPluginObserver &, RPointerArray< CHarvesterData > &)
void	Init(MContextPluginObserver &)
IMPORT_C void	ListImplementationsL(RImplInfoPtrArray &)
IMPORT_C CContextPlugin *	NewL(const TUid &)
void	SetMdeSession(CMdESession &)

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
TUid	iDtor_ID_Key

Constructor & Destructor Documentation

~CContextPlugin()

IMPORT_C

~CContextPlugin

(

)

[virtual]

Destroys the implementation. This is virtual method and this class is not intended for derivation, so not exported.

Member Functions Documentation

ContextSnapshot(MContextPluginObserver &, CHarvesterData &)

void	ContextSnapshot	(	MContextPluginObserver &	aObserver,
			CHarvesterData &	aHD
		)	[pure virtual]

This pure virtual method takes the context snapshot for one metadata object and writes the information to the object received as parameter. The observer will be informed about the status of the operation.

Parameters

MContextPluginObserver & aObserver	An interface class to inform about finishing context snapshot.
CHarvesterData & aHD

ContextSnapshot(MContextPluginObserver &, RPointerArray< CHarvesterData > &)

void	ContextSnapshot	(	MContextPluginObserver &	aObserver,
			RPointerArray< CHarvesterData > &	aHDArray
		)	[pure virtual]

This pure virtual method takes the context snapshot for several metadata object and writes the information to the all the objects received as parameter. The observer will be informed about the status of the operation.

Parameters

MContextPluginObserver & aObserver	An interface class to inform about finishing context snapshot.
RPointerArray< CHarvesterData > & aHDArray

Init(MContextPluginObserver &)

void

Init

(

MContextPluginObserver &

aObserver

)

[pure virtual]

A pure virtual interface method to initialize the plug-in.

Parameters

MContextPluginObserver & aObserver

An interface class to inform about initialization completion.

ListImplementationsL(RImplInfoPtrArray &)

IMPORT_C void

ListImplementationsL

(

RImplInfoPtrArray &

aImplInfoArray

)

[static]

Lists all available implementations which implement this interface.

Parameters

RImplInfoPtrArray & aImplInfoArray

A list of existing implementations of the interface.

NewL(const TUid &)

IMPORT_C CContextPlugin *

NewL

(

const TUid &

aUid

)

[static]

Creates an implementation of a desired implementation defined by the parameter.

Parameters

const TUid & aUid

SetMdeSession(CMdESession &)

void

SetMdeSession

(

CMdESession &

aSession

)

[pure virtual]

Set a pointer to MdESession. Session is used to store harvested context data.

Parameters

CMdESession & aSession

Session pointer to set.

Member Data Documentation

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[private]

Instance identifier key. When instance of an implementation is created by ECOM framework, the framework will assign UID for it. The UID is used in destructor to notify framework that this instance is being destroyed and resources can be released.