CPbkFieldsInfo Class Reference

#include <app/CPbkFieldsInfo.h>

Link against: PbkEng.lib

class CPbkFieldsInfo : public CBase

Inherits from

CPbkFieldsInfo

Public Member Functions
	~CPbkFieldsInfo()
void	AddFieldTypesFromResourceL(TResourceReader &, TResourceReader &, RArray< const CPbkFieldInfo * > *)
IMPORT_C TInt	Count()
IMPORT_C CContactItemFieldDef *	CreateContactItemFieldDefLC(const CPbkFieldIdArray *)
IMPORT_C CContactItemViewDef *	CreateContactItemViewDefLC(const CPbkFieldIdArray &)
IMPORT_C TPbkMatchPriorityLevel	CreateMatchPriority()
IMPORT_C CPbkFieldInfo *	Find(TPbkFieldId)
IMPORT_C CPbkFieldInfo *	Find(TPbkFieldId, TPbkFieldLocation)
IMPORT_C CPbkFieldInfo *	Find(const CContactItemField &)
IMPORT_C const CPbkFieldInfoGroup &	GroupAt(TInt)
IMPORT_C TInt	GroupCount()
CPbkFieldInfo *	Match(const CContactItemField &, const TPbkMatchPriorityLevel &)
IMPORT_C CPbkFieldInfo *	Match(const MPbkVcardProperty &, const TPbkMatchPriorityLevel &)
CPbkFieldsInfo *	NewL(RResourceFile &, RResourceFile &)
IMPORT_C CPbkFieldInfo *	operator[](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

Phonebook field types collection class. The collection contains CPbkFieldInfo objects that contain Phonebook specific field type information. Each field Phonebook recognizes is associated with field info object. The field info objects are references to elements in this array.

Constructor & Destructor Documentation

~CPbkFieldsInfo ( )

~CPbkFieldsInfo

(

)

Destructor.

Member Function Documentation

AddFieldTypesFromResourceL ( TResourceReader &, TResourceReader &, RArray< const CPbkFieldInfo * > * )

void	AddFieldTypesFromResourceL	(	TResourceReader &	aPbkResReader,
			TResourceReader &	aCntModelResReader,
			RArray< const CPbkFieldInfo * > *	aAddedFieldTypes
		)

Adds fields from resource readers. Doesn't read or link group information.

Parameter	Description
aPbkResReader	Initialized resource buffer to PHONEBOOK_FIELD_ARRAY
aCntModelResReader	Initialized resource buffer to ARRAY or FIELDs
aAddedFieldTypes	If not null the field types that were added are appended to this array. The field types are in the order they were defined in resources.

Count ( )

IMPORT_C TInt

Count

(

)

const

Returns the count of field infos.

Returns: The count of field information elements in this container.

CreateContactItemFieldDefLC ( const CPbkFieldIdArray * )

IMPORT_C CContactItemFieldDef *

CreateContactItemFieldDefLC

(

const CPbkFieldIdArray *

aFieldTypes

)

const

Creates contact item field definition from an array of Phonebook field ids.

Parameter	Description
aFieldTypes	Phonebook field types to add into the returned array. If NULL an array matching all fields is returned.

Returns: A field def array matching <it>at least fields</it> in aFieldTypes. Please note that the returned field definition may also match other fields than those specified.

CreateContactItemViewDefLC ( const CPbkFieldIdArray & )

IMPORT_C CContactItemViewDef *

CreateContactItemViewDefLC

(

const CPbkFieldIdArray &

aFieldTypes

)

const

Creates a contact item view definition from an array of Phonebook field ids.

Parameter	Description
aFieldTypes	Array of Phonebook field types.

Returns: A new contact item view definition.

CreateMatchPriority ( )

IMPORT_C TPbkMatchPriorityLevel

CreateMatchPriority

(

)

const

Find ( TPbkFieldId )

IMPORT_C CPbkFieldInfo *

Find

(

TPbkFieldId

aFieldId

)

const

Search field info by Phonebook field id.

Parameter	Description
aFieldId	Phonebook field id to search from the array

Returns: The <it>first</it> (there may be several that match) field info object in the field UI presentation order matching aFieldId. Returns NULL if no match is found.

Find ( TPbkFieldId, TPbkFieldLocation )

IMPORT_C CPbkFieldInfo *	Find	(	TPbkFieldId	aFieldId,
			TPbkFieldLocation	aLocation
		)	const

Search field info by Phonebook field id and location

Parameter	Description
aFieldId	Phonebook field id to search from the array
aLocation	Field location (home/work/none) to search from the array

Returns: The field info object (there should be only one) matching aFieldId and aLocation. NULL if no match found.

Find ( const CContactItemField & )

IMPORT_C CPbkFieldInfo *

Find

(

const CContactItemField &

aContactItemField

)

const

Search a field info matching contact model field.

Parameter	Description
aContactItemField	Contact item field whose match is searched from all field info objects.

Returns: The field info object matching aContactItemField. NULL if no match is found.

GroupAt ( TInt )

IMPORT_C const CPbkFieldInfoGroup &

GroupAt

(

TInt

aIndex

)

const

Returns the field info group at aIndex.

Returns: The field info group at aIndex.

GroupCount ( )

IMPORT_C TInt

GroupCount

(

)

const

Returns the count of field info groups.

Returns: The count of field info groups.

Match ( const CContactItemField &, const TPbkMatchPriorityLevel & )

CPbkFieldInfo *	Match	(	const CContactItemField &	aContactItemField,
			const TPbkMatchPriorityLevel &	aMatchPriority
		)	const

Match ( const MPbkVcardProperty &, const TPbkMatchPriorityLevel & )

IMPORT_C CPbkFieldInfo *	Match	(	const MPbkVcardProperty &	aVcardProperty,
			const TPbkMatchPriorityLevel &	aMatchPriority
		)	const

NewL ( RResourceFile &, RResourceFile & )

CPbkFieldsInfo *	NewL	(	RResourceFile &	aPbkResFile,
			RResourceFile &	aCntModelResFile
		)	[static]

Creates and returns an instance of this class intialised from resources.

Parameter	Description
aPbkResFile	Phonebook's resource file.
aCntModelResFile	Contact Model's resource file.

operator[] ( TInt )

IMPORT_C CPbkFieldInfo *

operator[]

(

TInt

aIndex

)

const

Returns the aIndex:th field info. Field info objects are sorted by the field presentation ordering.

Parameter	Description
aIndex	The indexed element in this array.

Returns: The element in the indexed position in the array.