Collapse all Symbian^3 Product Developer Library

CPbkFieldInfo Class Reference

class CPbkFieldInfo : public CBase

Phonebook constant field type information. Loaded from resources into CPbkFieldsInfo array. The corresponding resource structure is PHONEBOOK_FIELD in PbkFieldInfo.rh.

CPbkFieldsInfo PHONEBOOK_FIELD FIELD

Inherits from

CPbkFieldInfo
- CBase

Nested Classes and Structures

CPbkFieldInfo::TPbkFieldInfoParams

Public Member Functions
IMPORT_C TUint	AddFlags()
IMPORT_C TPbkAddItemOrdering	AddItemOrdering()
IMPORT_C const TDesC &	AddItemText()
IMPORT_C void	AddToFieldDefL(CContactItemFieldDef &)
IMPORT_C void	AddToViewDefL(CContactItemViewDef &)
IMPORT_C TInt	Category()
IMPORT_C TInt	CompareOrdering(const CPbkFieldInfo &)
IMPORT_C const CContentType &	ContentType()
IMPORT_C CContactItemField *	CreateFieldL()
IMPORT_C TPbkFieldCtrlType	CtrlType()
IMPORT_C TPbkFieldDefaultCase	DefaultCase()
IMPORT_C TBool	DoSynchronize()
IMPORT_C TPbkFieldEditMode	EditMode()
IMPORT_C TPbkFieldId	FieldId()
IMPORT_C const TDesC &	FieldName()
IMPORT_C TStorageType	FieldStorageType()
IMPORT_C TUint	Flags()
IMPORT_C const CPbkFieldInfoGroup *	Group()
IMPORT_C TPbkIconId	IconId()
IMPORT_C TBool	IsDisabled()
IMPORT_C TBool	IsEditable()
IMPORT_C TBool	IsEmailField()
IMPORT_C TBool	IsEmailOverSmsField()
TBool	IsEqualLabel(const CContactItemField &)
IMPORT_C TBool	IsEqualTo(const CContactItemField &)
TBool	IsEqualType(const CContactItemField &)
IMPORT_C TBool	IsHidden()
IMPORT_C TBool	IsImageField()
IMPORT_C TBool	IsMmsField()
IMPORT_C TBool	IsPhoneNumberField()
IMPORT_C TBool	IsPocField()
IMPORT_C TBool	IsReadOnly()
IMPORT_C TBool	IsReadingField()
IMPORT_C TBool	IsSame(const CPbkFieldInfo &)
IMPORT_C TBool	IsVoipField()
IMPORT_C TPbkFieldLocation	Location()
IMPORT_C TBool	Match(TPbkFieldId)
TBool	Match(const TPbkContactItemFieldType &)
TBool	Match(const TPbkContactItemFieldType &, const TPbkMatchPriorityLevel &)
TBool	Match(const TPbkVcardFieldType &, const TPbkMatchPriorityLevel &)
IMPORT_C TBool	Match(const CContactItemField &)
IMPORT_C TInt	MaxLength()
IMPORT_C TPbkFieldMultiplicity	Multiplicity()
IMPORT_C TBool	NameField()
IMPORT_C TBool	NumericField()
IMPORT_C TBool	TemplateField()
IMPORT_C TBool	UserCanAddField()
IMPORT_C TPbkVersitStorageType	VersitStorageType()

Private Member Functions
	CPbkFieldInfo()
	~CPbkFieldInfo()
void	CalculateTypeSignatures(const CPbkUidMap &)
void	ConstructFromResourceL(TResourceReader &, TResourceReader &, TPbkFieldInfoParams &)
TInt	ImportPropertyCount()
TBool	IsEqualFlags(const CContactItemField &)
CPbkFieldInfo *	NewLC(TResourceReader &, TResourceReader &, TPbkFieldInfoParams &)
void	ReadAdditionalFieldsL(TResourceReader &, TPbkFieldInfoParams &)
void	ReadCntModelFieldsL(TResourceReader &)
void	ReadImportPropertiesL(TResourceReader &)
void	UpdateTypeUidMapL(CPbkUidMap &)

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 Attributes
const CPbkFieldInfoGroup *	iGroup
TPbkFieldGroupId	iGroupId

Private Attributes
TUint	iAddFlags
TInt8	iAddItemOrdering
HBufC *	iAddItemText
TInt	iCategory
CContentType *	iContentType
TInt8	iCtrlType
TInt8	iDefaultCase
TInt8	iEditMode
TInt8	iFieldId
HBufC *	iFieldName
TStorageType	iFieldStorageType
TUint	iFlags
union CPbkFieldInfo::@68	iGroupLink
TInt8	iIconId
CPbkFieldImportType *	iImportType
TInt8	iLocation
TInt16	iMaxLength
TInt8	iMultiplicity
TInt8	iOrderingGroup
TInt8	iOrderingItem
TInt8	iVersitStorageType

Constructor & Destructor Documentation

CPbkFieldInfo()

CPbkFieldInfo

(

)

[private, inline]

C++ constructor

~CPbkFieldInfo()

~CPbkFieldInfo

(

)

[private]

Destructor.

Member Functions Documentation

AddFlags()

IMPORT_C TUint

AddFlags

(

)

const

Returns additional flags of this field type.

AddItemOrdering()

IMPORT_C TPbkAddItemOrdering

AddItemOrdering

(

)

const

This function is no longer supported.

Returns the UI ordering for adding a field.

AddItemText()

IMPORT_C const TDesC &

AddItemText

(

)

const

Returns the Add item label text of the field.

AddToFieldDefL(CContactItemFieldDef &)

IMPORT_C void

AddToFieldDefL

(

CContactItemFieldDef &

aFieldDef

)

const

Add this field's type information to a contact item field definition.

Parameters

CContactItemFieldDef & aFieldDef

Field definition to add types to.

AddToViewDefL(CContactItemViewDef &)

IMPORT_C void

AddToViewDefL

(

CContactItemViewDef &

aViewDef

)

const

Add this field's type information to a contact item view definition.

Parameters

CContactItemViewDef & aViewDef

View definition to add types to.

CalculateTypeSignatures(const CPbkUidMap &)

void

CalculateTypeSignatures

(

const CPbkUidMap &

aTypeUidMap

)

[private]

Parameters

const CPbkUidMap & aTypeUidMap

Category()

IMPORT_C TInt

CompareOrdering(const CPbkFieldInfo &)

IMPORT_C TInt

CompareOrdering

(

const CPbkFieldInfo &

aOther

)

const

Compares the field ordering of this and aOther.

Parameters

const CPbkFieldInfo & aOther

The other object this is compared against.

ConstructFromResourceL(TResourceReader &, TResourceReader &, TPbkFieldInfoParams &)

void	ConstructFromResourceL	(	TResourceReader &	aReaderStd,
			TResourceReader &	aReaderAdd,
			TPbkFieldInfoParams &	aPbkFieldInfoParams
		)	[private]

Second phase constructor. Initializes this field info object from resources.

Parameters

TResourceReader & aReaderStd
TResourceReader & aReaderAdd
TPbkFieldInfoParams & aPbkFieldInfoParams

ContentType()

IMPORT_C const CContentType &

ContentType

(

)

const

Returns the content type of this field type. CContentType

CreateFieldL()

IMPORT_C CContactItemField *

CreateFieldL

(

)

const

Creates a Symbian Contacts model field of this field type. Ownership of the field is passed to the client.

CtrlType()

IMPORT_C TPbkFieldCtrlType

CtrlType

(

)

const

Returns the UI control type required to edit this field.

DefaultCase()

IMPORT_C TPbkFieldDefaultCase

DefaultCase

(

)

const

Returns the default character case for this field type.

DoSynchronize()

IMPORT_C TBool

DoSynchronize

(

)

const

Returns ETrue if this field is synchronized.

EditMode()

IMPORT_C TPbkFieldEditMode

EditMode

(

)

const

Returns the default editing mode for this field type.

FieldId()

IMPORT_C TPbkFieldId

FieldId

(

)

const

Returns the unique Phonebook field id for this field type.

FieldName()

IMPORT_C const TDesC &

FieldName

(

)

const

Returns this field type's default label.

FieldStorageType()

IMPORT_C TStorageType

FieldStorageType

(

)

const

Returns the storage type of this field type.

Flags()

IMPORT_C TUint

Flags

(

)

const

Returns Symbian Contacts Model field flags of this field type.

Group()

IMPORT_C const CPbkFieldInfoGroup *

Group

(

)

const

Returns the field info group this field info belongs to or NULL.

IconId()

IMPORT_C TPbkIconId

IconId

(

)

const

Returns the icon id for this field type.

ImportPropertyCount()

TInt

ImportPropertyCount

(

)

const [private]

IsDisabled()

IMPORT_C TBool

IsDisabled

(

)

const

Returns ETrue if this field is disabled.

IsEditable()

IMPORT_C TBool

IsEditable

(

)

const

Returns ETrue if the field type can be edited in Phonebook's contact editor.

IsEmailField()

IMPORT_C TBool

IsEmailField

(

)

const

Returns ETrue if this is an Email address field type.

IsEmailOverSmsField()

IMPORT_C TBool

IsEmailOverSmsField

(

)

const

Returns ETrue if this is an EmailOverSms address field type.

IsEqualFlags(const CContactItemField &)

TBool

IsEqualFlags

(

const CContactItemField &

aField

)

const [private, inline]

Returns ETrue if aField's flags are equal with this field info object.

Parameters

const CContactItemField & aField

IsEqualLabel(const CContactItemField &)

TBool

IsEqualLabel

(

const CContactItemField &

aField

)

const

Returns ETrue if aField's label is equal to this field info objects. Returns ETrue if aField's label is equal with this field info object.

Parameters

const CContactItemField & aField

Symbian Contacts model field to compare to this field types label.

IsEqualTo(const CContactItemField &)

IMPORT_C TBool

IsEqualTo

(

const CContactItemField &

aField

)

const

Returns ETrue if aField's type and labels are equal to this field info object.

Parameters

const CContactItemField & aField

Symbian Contacts model field to compare

IsEqualType(const CContactItemField &)

TBool

IsEqualType

(

const CContactItemField &

aField

)

const

Returns ETrue if aField's type is equal to this field info object.

Parameters

const CContactItemField & aField

Symbian Contacts model field to compare.

IsHidden()

IMPORT_C TBool

IsHidden

(

)

const

Returns ETrue if this field is hidden.

IsImageField()

IMPORT_C TBool

IsImageField

(

)

const

Returns ETrue if this is an image field type.

IsMmsField()

IMPORT_C TBool

IsMmsField

(

)

const

Returns ETrue if this is a MMS address field type.

IsPhoneNumberField()

IMPORT_C TBool

IsPhoneNumberField

(

)

const

Returns ETrue if this is a phone number field type.

IsPocField()

IMPORT_C TBool

IsPocField

(

)

const

Returns ETrue if this is a POC address field type.

IsReadOnly()

IMPORT_C TBool

IsReadOnly

(

)

const

Returns ETrue if this field is read only.

IsReadingField()

IMPORT_C TBool

IsReadingField

(

)

const

Returns ETrue if this field is a reading field type (japanese).

IsSame(const CPbkFieldInfo &)

IMPORT_C TBool

IsSame

(

const CPbkFieldInfo &

aFieldInfo

)

const

Returns ETrue if aFieldInfo is same as this.

Parameters

const CPbkFieldInfo & aFieldInfo

Field info to compare to this field type.

IsVoipField()

IMPORT_C TBool

IsVoipField

(

)

const

Returns ETrue if this is a VOIP address field type.

Location()

IMPORT_C TPbkFieldLocation

Location

(

)

const

Returns the location information of the field.

Match(TPbkFieldId)

IMPORT_C TBool

Match

(

TPbkFieldId

aFieldId

)

const

Returns ETrue if this field info matches aFieldId.

Parameters

TPbkFieldId aFieldId

The field type id to compare to this field type.

Match(const TPbkContactItemFieldType &)

TBool

Match

(

const TPbkContactItemFieldType &

aFieldType

)

const

Returns ETrue if this field info matches aFieldType at any import type priority level.

Parameters

const TPbkContactItemFieldType & aFieldType

Field type to match to this field type.

Match(const TPbkContactItemFieldType &, const TPbkMatchPriorityLevel &)

TBool	Match	(	const TPbkContactItemFieldType &	aFieldType,
			const TPbkMatchPriorityLevel &	aMatchPriority
		)	const

Returns ETrue if this field info matches aFieldType at import type priority level defined by aMatchPriority.

Parameters

const TPbkContactItemFieldType & aFieldType	Field type to compare.
const TPbkMatchPriorityLevel & aMatchPriority	Matching priority.

Match(const TPbkVcardFieldType &, const TPbkMatchPriorityLevel &)

TBool	Match	(	const TPbkVcardFieldType &	aVcardType,
			const TPbkMatchPriorityLevel &	aMatchPriority
		)	const

Returns ETrue if this field info matches aVcardType at import type priority level defined by aMatchPriority.

Parameters

const TPbkVcardFieldType & aVcardType	vCard field type to match to this field type.
const TPbkMatchPriorityLevel & aMatchPriority	Matching priority.

Match(const CContactItemField &)

IMPORT_C TBool

Match

(

const CContactItemField &

aField

)

const

This function is no longer supported. If you want to find the CPbkFieldInfo instance matching a CContactItemField use CPbkFieldsInfo::Match(const CContactItemField&) const. That function works correctly and uses <it>a lot</it> faster algorithm than this function.

Parameters

const CContactItemField & aField

Symbian Contacts model contact item to match to this field type. Returns ETrue if this field info matches aField.

MaxLength()

IMPORT_C TInt

MaxLength

(

)

const

Returns the maximum data length that Phonebook UI spec specifies for this field type.

Multiplicity()

IMPORT_C TPbkFieldMultiplicity

Multiplicity

(

)

const

Returns the multiplicity allowed for this field type.

NameField()

IMPORT_C TBool

NameField

(

)

const

Returns ETrue if this is a name field type.

NewLC(TResourceReader &, TResourceReader &, TPbkFieldInfoParams &)

CPbkFieldInfo *	NewLC	(	TResourceReader &	aReaderStd,
			TResourceReader &	aReaderAdd,
			TPbkFieldInfoParams &	aPbkFieldInfoParams
		)	[private, static]

Creates a new instance of this class. The created object is left on the cleanup stack.

Parameters

TResourceReader & aReaderStd	resource reader initialised to the start of a STRUCT FIELD.
TResourceReader & aReaderAdd	resource reader initialised to the start of a STRUCT PHONEBOOK_FIELD.
TPbkFieldInfoParams & aPbkFieldInfoParams	parameters for initialisation

NumericField()

IMPORT_C TBool

NumericField

(

)

const

Returns ETrue if this is a numeric field type.

ReadAdditionalFieldsL(TResourceReader &, TPbkFieldInfoParams &)

void	ReadAdditionalFieldsL	(	TResourceReader &	aReaderAdd,
			TPbkFieldInfoParams &	aPbkFieldInfoParams
		)	[private, inline]

Parameters

TResourceReader & aReaderAdd
TPbkFieldInfoParams & aPbkFieldInfoParams

ReadCntModelFieldsL(TResourceReader &)

void

ReadCntModelFieldsL

(

TResourceReader &

aReaderStd

)

[private, inline]

Parameters

TResourceReader & aReaderStd

ReadImportPropertiesL(TResourceReader &)

void

ReadImportPropertiesL

(

TResourceReader &

aReaderAdd

)

[private]

Parameters

TResourceReader & aReaderAdd

TemplateField()

IMPORT_C TBool

TemplateField

(

)

const

Returns ETrue if this field type is part of the default template.

UpdateTypeUidMapL(CPbkUidMap &)

void

UpdateTypeUidMapL

(

CPbkUidMap &

aTypeUidMap

)

const [private]

Parameters

CPbkUidMap & aTypeUidMap

UserCanAddField()

IMPORT_C TBool

UserCanAddField

(

)

const

Returns ETrue if this field type can be added by the user.

VersitStorageType()

IMPORT_C TPbkVersitStorageType

VersitStorageType

(

)

const

Returns the versit storage type of the field.

Member Data Documentation

TUint iAddFlags

TUint

iAddFlags

[private]

TInt8 iAddItemOrdering

TInt8

iAddItemOrdering

[private]

HBufC * iAddItemText

HBufC *

iAddItemText

[private]

Additional attributes Attributes in resource struct PHONEBOOK_FIELD

TInt iCategory

TInt

iCategory

[private]

CContentType * iContentType

CContentType *

iContentType

[private]

TInt8 iCtrlType

TInt8

iCtrlType

[private]

TInt8 iDefaultCase

TInt8

iDefaultCase

[private]

TInt8 iEditMode

TInt8

iEditMode

[private]

TInt8 iFieldId

TInt8

iFieldId

[private]

HBufC * iFieldName

HBufC *

iFieldName

[private]

TStorageType iFieldStorageType

TStorageType

iFieldStorageType

[private]

Contacts Model attributes Attribute in resource struct FIELD

TUint iFlags

TUint

iFlags

[private]

const CPbkFieldInfoGroup * iGroup

const CPbkFieldInfoGroup *

iGroup

TPbkFieldGroupId iGroupId

TPbkFieldGroupId

iGroupId

union CPbkFieldInfo::@68 iGroupLink

union CPbkFieldInfo::@68

iGroupLink

[private]

TInt8 iIconId

TInt8

iIconId

[private]

CPbkFieldImportType * iImportType

CPbkFieldImportType *

iImportType

[private]

TInt8 iLocation

TInt8

iLocation

[private]

TInt16 iMaxLength

TInt16

iMaxLength

[private]

TInt8 iMultiplicity

TInt8

iMultiplicity

[private]

TInt8 iOrderingGroup

TInt8

iOrderingGroup

[private]

TInt8 iOrderingItem

TInt8

iOrderingItem

[private]

TInt8 iVersitStorageType

TInt8

iVersitStorageType

[private]