Collapse all Symbian^3 Application Developer Library

MPbk2ContactNameFormatter Class Reference

class MPbk2ContactNameFormatter

Abstract Phonebook 2 contact name formatter interface.

Public Member Functions
	~MPbk2ContactNameFormatter ()
CVPbkBaseContactFieldTypeListIterator *	ActualTitleFieldsLC ( CVPbkFieldTypeRefsList &, const MVPbkBaseContactFieldCollection &)
TAny *	ContactNameFormatterExtension ( TUid )
void	GetContactTitle (const MVPbkBaseContactFieldCollection &, TDes &, TUint32 )
void	GetContactTitleForFind (const MVPbkBaseContactFieldCollection &, TDes &, TUint32 )
HBufC *	GetContactTitleL (const MVPbkBaseContactFieldCollection &, TUint32 )
HBufC *	GetContactTitleOrNullL (const MVPbkBaseContactFieldCollection &, TUint32 )
TBool	IsFindSeparatorChar ( TChar )
TBool	IsTitleField (const MVPbkBaseContactField &)
TBool	IsTitleFieldType (const MVPbkFieldType &)
TInt	MaxTitleLength (const MVPbkBaseContactFieldCollection &, const TUint32 )
TInt	MaxTitleLengthForFind (const MVPbkBaseContactFieldCollection &, const TUint32 )
const TDesC &	UnnamedText ()

Public Member Enumerations
enum	TPbk2ContactTitleFormattingFlags { EPreserveLeadingSpaces = 0x0001, EUseSeparator = 0x0002, EReplaceNonGraphicChars = 0x0004, EPreserveAllOriginalSpaces = 0x0008, EDisableCompanyNameSeparator = 0x0010 }

Constructor & Destructor Documentation

~MPbk2ContactNameFormatter()

~MPbk2ContactNameFormatter

(

)

[inline, virtual]

Destructor.

Member Functions Documentation

ActualTitleFieldsLC(CVPbkFieldTypeRefsList &, const MVPbkBaseContactFieldCollection &)

CVPbkBaseContactFieldTypeListIterator *	ActualTitleFieldsLC	(	CVPbkFieldTypeRefsList &	aFieldTypeList,
			const MVPbkBaseContactFieldCollection &	aContactFields
		)	[pure virtual]

Return iterator that contains all fields that are used for making the formatted name.

Parameters

CVPbkFieldTypeRefsList & aFieldTypeList	Field type list that is used to store field types for the iterator. The list will be resetted before use.
const MVPbkBaseContactFieldCollection & aContactFields	Field collection representing the data in a contact.

ContactNameFormatterExtension(TUid)

TAny *

ContactNameFormatterExtension

(

TUid

)

[inline, virtual]

Returns an extension point for this interface or NULL.

Parameters

TUid

GetContactTitle(const MVPbkBaseContactFieldCollection &, TDes &, TUint32)

void	GetContactTitle	(	const MVPbkBaseContactFieldCollection &	aContactFields,
			TDes &	aTitle,
			TUint32	aFormattingFlags
		)	[pure virtual]

Returns the title text for a contact.

TPbk2ContactTitleFormattingFlags

Parameters

const MVPbkBaseContactFieldCollection & aContactFields	Field collection representing the data in a contact.
TDes & aTitle	Buffer containing the formatted title.
TUint32 aFormattingFlags

GetContactTitleForFind(const MVPbkBaseContactFieldCollection &, TDes &, TUint32)

void	GetContactTitleForFind	(	const MVPbkBaseContactFieldCollection &	aContactFields,
			TDes &	aTitle,
			TUint32	aFormattingFlags
		)	[pure virtual]

Returns the title text for a contact. Unlike GetContactTitle, this method will build the title using all the possible fields (not restricting the field count). Should not be used for regular name formatting needs.

TPbk2ContactTitleFormattingFlags

Parameters

const MVPbkBaseContactFieldCollection & aContactFields	Field collection representing the data in a contact.
TDes & aTitle	Buffer containing the formatted title.
TUint32 aFormattingFlags

GetContactTitleL(const MVPbkBaseContactFieldCollection &, TUint32)

HBufC *	GetContactTitleL	(	const MVPbkBaseContactFieldCollection &	aContactFields,
			TUint32	aFormattingFlags
		)	[pure virtual]

Returns the title text for a contact.

Parameters

const MVPbkBaseContactFieldCollection & aContactFields	Field collection representing the data in a contact.
TUint32 aFormattingFlags	Formatting flags, see TPbk2ContactTitleFormattingFlags.

GetContactTitleOrNullL(const MVPbkBaseContactFieldCollection &, TUint32)

HBufC *	GetContactTitleOrNullL	(	const MVPbkBaseContactFieldCollection &	aContactFields,
			TUint32	aFormattingFlags
		)	[pure virtual]

Returns the title text for a contact.

TPbk2ContactTitleFormattingFlags

Parameters

const MVPbkBaseContactFieldCollection & aContactFields	Field collection representing the data in a contact.
TUint32 aFormattingFlags

IsFindSeparatorChar(TChar)

TBool

IsFindSeparatorChar

(

TChar

aCh

)

[pure virtual]

Checks whether the given character is a separator character.

Parameters

TChar aCh

IsTitleField(const MVPbkBaseContactField &)

TBool

IsTitleField

(

const MVPbkBaseContactField &

aContactField

)

const [pure virtual]

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

Parameters

const MVPbkBaseContactField & aContactField

The contact field to inspect.

IsTitleFieldType(const MVPbkFieldType &)

TBool

IsTitleFieldType

(

const MVPbkFieldType &

aFieldType

)

const [pure virtual]

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

Parameters

const MVPbkFieldType & aFieldType

Type of the field to inspect.

MaxTitleLength(const MVPbkBaseContactFieldCollection &, const TUint32)

TInt	MaxTitleLength	(	const MVPbkBaseContactFieldCollection &	aContactFields,
			const TUint32	aFormattingFlags
		)	[pure virtual]

Returns the length of the formatted name.

TPbk2ContactTitleFormattingFlags

Parameters

const MVPbkBaseContactFieldCollection & aContactFields	Field collection representing the data in a contact.
const TUint32 aFormattingFlags

MaxTitleLengthForFind(const MVPbkBaseContactFieldCollection &, const TUint32)

TInt	MaxTitleLengthForFind	(	const MVPbkBaseContactFieldCollection &	aContactFields,
			const TUint32	aFormattingFlags
		)	[pure virtual]

Returns the length of the formatted name. Unlike MaxTitleLength, this method will count the length using all the possible fields (not restricting the field count). Should not be used for regular name formatting needs.

TPbk2ContactTitleFormattingFlags

Parameters

const MVPbkBaseContactFieldCollection & aContactFields	Field collection representing the data in a contact.
const TUint32 aFormattingFlags

UnnamedText()

const TDesC &

UnnamedText

(

)

const [pure virtual]

Returns the name text to be used for unnamed contacts.

Member Enumerations Documentation

Enum TPbk2ContactTitleFormattingFlags

Enumerators

EPreserveLeadingSpaces = 0x0001	Formatter preserves all leading spaces in the formatted title
EUseSeparator = 0x0002	Formatter uses custom separator for separating firstname and lastname
EReplaceNonGraphicChars = 0x0004	Formatter replaces all non-graphical characters with space character
EPreserveAllOriginalSpaces = 0x0008
EDisableCompanyNameSeparator = 0x0010	Formatter by default uses coma separator for separating company name