CPsSettings Class Reference

class CPsSettings : public CBase

Utility class to store settings for predictive search.

pcsutils.lib
Since
S60 v3.2

Inherits from

Constructor & Destructor Documentation

CPsSettings()

CPsSettings()[private]

Default Constructor

~CPsSettings()

IMPORT_C~CPsSettings()

Destructor.

Member Functions Documentation

CloneL()

IMPORT_C CPsSettings *CloneL()const

Creates a clone of the settings

ConstructL()

voidConstructL()[private]

Second phase constructor

DisplayFieldsL(RArray< TInt > &)

IMPORT_C voidDisplayFieldsL(RArray< TInt > &aDisplayFields)const

Parameters

RArray< TInt > & aDisplayFields

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)const [virtual]

Writes 'this' to the stream.

Parameters

RWriteStream & aStreamWriteStream with externalized contents.

GetGroupIdsL(RArray< TInt > &)

IMPORT_C voidGetGroupIdsL(RArray< TInt > &aGroupIdArray)

Returns the GroupId from the settings

Parameters

RArray< TInt > & aGroupIdArray

GetSortType()

IMPORT_C TSortTypeGetSortType()const

Returns the sort type

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)[virtual]

Initializes 'this' from stream.

Parameters

RReadStream & aStreamReadStream with data contents to be internalized.

MaxResults()

IMPORT_C TIntMaxResults()const

Returns the maximum number of elements (contacts) to be given to client.

NewL()

IMPORT_C CPsSettings *NewL()[static]

Two phase construction.

SearchUrisL(RPointerArray< TDesC > &)

IMPORT_C voidSearchUrisL(RPointerArray< TDesC > &aSearchUri)const

Returns the list of URIs configured to search from.

Parameters

RPointerArray< TDesC > & aSearchUri

SetDisplayFieldsL(const RArray< TInt > &)

IMPORT_C voidSetDisplayFieldsL(const RArray< TInt > &aDisplayFields)

Sets the list of fields to display.

Parameters

const RArray< TInt > & aDisplayFieldsThe list of fields to display.

SetMaxResults(const TInt)

IMPORT_C voidSetMaxResults(const TIntaMaxResults)

Sets the maximum number of elements (contacts) to be given to client. If number is set to -1: The entire search result will be returned. Otherwise: Top N search results will be returned

Parameters

const TInt aMaxResultsThe maximum number of elements.

SetSearchUrisL(const RPointerArray< TDesC > &)

IMPORT_C voidSetSearchUrisL(const RPointerArray< TDesC > &aSearchUri)

Sets the list of URIs to search from.

Parameters

const RPointerArray< TDesC > & aSearchUriThe list of database URIs to be searched.

SetSortType(const TSortType)

IMPORT_C voidSetSortType(const TSortTypeaSortType)

Sets the sort type based on which sorting will be done

Parameters

const TSortType aSortType

Member Data Documentation

RArray< TInt > iDisplayFields

RArray< TInt >iDisplayFields[private]

Display fields

TInt iMaxResults

TInt iMaxResults[private]

Maximum number of results that will be displayed to the client (Top N contacts will be displayed)

RPointerArray< TDesC > iSearchUri

RPointerArray< TDesC >iSearchUri[private]

Database URIs

TSortType iSortType

TSortType iSortType[private]

Sort type whether to sort based on alphabets or on match patterns