CPbkFieldInfo Class Reference

IMPORT_C TPbkAddItemOrdering CPbkFieldInfo::AddItemOrdering

Returns additional flags of this field type.

Returns:: The additional flags of this field type.

Returns the UI ordering for adding a field.

Deprecated:: This function is no longer supported.

Returns:: The UI ordering for adding a field.

IMPORT_C const TDesC& CPbkFieldInfo::AddItemText

IMPORT_C void CPbkFieldInfo::AddToFieldDefL

Returns the Add item label text of the field.

Returns:: The Add item label text of the field.

CContactItemFieldDef &

aFieldDef

Field definition to add types to.

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

Parameters:

aFieldDef

IMPORT_C void CPbkFieldInfo::AddToViewDefL

CContactItemViewDef &

aViewDef

View definition to add types to.

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

Parameters:

aViewDef

IMPORT_C TInt CPbkFieldInfo::Category

IMPORT_C TInt CPbkFieldInfo::CompareOrdering

Returns the category of this field type.

Returns:: The category of this field type

const CPbkFieldInfo &

aOther

The other object this is compared against.

Compares the field ordering of this and aOther.

Parameters:

aOther

Returns:: 0, if this and aOther are equal in field ordering
negative, if this is less than aOther in field ordering
positive, if this is greater than aOther in field ordering.

IMPORT_C const CContentType& CPbkFieldInfo::ContentType

IMPORT_C CContactItemField* CPbkFieldInfo::CreateFieldL

Returns the content type of this field type.

Returns:: The content type of this field type.

See also:: CContentType

IMPORT_C TPbkFieldCtrlType CPbkFieldInfo::CtrlType

Creates a Symbian Contacts model field of this field type.

Ownership of the field is passed to the client.

Returns:: Symbian Contacts model field of this field type.

IMPORT_C TPbkFieldDefaultCase CPbkFieldInfo::DefaultCase

Returns the UI control type required to edit this field.

Returns:: The UI control type required to edit this field.

IMPORT_C TBool CPbkFieldInfo::DoSynchronize

Returns the default character case for this field type.

Returns:: The default character case for this field type.

IMPORT_C TPbkFieldEditMode CPbkFieldInfo::EditMode

Returns ETrue if this field is synchronized.

Returns:: ETrue if this field is synchronized, EFalse otherwise.

IMPORT_C TPbkFieldId CPbkFieldInfo::FieldId

Returns the default editing mode for this field type.

Returns:: The default editing mode for this field type.

IMPORT_C const TDesC& CPbkFieldInfo::FieldName

Returns the unique Phonebook field id for this field type.

Returns:: The unique Phonebook field id for this field type.

IMPORT_C TStorageType CPbkFieldInfo::FieldStorageType

Returns this field type's default label.

Returns:: The field type's default label.

IMPORT_C TUint CPbkFieldInfo::Flags

Returns the storage type of this field type.

Returns:: The storage type of this field type.

IMPORT_C const CPbkFieldInfoGroup* CPbkFieldInfo::Group

Returns Symbian Contacts Model field flags of this field type.

Returns:: Symbian Contacts model field flags for this field type.

IMPORT_C TPbkIconId CPbkFieldInfo::IconId

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

Returns:: The field info group this field info belongs to or NULL.

IMPORT_C TBool CPbkFieldInfo::IsDisabled

Returns the icon id for this field type.

Returns:: The icon id for this field type.

IMPORT_C TBool CPbkFieldInfo::IsEditable

Returns ETrue if this field is disabled.

Returns:: ETrue if this field is disabled, EFalse otherwise.

IMPORT_C TBool CPbkFieldInfo::IsEmailField

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

Returns:: ETrue if this field type can be edited in phonebook's contact editor, EFalse otherwise.

IMPORT_C TBool CPbkFieldInfo::IsEmailOverSmsField

Returns ETrue if this is an Email address field type.

Returns:: ETrue if this is a EMail address field type, EFalse otherwise.

TBool CPbkFieldInfo::IsEqualLabel

Returns ETrue if this is an EmailOverSms address field type.

Returns:: ETrue if this field type is a EmailOverSms address field, EFalse otherwise.

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

Parameters:

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

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

IMPORT_C TBool CPbkFieldInfo::IsEqualTo

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

Parameters:

Symbian Contacts model field to compare

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

TBool CPbkFieldInfo::IsEqualType

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

Parameters:

Symbian Contacts model field to compare.

Returns:: ETrue if Symbian Contacts model aField's type is equal to this field info object.

IMPORT_C TBool CPbkFieldInfo::IsHidden

IMPORT_C TBool CPbkFieldInfo::IsImageField

Returns ETrue if this field is hidden.

Returns:: ETrue if this field is hidden, EFalse otherwise.

IMPORT_C TBool CPbkFieldInfo::IsMmsField

Returns ETrue if this is an image field type.

Returns:: ETrue if this is a image field type, EFalse otherwise.

IMPORT_C TBool CPbkFieldInfo::IsPhoneNumberField

Returns ETrue if this is a MMS address field type.

Returns:: ETrue if this is a MMS address field type, EFalse otherwise.

IMPORT_C TBool CPbkFieldInfo::IsPocField

Returns ETrue if this is a phone number field type.

Returns:: ETrue if this is a phone number field type, EFalse otherwise.

IMPORT_C TBool CPbkFieldInfo::IsReadingField

Returns ETrue if this is a POC address field type.

Returns:: ETrue if this is a POC address field type, EFalse otherwise.

IMPORT_C TBool CPbkFieldInfo::IsReadOnly

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

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

IMPORT_C TBool CPbkFieldInfo::IsSame

Returns ETrue if this field is read only.

Returns:: ETrue if this field is read only, EFalse otherwise.

const CPbkFieldInfo &

aFieldInfo

Field info to compare to this field type.

Returns ETrue if aFieldInfo is same as this.

Parameters:

aFieldInfo

Returns:: ETrue if aField Is same as this field type, EFalse otherwise.

IMPORT_C TBool CPbkFieldInfo::IsVoipField

IMPORT_C TPbkFieldLocation CPbkFieldInfo::Location

Returns ETrue if this is a VOIP address field type.

Returns:: ETrue if this is a VOIP address field type, EFalse otherwise.

IMPORT_C TBool CPbkFieldInfo::Match

Returns the location information of the field.

Returns:: The location information of the field.

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.

Deprecated:

Parameters:

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

Returns:: ETrue is field matches, EFalse otherwise.

TBool CPbkFieldInfo::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:

	aVcardType	vCard field type to match to this field type.
	aMatchPriority	Matching priority.

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

TBool CPbkFieldInfo::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:

	aFieldType	Field type to compare.
	aMatchPriority	Matching priority.

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

TBool CPbkFieldInfo::Match

const TPbkContactItemFieldType &

aFieldType

Field type to match to this field type.

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

Parameters:

aFieldType

Returns:: ETrue if this field info matches aFieldType at any import type priority level, EFalse otherwise.

IMPORT_C TBool CPbkFieldInfo::Match

Returns ETrue if this field info matches aFieldId.

Parameters:

aFieldId

The field type id to compare to this field type.

Returns:: ETrue if this field info matched aFieldId, EFalse otherwise.

IMPORT_C TInt CPbkFieldInfo::MaxLength

IMPORT_C TPbkFieldMultiplicity CPbkFieldInfo::Multiplicity

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

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

IMPORT_C TBool CPbkFieldInfo::NameField

Returns the multiplicity allowed for this field type.

Returns:: The multiplicity allowed for this field type.

IMPORT_C TBool CPbkFieldInfo::NumericField

Returns ETrue if this is a name field type.

Returns:: ETrue if this is a name field type, EFalse otherwise.

IMPORT_C TBool CPbkFieldInfo::TemplateField

Returns ETrue if this is a numeric field type.

Returns:: ETrue if this is a numeric field type, EFalse otherwise.

IMPORT_C TBool CPbkFieldInfo::UserCanAddField

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

Returns:: ETrue if this is part of the default template, EFalse otherwise.

IMPORT_C TPbkVersitStorageType CPbkFieldInfo::VersitStorageType

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

Returns:: ETrue if this field type can be added by the user, EFalse otherwise.