CPbkFieldInfo Class Reference

#include <app/CPbkFieldInfo.h>

Link against: PbkEng.lib

class CPbkFieldInfo : public CBase

Inherits from

CPbkFieldInfo

Public Attributes
const CPbkFieldInfoGroup *	iGroup
TPbkFieldGroupId	iGroupId

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()

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

Member Attribute Documentation

iGroup

const CPbkFieldInfoGroup *

iGroup

Ref: field info group this contact info belongs to.

iGroupId

TPbkFieldGroupId

iGroupId

Own: group id before groups are loaded.

Member Function Documentation

AddFlags ( )

IMPORT_C TUint

AddFlags

(

)

const

Returns additional flags of this field type.

Returns: The additional flags of this field type.

AddItemOrdering ( )

IMPORT_C TPbkAddItemOrdering

AddItemOrdering

(

)

const

DeprecatedThis function is no longer supported.

Returns the UI ordering for adding a field.

Returns: The UI ordering for adding a field.

AddItemText ( )

IMPORT_C const TDesC &

AddItemText

(

)

const

Returns the Add item label text of the field.

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.

Parameter	Description
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.

Parameter	Description
aViewDef	View definition to add types to.

Category ( )

IMPORT_C TInt

CompareOrdering ( const CPbkFieldInfo & )

IMPORT_C TInt

CompareOrdering

(

const CPbkFieldInfo &

aOther

)

const

Compares the field ordering of this and aOther.

Parameter	Description
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.

ContentType ( )

IMPORT_C const CContentType &

ContentType

(

)

const

Returns the content type of this field type.

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.

Returns: Symbian Contacts model field of this field type.

CtrlType ( )

IMPORT_C TPbkFieldCtrlType

CtrlType

(

)

const

Returns the UI control type required to edit this field.

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.

Returns: The default character case for this field type.

DoSynchronize ( )

IMPORT_C TBool

DoSynchronize

(

)

const

Returns ETrue if this field is synchronized.

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

EditMode ( )

IMPORT_C TPbkFieldEditMode

EditMode

(

)

const

Returns the default editing mode for this field type.

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.

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

FieldName ( )

IMPORT_C const TDesC &

FieldName

(

)

const

Returns this field type's default label.

Returns: The field type's default label.

FieldStorageType ( )

IMPORT_C TStorageType

FieldStorageType

(

)

const

Returns the storage type of this field type.

Returns: The storage type of this field type.

Flags ( )

IMPORT_C TUint

Flags

(

)

const

Returns Symbian Contacts Model field flags of this field type.

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

Group ( )

IMPORT_C const CPbkFieldInfoGroup *

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.

IconId ( )

IMPORT_C TPbkIconId

IconId

(

)

const

Returns the icon id for this field type.

Returns: The icon id for this field type.

IsDisabled ( )

IMPORT_C TBool

IsDisabled

(

)

const

Returns ETrue if this field is disabled.

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

IsEditable ( )

IMPORT_C TBool

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.

IsEmailField ( )

IMPORT_C TBool

IsEmailField

(

)

const

Returns ETrue if this is an Email address field type.

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

IsEmailOverSmsField ( )

IMPORT_C TBool

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.

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.

Parameter	Description
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.

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.

Parameter	Description
aField	Symbian Contacts model field to compare

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

IsEqualType ( const CContactItemField & )

TBool

IsEqualType

(

const CContactItemField &

aField

)

const

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

Parameter	Description
aField	Symbian Contacts model field to compare.

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

IsHidden ( )

IMPORT_C TBool

IsHidden

(

)

const

Returns ETrue if this field is hidden.

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

IsImageField ( )

IMPORT_C TBool

IsImageField

(

)

const

Returns ETrue if this is an image field type.

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

IsMmsField ( )

IMPORT_C TBool

IsMmsField

(

)

const

Returns ETrue if this is a MMS address field type.

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

IsPhoneNumberField ( )

IMPORT_C TBool

IsPhoneNumberField

(

)

const

Returns ETrue if this is a phone number field type.

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

IsPocField ( )

IMPORT_C TBool

IsPocField

(

)

const

Returns ETrue if this is a POC address field type.

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

IsReadOnly ( )

IMPORT_C TBool

IsReadOnly

(

)

const

Returns ETrue if this field is read only.

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

IsReadingField ( )

IMPORT_C TBool

IsReadingField

(

)

const

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

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.

Parameter	Description
aFieldInfo	Field info to compare to this field type.

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

IsVoipField ( )

IMPORT_C TBool

IsVoipField

(

)

const

Returns ETrue if this is a VOIP address field type.

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

Location ( )

IMPORT_C TPbkFieldLocation

Location

(

)

const

Returns the location information of the field.

Returns: The location information of the field.

Match ( TPbkFieldId )

IMPORT_C TBool

Match

(

TPbkFieldId

aFieldId

)

const

Returns ETrue if this field info matches aFieldId.

Parameter	Description
aFieldId	The field type id to compare to this field type.

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

Match ( const TPbkContactItemFieldType & )

TBool

Match

(

const TPbkContactItemFieldType &

aFieldType

)

const

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

Parameter	Description
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.

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.

Parameter	Description
aFieldType	Field type to compare.
aMatchPriority	Matching priority.

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

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.

Parameter	Description
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.

Match ( const CContactItemField & )

IMPORT_C TBool

Match

(

const CContactItemField &

aField

)

const

DeprecatedThis 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.

Parameter	Description
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.

MaxLength ( )

IMPORT_C TInt

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.

Multiplicity ( )

IMPORT_C TPbkFieldMultiplicity

Multiplicity

(

)

const

Returns the multiplicity allowed for this field type.

Returns: The multiplicity allowed for this field type.

NameField ( )

IMPORT_C TBool

NameField

(

)

const

Returns ETrue if this is a name field type.

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

NumericField ( )

IMPORT_C TBool

NumericField

(

)

const

Returns ETrue if this is a numeric field type.

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

TemplateField ( )

IMPORT_C TBool

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.

UserCanAddField ( )

IMPORT_C TBool

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.

VersitStorageType ( )

IMPORT_C TPbkVersitStorageType

VersitStorageType

(

)

const

Returns the versit storage type of the field.

Returns: The versit storage type of the field.