Collapse all Symbian^3 Application Developer Library

CPsQuery Class Reference

class CPsQuery : public CBase

Utility class to hold the search sequence for predictive search. The Max length of search sequence = KPsQueryMaxLen.

pcsutils.lib

Since: S60 v3.2

Inherits from

CPsQuery
- CBase

Public Member Functions
	~CPsQuery ()
IMPORT_C void	AppendL (const CPsQueryItem &)
IMPORT_C TInt	Count ()
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C CPsQueryItem &	GetItemAtL ( TInt )
IMPORT_C void	InsertL (const CPsQueryItem &, TInt )
IMPORT_C void	InternalizeL ( RReadStream &)
IMPORT_C TKeyboardModes	KeyboardModeL ()
IMPORT_C CPsQuery *	NewL ()
IMPORT_C void	PrintQuery ()
IMPORT_C TDesC &	QueryAsStringLC ()
IMPORT_C void	Remove ( TInt )
IMPORT_C void	Reset ()

Private Member Functions
	CPsQuery ()
void	ConstructL ()

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
RPointerArray < CPsQueryItem >	iSearchQuery

Constructor & Destructor Documentation

CPsQuery()

CPsQuery

(

)

[private]

Default Constructor

~CPsQuery()

IMPORT_C

~CPsQuery

(

)

Destructor

Member Functions Documentation

AppendL(const CPsQueryItem &)

IMPORT_C void

AppendL

(

const CPsQueryItem &

aQueryItem

)

Appends a query item to the search sequence (if the current length < KPsQueryMaxLen)

Parameters

const CPsQueryItem & aQueryItem

The object pointer to be appended

ConstructL()

void

ConstructL

(

)

[private]

Second phase constructor

Count()

IMPORT_C TInt

Count

(

)

Returns the length of the query

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Writes 'this' to the stream

Parameters

RWriteStream & aStream

WriteStream with externalized contents

GetItemAtL(TInt)

IMPORT_C CPsQueryItem &

GetItemAtL

(

TInt

aIndex

)

Returns the query item at the specified index

Parameters

TInt aIndex

InsertL(const CPsQueryItem &, TInt)

IMPORT_C void	InsertL	(	const CPsQueryItem &	aQueryItem,
			TInt	aIndex
		)

Insert a query item to the search sequence (if the current length < KPsQueryMaxLen)

Parameters

const CPsQueryItem & aQueryItem	The object pointer to be inserted
TInt aIndex	The position within the array where the object pointer is to be inserted

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

[virtual]

Initializes 'this' from stream

Parameters

RReadStream & aStream

ReadStream with data contents to be internalized

KeyboardModeL()

IMPORT_C TKeyboardModes

KeyboardModeL

(

)

Returns the keyboard input mode for the search query if all the keys are entered in the same mode then returns the mode e.g. ITU-T, QWERTY else returns unspecified mode

NewL()

IMPORT_C CPsQuery *

NewL

(

)

[static]

Two phase construction

PrintQuery()

IMPORT_C void

PrintQuery

(

)

Prints the query as array of query items Used only for debugging.

QueryAsStringLC()

IMPORT_C TDesC &

QueryAsStringLC

(

)

Returns the search sequence as a single string (This does not return the keyboard mode)

Remove(TInt)

IMPORT_C void

Remove

(

TInt

aIndex

)

Removes the query item at the specified index

Parameters

TInt aIndex

The position within the array from where the object pointer is to be removed.

Reset()

IMPORT_C void

Reset

(

)

Deletes the entire search query

Member Data Documentation

RPointerArray< CPsQueryItem > iSearchQuery

RPointerArray < CPsQueryItem >

iSearchQuery

[private]

The search query.