CVPbkSortOrder Class Reference

#include <app/CVPbkSortOrder.h>

class CVPbkSortOrder : public CBase

Inherits from

CVPbkSortOrder

Public Member Functions
	~CVPbkSortOrder()
TBool	ContainsSame(const MVPbkFieldType &)
const MVPbkFieldType &	FieldTypeAt(TInt)
TInt	FieldTypeCount()
const MVPbkFieldType *	Find(TInt)
const MVPbkFieldType *	FindMatch(const TVPbkFieldVersitProperty &, TInt)
const MVPbkFieldType *	FindMatch(TVPbkNonVersitFieldType)
TInt	MaxMatchPriority()
IMPORT_C CVPbkSortOrder *	NewL(TResourceReader &, const MVPbkFieldTypeList &)
IMPORT_C CVPbkSortOrder *	NewL(const MVPbkFieldTypeList &)
IMPORT_C void	Set(const MVPbkFieldTypeList &)
IMPORT_C void	SetReserveL(TInt)

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

Detailed Description

Virtual Phonebook sort order. This class can be used to create a sort order, which is needed when creating Virtual Phonebook views. The sort order determines how the view is sorted by setting a field type priority list.

Constructor & Destructor Documentation

~CVPbkSortOrder ( )

~CVPbkSortOrder

(

)

Destructor.

Member Function Documentation

ContainsSame ( const MVPbkFieldType & )

TBool

ContainsSame

(

const MVPbkFieldType &

aFieldType

)

const

FieldTypeAt ( TInt )

const MVPbkFieldType &

FieldTypeAt

(

TInt

aIndex

)

const

FieldTypeCount ( )

TInt

FieldTypeCount

(

)

const

Find ( TInt )

const MVPbkFieldType *

Find

(

TInt

aFieldTypeResId

)

const

FindMatch ( const TVPbkFieldVersitProperty &, TInt )

const MVPbkFieldType *	FindMatch	(	const TVPbkFieldVersitProperty &	aMatchProperty,
			TInt	aMatchPriority
		)	const

FindMatch ( TVPbkNonVersitFieldType )

const MVPbkFieldType *

FindMatch

(

TVPbkNonVersitFieldType

aNonVersitType

)

const

MaxMatchPriority ( )

TInt

MaxMatchPriority

(

)

const

NewL ( TResourceReader &, const MVPbkFieldTypeList & )

IMPORT_C CVPbkSortOrder *	NewL	(	TResourceReader &	aReader,
			const MVPbkFieldTypeList &	aMasterFieldTypeList
		)	[static]

Constructs new sort order from a VPBK_FIELD_TYPE_MAPPING_LIST resource.

Exceptions

KErrNotFound

if a matching field type is not found from aFieldTypeList.

Parameter	Description
aReader	Resource reader pointing to a VPBK_FIELD_TYPE_MAPPING_LIST resource.
aMasterFieldTypeList	Master field type list types from the resource are mapped against.

NewL ( const MVPbkFieldTypeList & )

IMPORT_C CVPbkSortOrder *

NewL

(

const MVPbkFieldTypeList &

aSortOrder

)

[static]

Creates a new sort order from an existing one.

Parameter	Description
aSortOrder	The sort order to duplicate.

Set ( const MVPbkFieldTypeList & )

IMPORT_C void

Set

(

const MVPbkFieldTypeList &

aSortOrder

)

Sets new fields types for this sort order from the list. This will not leave because SetReserveL has to be called in advance to reserve space for sort order field types.

Parameter	Description
aSortOrder	Priority ordered list of field types used as the sort order. SetReserveL called with a proper sort order length.

SetReserveL ( TInt )

IMPORT_C void

SetReserveL

(

TInt

aSortOrderLength

)

Reserves aSortOrderLength items for the sort order length. This quarantees that following Set() call will not leave because of memory allocation failure. If more than aSortOrderLength items are provided in following Set() calls, rest of the field types are ignored.

Exceptions

Panics

if aSortOrderLength <= 0

Parameter	Description
aSortOrderLength	Number of field types to reserve space for.