Collapse all Symbian^3 Application Developer Library

CPsSettings Class Reference

class CPsSettings : public CBase

Utility class to store settings for predictive search.

pcsutils.lib

Since: S60 v3.2

Inherits from

CPsSettings
- CBase

Public Member Functions
	~CPsSettings ()
IMPORT_C CPsSettings *	CloneL ()
IMPORT_C void	DisplayFieldsL ( RArray < TInt > &)
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C void	GetGroupIdsL ( RArray < TInt > &)
IMPORT_C TSortType	GetSortType ()
IMPORT_C void	InternalizeL ( RReadStream &)
IMPORT_C TInt	MaxResults ()
IMPORT_C CPsSettings *	NewL ()
IMPORT_C void	SearchUrisL ( RPointerArray < TDesC > &)
IMPORT_C void	SetDisplayFieldsL (const RArray < TInt > &)
IMPORT_C void	SetMaxResults (const TInt )
IMPORT_C void	SetSearchUrisL (const RPointerArray < TDesC > &)
IMPORT_C void	SetSortType (const TSortType )

Private Member Functions
	CPsSettings ()
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
RArray < TInt >	iDisplayFields
TInt	iMaxResults
RPointerArray < TDesC >	iSearchUri
TSortType	iSortType

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()

void

ConstructL

(

)

[private]

Second phase constructor

DisplayFieldsL(RArray< TInt > &)

IMPORT_C void

DisplayFieldsL

(

RArray < TInt > &

aDisplayFields

)

const

Parameters

RArray < TInt > & aDisplayFields

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Writes 'this' to the stream.

Parameters

RWriteStream & aStream

WriteStream with externalized contents.

GetGroupIdsL(RArray< TInt > &)

IMPORT_C void

GetGroupIdsL

(

RArray < TInt > &

aGroupIdArray

)

Returns the GroupId from the settings

Parameters

RArray < TInt > & aGroupIdArray

GetSortType()

IMPORT_C TSortType

GetSortType

(

)

const

Returns the sort type

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

[virtual]

Initializes 'this' from stream.

Parameters

RReadStream & aStream

ReadStream with data contents to be internalized.

MaxResults()

IMPORT_C TInt

MaxResults

(

)

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 void

SearchUrisL

(

RPointerArray < TDesC > &

aSearchUri

)

const

Returns the list of URIs configured to search from.

Parameters

RPointerArray < TDesC > & aSearchUri

SetDisplayFieldsL(const RArray< TInt > &)

IMPORT_C void

SetDisplayFieldsL

(

const RArray < TInt > &

aDisplayFields

)

Sets the list of fields to display.

Parameters

const RArray < TInt > & aDisplayFields

The list of fields to display.

SetMaxResults(const TInt)

IMPORT_C void

SetMaxResults

(

const TInt

aMaxResults

)

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 aMaxResults

The maximum number of elements.

SetSearchUrisL(const RPointerArray< TDesC > &)

IMPORT_C void

SetSearchUrisL

(

const RPointerArray < TDesC > &

aSearchUri

)

Sets the list of URIs to search from.

Parameters

const RPointerArray < TDesC > & aSearchUri

The list of database URIs to be searched.

SetSortType(const TSortType)

IMPORT_C void

SetSortType

(

const TSortType

aSortType

)

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