Collapse all Symbian^3 Product Developer Library

CPcsPlugin Class Reference

class CPcsPlugin : public CBase

Search plug-ins (Ecom) interface definition.

Inherits from

CPcsPlugin
- CBase

Public Member Functions
	~CPcsPlugin()
void	ChangeSortOrderL(TDesC &, RArray< TInt > &)
void	GetAdaptiveGridL(const MDesCArray &, const TBool, TDes &)
void	GetDataOrderL(TDesC &, RArray< TInt > &)
void	GetSortOrderL(TDesC &, RArray< TInt > &)
TBool	IsLanguageSupportedL(const TUint32)
CPcsPlugin *	NewL(TUid)
CPcsPlugin *	NewLC(TUid)
void	PerformSearchL(const CPsSettings &, CPsQuery &, RPointerArray< CPsClientData > &, RPointerArray< CPsPattern > &)
TUid	PluginId()
void	SearchInputL(CPsQuery &, TDesC &, RPointerArray< TDesC > &, RArray< TPsMatchLocation > &)
void	SearchMatchStringL(CPsQuery &, TDesC &, TDes &)

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

Constructor & Destructor Documentation

~CPcsPlugin()

~CPcsPlugin

(

)

[inline, virtual]

Destructor

Member Functions Documentation

ChangeSortOrderL(TDesC &, RArray< TInt > &)

void	ChangeSortOrderL	(	TDesC &	aURI,
			RArray< TInt > &	aDataOrder
		)	[pure virtual]

Set the sort order (mapped to VPbk ids) supported for a URI

Parameters

TDesC & aURI
RArray< TInt > & aDataOrder

GetAdaptiveGridL(const MDesCArray &, const TBool, TDes &)

void	GetAdaptiveGridL	(	const MDesCArray &	aURIs,
			const TBool	aCompanyName,
			TDes &	aAdaptiveGrid
		)	[pure virtual]

Returns the Adaptive Grid for one or more URI Implementation needs to be provided by the algorithm classes

Parameters

const MDesCArray & aURIs
const TBool aCompanyName
TDes & aAdaptiveGrid

GetDataOrderL(TDesC &, RArray< TInt > &)

void	GetDataOrderL	(	TDesC &	aURI,
			RArray< TInt > &	aDataOrder
		)	[pure virtual]

Get the data order (mapped to VPbk ids) supported for a URI

Parameters

TDesC & aURI
RArray< TInt > & aDataOrder

GetSortOrderL(TDesC &, RArray< TInt > &)

void	GetSortOrderL	(	TDesC &	aURI,
			RArray< TInt > &	aDataOrder
		)	[pure virtual]

Get the sort order (mapped to VPbk ids) supported for a URI

Parameters

TDesC & aURI
RArray< TInt > & aDataOrder

IsLanguageSupportedL(const TUint32)

TBool

IsLanguageSupportedL

(

const TUint32

aLanguage

)

[pure virtual]

Returns ETrue if the predictive search is supported for the local language Returns EFalse otherwise

Parameters

const TUint32 aLanguage

NewL(TUid)

CPcsPlugin *

NewL

(

TUid

aImpUid

)

[static, inline]

Ecom interface static factory method implementation.

Parameters

TUid aImpUid

Ecom's implementation uid

NewLC(TUid)

CPcsPlugin *

NewLC

(

TUid

aImpUid

)

[static, inline]

Ecom interface static factory method implementation.

Parameters

TUid aImpUid

Ecom's implementation uid

PerformSearchL(const CPsSettings &, CPsQuery &, RPointerArray< CPsClientData > &, RPointerArray< CPsPattern > &)

void	PerformSearchL	(	const CPsSettings &	aPcsSettings,
			CPsQuery &	aCondition,
			RPointerArray< CPsClientData > &	aData,
			RPointerArray< CPsPattern > &	aPattern
		)	[pure virtual]

Performs search Implementation needs to be provided by the algorithm classes. Search results are packed in the stream.

Parameters

const CPsSettings & aPcsSettings
CPsQuery & aCondition
RPointerArray< CPsClientData > & aData
RPointerArray< CPsPattern > & aPattern

PluginId()

TUid

PluginId

(

)

const [inline]

Gets the plugin id.

SearchInputL(CPsQuery &, TDesC &, RPointerArray< TDesC > &, RArray< TPsMatchLocation > &)

void	SearchInputL	(	CPsQuery &	aSearchQuery,
			TDesC &	aSearchData,
			RPointerArray< TDesC > &	aMatchSet,
			RArray< TPsMatchLocation > &	aMatchLocation
		)	[pure virtual]

Performs search on a input string Implementation needs to be provided by the algorithm classes

Parameters

CPsQuery & aSearchQuery
TDesC & aSearchData
RPointerArray< TDesC > & aMatchSet
RArray< TPsMatchLocation > & aMatchLocation

SearchMatchStringL(CPsQuery &, TDesC &, TDes &)

void	SearchMatchStringL	(	CPsQuery &	aSearchQuery,
			TDesC &	aSearchData,
			TDes &	aMatch
		)	[pure virtual]

Performs search on a input string, and return result also as a string Implementation needs to be provided by the algorithm classes

Parameters

CPsQuery & aSearchQuery
TDesC & aSearchData
TDes & aMatch

Member Data Documentation

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[private]

TUid iPluginId

TUid

iPluginId

[private]