Collapse all Symbian^3 Application Developer Library

CSearchPlugin Class Reference

class CSearchPlugin : public CBase

Search plug-ins (Ecom) interface definition.

Inherits from

CSearchPlugin
- CBase

Public Member Functions
	~CSearchPlugin ()
MSearchContentSearcher *	ContentSearcherL (const RArray < TUid > &, const CSearchCondition &, MSearchPluginObserver &)
void	GetSupportedContentL ( RPointerArray < CSearchContent > &)
TBool	IsSupportedContent ( TUid )
void	LaunchApplicationL (const TDesC8 &)
void	ListAllImplementationsL ( RImplInfoPtrArray &)
CSearchPlugin *	NewL ( TUid )
CSearchPlugin *	NewLC ( TUid )
TUid	PluginId ()
TAny *	SearchPluginExtensionL ( TUid )
TUid	ServiceId ()

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
TInt32	iExtension1
TInt32	iExtension2
TUid	iPluginId

Constructor & Destructor Documentation

~CSearchPlugin()

~CSearchPlugin

(

)

[inline, virtual]

Destructor

Member Functions Documentation

ContentSearcherL(const RArray< TUid > &, const CSearchCondition &, MSearchPluginObserver &)

MSearchContentSearcher *	ContentSearcherL	(	const RArray < TUid > &	aContentIdArray,
			const CSearchCondition &	aCondition,
			MSearchPluginObserver &	aObserver
		)	[pure virtual]

Get a content searcher.

Parameters

const RArray < TUid > & aContentIdArray	Content to be searched for.
const CSearchCondition & aCondition	The conditions that must be fullfilled.
MSearchPluginObserver & aObserver

GetSupportedContentL(RPointerArray< CSearchContent > &)

void

GetSupportedContentL

(

RPointerArray < CSearchContent > &

aContent

)

[pure virtual]

Returns the supported content of this plugin.

Parameters

RPointerArray < CSearchContent > & aContent

The content that this plugin can search.

IsSupportedContent(TUid)

TBool

IsSupportedContent

(

TUid

aContentId

)

[pure virtual]

Indicates if this plugin supports the searching of the given content.

Parameters

TUid aContentId

Id of the search content. Can be either class or a folder.

LaunchApplicationL(const TDesC8 &)

void

LaunchApplicationL

(

const TDesC8 &

aLaunchInfo

)

[pure virtual]

Launches a viewer/editor application for the given document id.

Parameters

const TDesC8 & aLaunchInfo

ListAllImplementationsL(RImplInfoPtrArray &)

void

ListAllImplementationsL

(

RImplInfoPtrArray &

aImplInfoArray

)

[static, inline]

Lists all implementations which satisfy this ecom interface.

Parameters

RImplInfoPtrArray & aImplInfoArray

On return, contains the list of available implementations

NewL(TUid)

CSearchPlugin *

NewL

(

TUid

aImpUid

)

[static, inline]

Ecom interface static factory method implementation.

Parameters

TUid aImpUid

Ecom's implementation uid

NewLC(TUid)

CSearchPlugin *

NewLC

(

TUid

aImpUid

)

[static, inline]

Ecom interface static factory method implementation.

Parameters

TUid aImpUid

Ecom's implementation uid

PluginId()

TUid

PluginId

(

)

const [inline]

Gets the plugin id.

SearchPluginExtensionL(TUid)

TAny *

SearchPluginExtensionL

(

TUid

)

[inline, virtual]

Returns the extension for this interface. If no extension is available, return NULL.

Parameters

TUid

ServiceId()

TUid

ServiceId

(

)

const [inline, virtual]

Gets the service id.

Member Data Documentation

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[private]

TInt32 iExtension1

TInt32

iExtension1

[private]

TInt32 iExtension2

TInt32

iExtension2

[private]

TUid iPluginId

TUid

iPluginId

[private]