Collapse all Symbian^3 Product Developer Library

CSearchQuery Class Reference

class CSearchQuery : public CBase

This class is encapsulates the search request

This class encapsulates search condition( what to search ) and in what all plugins to search( where to search )

searchutilities.lib

Inherits from

CSearchQuery
- CBase

Public Member Functions
	~CSearchQuery()
IMPORT_C const CSearchCondition &	Condition()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	GetTargetContent(RArray< TUid > &)
IMPORT_C CSearchQuery *	NewL()
IMPORT_C CSearchQuery *	NewL(RReadStream &)
IMPORT_C void	SetCondition(CSearchCondition *)
IMPORT_C void	SetSnippetSize(const TDesC8 &, const TDesC8 &)
IMPORT_C void	SetTargetContent(const RArray< TUid > &)
IMPORT_C void	SetTargetService(TUid)
IMPORT_C TUid	TargetService()

Private Member Functions
	CSearchQuery()
void	ConstructL(RReadStream &)

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
CSearchCondition *	iCondition
RArray< TUid >	iContentIdArray
TUid	iServiceId

Constructor & Destructor Documentation

CSearchQuery()

CSearchQuery

(

)

[private]

Constructor

~CSearchQuery()

~CSearchQuery

(

)

[virtual]

Destructor

Member Functions Documentation

Condition()

IMPORT_C const CSearchCondition &

Condition

(

)

const

Returns condition

ConstructL(RReadStream &)

void

ConstructL

(

RReadStream &

aStream

)

[private]

2nd phase constructor

Parameters

RReadStream & aStream

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Extrenalizes the object

Parameters

RWriteStream & aStream

- Stream

GetTargetContent(RArray< TUid > &)

IMPORT_C void

GetTargetContent

(

RArray< TUid > &

aContentIdArray

)

const

Get the target content that should be searched.

Parameters

RArray< TUid > & aContentIdArray

NewL()

IMPORT_C CSearchQuery *

NewL

(

)

[static]

1st phase constructor

NewL(RReadStream &)

IMPORT_C CSearchQuery *

NewL

(

RReadStream &

aStream

)

[static]

1st phase constructor

Parameters

RReadStream & aStream

SetCondition(CSearchCondition *)

IMPORT_C void

SetCondition

(

CSearchCondition *

aCondition

)

Sets the search condition. With this the search scope can be limited to match only the specified condition. Must be set before requesting for search.

Parameters

CSearchCondition * aCondition

SetSnippetSize(const TDesC8 &, const TDesC8 &)

IMPORT_C void	SetSnippetSize	(	const TDesC8 &	aFormat,
			const TDesC8 &	aSize
		)

Parameters

const TDesC8 & aFormat
const TDesC8 & aSize

SetTargetContent(const RArray< TUid > &)

IMPORT_C void

SetTargetContent

(

const RArray< TUid > &

aContentIdArray

)

Set the target content that should be searched. Must be set before requesting for search.

Parameters

const RArray< TUid > & aContentIdArray

- an array of Tuid

SetTargetService(TUid)

IMPORT_C void

SetTargetService

(

TUid

aServiceId

)

Set the service that the search should be limited to. This is optional. If not set, search is targeted to all services.

Parameters

TUid aServiceId

Uid of the service.

TargetService()

IMPORT_C TUid

TargetService

(

)

const

Get the service that the search should be limited to.

Member Data Documentation

CSearchCondition * iCondition

CSearchCondition *

iCondition

[private]

Search Condition( what to search )

RArray< TUid > iContentIdArray

RArray< TUid >

iContentIdArray

[private]

Array of content ids( where to search )

TUid iServiceId

TUid

iServiceId

[private]

Service Id