CPbkFieldInfo Class Reference

API published in: S60 1st Ed
API deprecated in: S60 5th Ed

Link against: pbkeng.lib

Capability Information

Required Capabilities

ReadUserData WriteUserData

#include <cpbkfieldinfo.h>

Detailed Description

Phonebook constant field type information.

Loaded from resources into CPbkFieldsInfo array. The corresponding resource structure is PHONEBOOK_FIELD in PbkFieldInfo.rh.

See also:

CPbkFieldsInfo

PHONEBOOK_FIELD

FIELD


Public Member Functions
IMPORT_C TPbkFieldId	FieldId () const
	Returns the unique Phonebook field id for this field type.
IMPORT_C TStorageType	FieldStorageType () const
	Returns the storage type of this field type.
IMPORT_C const CContentType &	ContentType () const
	Returns the content type of this field type.
IMPORT_C TInt	Category () const
	Returns the category of this field type.
IMPORT_C const TDesC &	FieldName () const
	Returns this field type's default label.
IMPORT_C TUint	Flags () const
	Returns Symbian Contacts Model field flags of this field type.
IMPORT_C TPbkFieldMultiplicity	Multiplicity () const
	Returns the multiplicity allowed for this field type.
IMPORT_C TInt	MaxLength () const
	Returns the maximum data length that Phonebook UI spec specifies for this field type.
IMPORT_C TPbkFieldEditMode	EditMode () const
	Returns the default editing mode for this field type.
IMPORT_C TPbkFieldDefaultCase	DefaultCase () const
	Returns the default character case for this field type.
IMPORT_C TPbkIconId	IconId () const
	Returns the icon id for this field type.
IMPORT_C TPbkFieldCtrlType	CtrlType () const
	Returns the UI control type required to edit this field.
IMPORT_C TUint	AddFlags () const
	Returns additional flags of this field type.
IMPORT_C TPbkAddItemOrdering	AddItemOrdering () const
IMPORT_C TBool	IsHidden () const
	Returns ETrue if this field is hidden.
IMPORT_C TBool	IsReadOnly () const
	Returns ETrue if this field is read only.
IMPORT_C TBool	DoSynchronize () const
	Returns ETrue if this field is synchronized.
IMPORT_C TBool	IsDisabled () const
	Returns ETrue if this field is disabled.
IMPORT_C TBool	NameField () const
	Returns ETrue if this is a name field type.
IMPORT_C TBool	TemplateField () const
	Returns ETrue if this field type is part of the default template.
IMPORT_C TBool	UserCanAddField () const
	Returns ETrue if this field type can be added by the user.
IMPORT_C TBool	IsEditable () const
	Returns ETrue if the field type can be edited in Phonebook's contact editor.
IMPORT_C TBool	NumericField () const
	Returns ETrue if this is a numeric field type.
IMPORT_C TBool	IsPhoneNumberField () const
	Returns ETrue if this is a phone number field type.
IMPORT_C TBool	IsEmailOverSmsField () const
	Returns ETrue if this is an EmailOverSms address field type.
IMPORT_C TBool	IsEmailField () const
	Returns ETrue if this is an Email address field type.
IMPORT_C TBool	IsMmsField () const
	Returns ETrue if this is a MMS address field type.
IMPORT_C TBool	IsImageField () const
	Returns ETrue if this is an image field type.
IMPORT_C TBool	IsPocField () const
	Returns ETrue if this is a POC address field type.
IMPORT_C TBool	IsVoipField () const
	Returns ETrue if this is a VOIP address field type.
IMPORT_C TBool	IsSame (const CPbkFieldInfo &aFieldInfo) const
	Returns ETrue if aFieldInfo is same as this.
IMPORT_C TBool	Match (TPbkFieldId aFieldId) const
	Returns ETrue if this field info matches aFieldId.
TBool	Match (const TPbkContactItemFieldType &aFieldType) const
	Returns ETrue if this field info matches aFieldType at any import type priority level.
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.
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.
IMPORT_C TBool	Match (const CContactItemField &aField) const
IMPORT_C CContactItemField *	CreateFieldL () const
	Creates a Symbian Contacts model field of this field type.
TBool	IsEqualLabel (const CContactItemField &aField) const
	Returns ETrue if aField's label is equal to this field info objects.
TBool	IsEqualType (const CContactItemField &aField) const
	Returns ETrue if aField's type is equal to this field info object.
IMPORT_C TBool	IsEqualTo (const CContactItemField &aField) const
	Returns ETrue if aField's type and labels are equal to this field info object.
IMPORT_C TInt	CompareOrdering (const CPbkFieldInfo &aOther) const
	Compares the field ordering of this and aOther.
IMPORT_C const CPbkFieldInfoGroup *	Group () const
	Returns the field info group this field info belongs to or NULL.
IMPORT_C TPbkFieldLocation	Location () const
	Returns the location information of the field.
IMPORT_C TPbkVersitStorageType	VersitStorageType () const
	Returns the versit storage type of the field.
IMPORT_C void	AddToViewDefL (CContactItemViewDef &aViewDef) const
	Add this field's type information to a contact item view definition.
IMPORT_C void	AddToFieldDefL (CContactItemFieldDef &aFieldDef) const
	Add this field's type information to a contact item field definition.
IMPORT_C const TDesC &	AddItemText () const
	Returns the Add item label text of the field.
IMPORT_C TBool	IsReadingField () const
	Returns ETrue if this field is a reading field type (japanese).
Friends
class	CPbkFieldsInfo
class	PbkFieldInfoWrite
Data Structures
struct	TPbkFieldInfoParams

Member Function Documentation

IMPORT_C TUint CPbkFieldInfo::AddFlags

(

)

const

Returns additional flags of this field type.

Returns:: The additional flags of this field type.

IMPORT_C TPbkAddItemOrdering CPbkFieldInfo::AddItemOrdering

(

)

const

Deprecated:: This function is no longer supported.

Returns the UI ordering for adding a field.

Returns:: The UI ordering for adding a field.

IMPORT_C const TDesC& CPbkFieldInfo::AddItemText

(

)

const

Returns the Add item label text of the field.

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

IMPORT_C void CPbkFieldInfo::AddToFieldDefL

(

CContactItemFieldDef &

aFieldDef

)

const

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

Parameters:

aFieldDef

Field definition to add types to.

IMPORT_C void CPbkFieldInfo::AddToViewDefL

(

CContactItemViewDef &

aViewDef

)

const

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

Parameters:

aViewDef

View definition to add types to.

IMPORT_C TInt CPbkFieldInfo::Category

(

)

const

Returns the category of this field type.

Returns:: The category of this field type

IMPORT_C TInt CPbkFieldInfo::CompareOrdering

(

const CPbkFieldInfo &

aOther

)

const

Compares the field ordering of this and aOther.

Parameters:

aOther

The other object this is compared against.

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

(

)

const

Returns the content type of this field type.

Returns:: The content type of this field type.

See also:: CContentType

IMPORT_C CContactItemField* CPbkFieldInfo::CreateFieldL

(

)

const

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 TPbkFieldCtrlType CPbkFieldInfo::CtrlType

(

)

const

Returns the UI control type required to edit this field.

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

IMPORT_C TPbkFieldDefaultCase CPbkFieldInfo::DefaultCase

(

)

const

Returns the default character case for this field type.

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

IMPORT_C TBool CPbkFieldInfo::DoSynchronize

(

)

const

Returns ETrue if this field is synchronized.

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

IMPORT_C TPbkFieldEditMode CPbkFieldInfo::EditMode

(

)

const

Returns the default editing mode for this field type.

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

IMPORT_C TPbkFieldId CPbkFieldInfo::FieldId

(

)

const

Returns the unique Phonebook field id for this field type.

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

IMPORT_C const TDesC& CPbkFieldInfo::FieldName

(

)

const

Returns this field type's default label.

Returns:: The field type's default label.

IMPORT_C TStorageType CPbkFieldInfo::FieldStorageType

(

)

const

Returns the storage type of this field type.

Returns:: The storage type of this field type.

IMPORT_C TUint CPbkFieldInfo::Flags

(

)

const

Returns Symbian Contacts Model field flags of this field type.

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

IMPORT_C const CPbkFieldInfoGroup* CPbkFieldInfo::Group

(

)

const

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 TPbkIconId CPbkFieldInfo::IconId

(

)

const

Returns the icon id for this field type.

Returns:: The icon id for this field type.

IMPORT_C TBool CPbkFieldInfo::IsDisabled

(

)

const

Returns ETrue if this field is disabled.

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

IMPORT_C TBool CPbkFieldInfo::IsEditable

(

)

const

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::IsEmailField

(

)

const

Returns ETrue if this is an Email address field type.

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

IMPORT_C TBool CPbkFieldInfo::IsEmailOverSmsField

(

)

const

Returns ETrue if this is an EmailOverSms address field type.

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

TBool CPbkFieldInfo::IsEqualLabel

(

const CContactItemField &

aField

)

const

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

Parameters:

aField

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

(

const CContactItemField &

aField

)

const

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

Parameters:

aField

Symbian Contacts model field to compare

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

TBool CPbkFieldInfo::IsEqualType

(

const CContactItemField &

aField

)

const

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

Parameters:

aField

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

(

)

const

Returns ETrue if this field is hidden.

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

IMPORT_C TBool CPbkFieldInfo::IsImageField

(

)

const

Returns ETrue if this is an image field type.

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

IMPORT_C TBool CPbkFieldInfo::IsMmsField

(

)

const

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::IsPhoneNumberField

(

)

const

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::IsPocField

(

)

const

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::IsReadingField

(

)

const

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::IsReadOnly

(

)

const

Returns ETrue if this field is read only.

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

IMPORT_C TBool CPbkFieldInfo::IsSame

(

const CPbkFieldInfo &

aFieldInfo

)

const

Returns ETrue if aFieldInfo is same as this.

Parameters:

aFieldInfo

Field info to compare to this field type.

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

IMPORT_C TBool CPbkFieldInfo::IsVoipField

(

)

const

Returns ETrue if this is a VOIP address field type.

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

IMPORT_C TPbkFieldLocation CPbkFieldInfo::Location

(

)

const

Returns the location information of the field.

Returns:: The location information of the field.

IMPORT_C TBool CPbkFieldInfo::Match

(

const CContactItemField &

aField

)

const

Deprecated:

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:

aField

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

)

const

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

Parameters:

aFieldType

Field type to match to this field type.

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

IMPORT_C TBool CPbkFieldInfo::Match

(

TPbkFieldId

aFieldId

)

const

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

(

)

const

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 TPbkFieldMultiplicity CPbkFieldInfo::Multiplicity

(

)

const

Returns the multiplicity allowed for this field type.

Returns:: The multiplicity allowed for this field type.

IMPORT_C TBool CPbkFieldInfo::NameField

(

)

const

Returns ETrue if this is a name field type.

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

IMPORT_C TBool CPbkFieldInfo::NumericField

(

)

const

Returns ETrue if this is a numeric field type.

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

IMPORT_C TBool CPbkFieldInfo::TemplateField

(

)

const

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

(

)

const

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.

IMPORT_C TPbkVersitStorageType CPbkFieldInfo::VersitStorageType

(

)

const

Returns the versit storage type of the field.

Returns:: The versit storage type of the field.

Friends And Related Function Documentation

friend class CPbkFieldsInfo [friend]

friend class PbkFieldInfoWrite [friend]

The documentation for this class was generated from the following file:

cpbkfieldinfo.h

CPbkFieldInfo Class Reference

Capability Information

Detailed Description

Public Member Functions

Friends

Data Structures

Member Function Documentation

Friends And Related Function Documentation