Collapse all Symbian^3 Application Developer Library

CPbk2SortOrderManager Class Reference

class CPbk2SortOrderManager : public CBase

Phonebook 2 sort order manager. Responsible for managing the sort order of the contacts in a contact view.

Inherits from

CPbk2SortOrderManager
- CBase

Public Member Functions
	~CPbk2SortOrderManager ()
IMPORT_C void	AddObserverL ( MPbk2SortOrderObserver &)
IMPORT_C const TDesC &	CurrentSeparator ()
IMPORT_C const TDesC &	DefaultSeparator ()
IMPORT_C TPbk2NameDisplayOrder	NameDisplayOrder ()
IMPORT_C CPbk2SortOrderManager *	NewL (const MVPbkFieldTypeList &, RFs *)
IMPORT_C void	RemoveObserver ( MPbk2SortOrderObserver &)
IMPORT_C void	SetContactViewL ( MVPbkContactViewBase &)
IMPORT_C void	SetNameDisplayOrderL ( TPbk2NameDisplayOrder , const TDesC &)
IMPORT_C const MVPbkFieldTypeList &	SortOrder ()

Private Member Functions
void	ConstructL (const MVPbkFieldTypeList &, RFs *)

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	TPbk2NameDisplayOrder { EPbk2NameDisplayOrderLastNameFirstName , EPbk2NameDisplayOrderFirstNameLastName , EPbk2NameDisplayOrderLastNameSeparatorFirstName }

Private Attributes
CPbk2SortOrderManagerImpl *	iImpl

Constructor & Destructor Documentation

~CPbk2SortOrderManager()

~CPbk2SortOrderManager

(

)

Destructor.

Member Functions Documentation

AddObserverL(MPbk2SortOrderObserver &)

IMPORT_C void

AddObserverL

(

MPbk2SortOrderObserver &

aObserver

)

Adds an observer.

Parameters

MPbk2SortOrderObserver & aObserver

The observer to add.

ConstructL(const MVPbkFieldTypeList &, RFs *)

void	ConstructL	(	const MVPbkFieldTypeList &	aMasterFieldTypeList,
			RFs *	aFs
		)	[private, inline]

Parameters

const MVPbkFieldTypeList & aMasterFieldTypeList
RFs * aFs

CurrentSeparator()

IMPORT_C const TDesC &

CurrentSeparator

(

)

const

Returns the current separator. This the separator that can be changed run time and saved to Central Repository.

DefaultSeparator()

IMPORT_C const TDesC &

DefaultSeparator

(

)

Returns the language specific default separator. This can not be changed run time.

NameDisplayOrder()

IMPORT_C TPbk2NameDisplayOrder

NameDisplayOrder

(

)

const

Returns the current name display order.

NewL(const MVPbkFieldTypeList &, RFs *)

IMPORT_C CPbk2SortOrderManager *	NewL	(	const MVPbkFieldTypeList &	aMasterFieldTypeList,
			RFs *	aFs = NULL
		)	[static]

Creates a new instance of this class.

Parameters

const MVPbkFieldTypeList & aMasterFieldTypeList	Master field type list. Can be retrieved from Virtual Phonebook contact manager.
RFs * aFs = NULL	A file system session reference for resource file handling. If NULL then an own session is created.

RemoveObserver(MPbk2SortOrderObserver &)

IMPORT_C void

RemoveObserver

(

MPbk2SortOrderObserver &

aObserver

)

Removes an observer.

Parameters

MPbk2SortOrderObserver & aObserver

The observer to remove.

SetContactViewL(MVPbkContactViewBase &)

IMPORT_C void

SetContactViewL

(

MVPbkContactViewBase &

aContactView

)

Sets the contact view that this manager manages. Takes in use the sort order from the given view.

Parameters

MVPbkContactViewBase & aContactView

The contact view to manage.

SetNameDisplayOrderL(TPbk2NameDisplayOrder, const TDesC &)

IMPORT_C void	SetNameDisplayOrderL	(	TPbk2NameDisplayOrder	aNameDisplayOrder,
			const TDesC &	aSeparator = KNullDesC
		)

Sets the name displaying order for the managed contact view.

Parameters

TPbk2NameDisplayOrder aNameDisplayOrder	New name display order for the managed contact view.
const TDesC & aSeparator = KNullDesC	Custom separator to be used between lastname and firstname if it exists. If KNullDesC is given, space is used as separator.

SortOrder()

IMPORT_C const MVPbkFieldTypeList &

SortOrder

(

)

const

Returns the current sort order.

Member Enumerations Documentation

Enum TPbk2NameDisplayOrder

Enumerators

EPbk2NameDisplayOrderLastNameFirstName
EPbk2NameDisplayOrderFirstNameLastName
EPbk2NameDisplayOrderLastNameSeparatorFirstName

Member Data Documentation

CPbk2SortOrderManagerImpl * iImpl

CPbk2SortOrderManagerImpl *

iImpl

[private]