Collapse all Symbian^3 Application Developer Library

CViewContactSortPlugin Class Reference

class CViewContactSortPlugin : public CBase

An interface class that enables implementers to configure the way in which contacts are sorted in a contact view.

This is an abstract base class that will be derived from.

Inherits from

CViewContactSortPlugin
- CBase

Public Member Functions
	~CViewContactSortPlugin ()
CViewContactSortPlugin *	NewL ( TSortPluginParams *)
void	SetSortOrderL (const RContactViewSortOrder &)
TInt	SortCompareViewContactsL (const CViewContact &, const CViewContact &)
void	SortCompleted ()
TInt	SortStart ( TSortStartTypes , TInt )
TBool	ViewContactIsSortable (const CViewContact &)

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

Public Member Enumerations
enum	TSortStartTypes { ESortNull = 0, ESortStartFull , ESortStartInsertOne , ESortStartInsertMultiple }

Private Attributes
TUid	iDtor_ID_Key

Constructor & Destructor Documentation

~CViewContactSortPlugin()

~CViewContactSortPlugin

(

)

[inline, virtual]

Virtual destructor.

Member Functions Documentation

NewL(TSortPluginParams *)

CViewContactSortPlugin *

NewL

(

TSortPluginParams *

aParams

)

[static, inline]

Allocates and constructs a sort plug-in instance.

Parameters

TSortPluginParams * aParams

The sort plug-in's parameters.

SetSortOrderL(const RContactViewSortOrder &)

void

SetSortOrderL

(

const RContactViewSortOrder &

aViewSortOrder

)

[pure virtual]

Called by a contact view to pass the sort plug-in the required sort order. Any processing of the order information is done here.

This function is called when the view is created and when a different sort order is requested.

Parameters

const RContactViewSortOrder & aViewSortOrder

The requested sort order.

SortCompareViewContactsL(const CViewContact &, const CViewContact &)

TInt	SortCompareViewContactsL	(	const CViewContact &	aLhs,
			const CViewContact &	aRhs
		)	[pure virtual]

Called by a contact view to compare two CViewContact items for sorting in the view.

If TDesC::CompareC() is used to implement this function, the return value from TDesC::CompareC() can be used directly.

Parameters

const CViewContact & aLhs	The first item to compare.
const CViewContact & aRhs	The second item to compare.

SortCompleted()

void

SortCompleted

(

)

[pure virtual]

Called by a contact view to notify the sort plug-in that sorting is complete.

SortStart(TSortStartTypes, TInt)

TInt	SortStart	(	TSortStartTypes	aSortStartType,
			TInt	aCount
		)	[pure virtual]

Called by a contact view to notify the sort plug-in that sorting is about to start.

Parameters

TSortStartTypes aSortStartType	Indicates the type of sort operation required.
TInt aCount	The approximate number of contacts to be processed.

ViewContactIsSortable(const CViewContact &)

TBool

ViewContactIsSortable

(

const CViewContact &

aViewContact

)

[pure virtual]

Tests whether a CViewContact is sortable.

For instance, a contact may be unsortable if none of the fields used to sort on contain any data.

Parameters

const CViewContact & aViewContact

The view contact to test.

Member Enumerations Documentation

Enum TSortStartTypes

Identifies the type of sort operation to SortStart() .

Enumerators

ESortNull = 0	No sort is in progress.
ESortStartFull	A full sort or re-sort.
ESortStartInsertOne	A single contact has been inserted or changed.
ESortStartInsertMultiple	Multiple contacts have been added. For example, ICC contacts arrived in a mixed view (one that also includes contacts from the phone's memory).

Member Data Documentation

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[private]