Collapse all Symbian^3 Application Developer Library

MPbkContactNameFormat Class Reference

class MPbkContactNameFormat

Public Member Functions
	~MPbkContactNameFormat ()
TInt	ContactListTitleLength (const MPbkFieldDataArray &)
TInt	ContactTitleLength (const MPbkFieldDataArray &)
const MPbkFieldDataArray &	FilterContactFieldsForFind (const MPbkFieldDataArray &)
const MPbkFieldDataArray &	FilterContactTitleFields (const MPbkFieldDataArray &)
HBufC *	FormatNameDescriptorL (const TDesC &)
void	GetContactListTitle (const MPbkFieldDataArray &, TDes &)
void	GetContactTitle (const MPbkFieldDataArray &, TDes &)
HBufC *	GetContactTitleL (const MPbkFieldDataArray &)
HBufC *	GetContactTitleOrNullL (const MPbkFieldDataArray &)
TBool	IsTitleField ( TPbkFieldId )
const TDesC &	UnnamedText ()

Constructor & Destructor Documentation

~MPbkContactNameFormat()

~MPbkContactNameFormat

(

)

[inline, virtual]

Virtual destructor.

Member Functions Documentation

ContactListTitleLength(const MPbkFieldDataArray &)

TInt

ContactListTitleLength

(

const MPbkFieldDataArray &

aContactData

)

const [pure virtual]

Calculates title text length for a contact. To be used in contact lists only, because the formatting does not remove leading spaces.

Parameters

const MPbkFieldDataArray & aContactData

a field data array representing the data in the contact.

ContactTitleLength(const MPbkFieldDataArray &)

TInt

ContactTitleLength

(

const MPbkFieldDataArray &

aContactData

)

const [pure virtual]

Calculates title text length for a contact

Parameters

const MPbkFieldDataArray & aContactData

a field data array representing the data in the contact.

FilterContactFieldsForFind(const MPbkFieldDataArray &)

const MPbkFieldDataArray &

FilterContactFieldsForFind

(

const MPbkFieldDataArray &

aContactData

)

const [pure virtual]

Returns filtered contact data which contains only fields that will be used in contact find.

Parameters

const MPbkFieldDataArray & aContactData

contact data to filter find fields from.

FilterContactTitleFields(const MPbkFieldDataArray &)

const MPbkFieldDataArray &

FilterContactTitleFields

(

const MPbkFieldDataArray &

aContactData

)

const [pure virtual]

Returns filtered contact data which contains only fields that will be used in contact name formatting.

Parameters

const MPbkFieldDataArray & aContactData

contact data to filter title fields from.

FormatNameDescriptorL(const TDesC &)

HBufC *

FormatNameDescriptorL

(

const TDesC &

aTitle

)

const [pure virtual]

Formats aTitle according to Phonebook name formatting rules.

Parameters

const TDesC & aTitle

GetContactListTitle(const MPbkFieldDataArray &, TDes &)

void	GetContactListTitle	(	const MPbkFieldDataArray &	aContactData,
			TDes &	aTitle
		)	const [pure virtual]

Gets a title text for a contact. To be used in contact lists only, because the formatting does not remove leading spaces.

ContactTitleLength aTitle.Length()==ContactListTitleLength(aContactData)

Parameters

const MPbkFieldDataArray & aContactData	a field data array representing the data in the contact.
TDes & aTitle	a buffer where the title text is formatted. The buffer must have enough capacity to hold the formatted title, otherwise this function will panic.

GetContactTitle(const MPbkFieldDataArray &, TDes &)

void	GetContactTitle	(	const MPbkFieldDataArray &	aContactData,
			TDes &	aTitle
		)	const [pure virtual]

Gets a title text for a contact.

ContactTitleLength aTitle.Length()==ContactTitleLength(aContactData)

Parameters

const MPbkFieldDataArray & aContactData	a field data array representing the data in the contact.
TDes & aTitle	a buffer where the title text is formatted. The buffer must have enough capacity to hold the formatted title, otherwise this function will panic.

GetContactTitleL(const MPbkFieldDataArray &)

HBufC *

GetContactTitleL

(

const MPbkFieldDataArray &

aContactData

)

const [pure virtual]

Gets a title text for a contact or qtn_phob_unnamed.

Parameters

const MPbkFieldDataArray & aContactData

a field data array representing the data in the contact.

GetContactTitleOrNullL(const MPbkFieldDataArray &)

HBufC *

GetContactTitleOrNullL

(

const MPbkFieldDataArray &

aContactData

)

const [pure virtual]

Gets a title text for a contact.

Parameters

const MPbkFieldDataArray & aContactData

a field data array representing the data in the contact.

IsTitleField(TPbkFieldId)

TBool

IsTitleField

(

TPbkFieldId

aFieldId

)

const [pure virtual]

Returns ETrue if field is part of the fields used to build the contact title.

GetContactTitleOrNullL

Parameters

TPbkFieldId aFieldId

id of field.

UnnamedText()

const TDesC &

UnnamedText

(

)

const [pure virtual]

Returns name text to use for unnamed contacts.