MVPbkStoreContactField Class Reference

class MVPbkStoreContactField : public MVPbkBaseContactField

An interface for the field of the store contact.

Client can access the contact field using this interface. The field can have a label and a data.

A new field can be created using the MVPbkStoreContact interface. For looping the contact fields see MVPbkStoreContactFieldCollection . The parent of the field in the object hierarchy is the store contact.

CVPbkContactFieldTypeIterator CVPbkFieldTypeSelector

Inherits from

Constructor & Destructor Documentation


~MVPbkStoreContactField ( ) [inline, virtual]


Member Functions Documentation


MVPbkStoreContactField * CloneLC ( ) const [pure virtual]

Clones the field.

Pushes the created copy to the cleanup stack.



MVPbkContactLink * CreateLinkLC ( ) const [pure virtual]

Creates a link representing the contact and the field.

The field can be later retrieved using the RetrieveField of MVPbkStoreContactFieldCollection interface.

NOTE: implementations of stores are possibly using an index of the field as an identifier so clients should prefer not to save field links permanently. E.g modifying the contact can invalidate the link in some store implementations. A field link is practical in use cases where the link is created and immediately given to another component.


const MVPbkContactFieldData & FieldData ( ) const [pure virtual]

Returns this field's data storage (read-only). The actual data type can be get using the static Cast functions in actual classes.

MVPbkContactFieldTextData MVPbkContactFieldBinaryData MVPbkContactFieldDateTimeData


MVPbkContactFieldData & FieldData ( ) [pure virtual]

Returns the data storage (read-write) of the field.

The data type depends on the field and it's client's responsibility to check the type before casting the type.

MVPbkContactFieldTextData::Cast MVPbkContactFieldDateTimeData::Cast MVPbkContactFieldBinaryData::Cast


TPtrC FieldLabel ( ) const [pure virtual]

Returns the label of the field or KNullDesC if there is no field label.


TInt MaxLabelLength ( ) const [pure virtual]

Gets the maximum length of the label.

SupportsLabel must be true for using this.

SetFieldLabelL(const TDesC &)

void SetFieldLabelL ( const TDesC & aText ) [pure virtual]

Sets this field's label.

SupportsLabel must be true for using this.


const TDesC & aText The label for the field.


TAny * StoreContactFieldExtension ( TUid ) [inline, virtual]

Returns an extension point for this interface or NULL.




TBool SupportsLabel ( ) const [pure virtual]

Returns ETrue if the field supports label.

Overwrites the global setting in MVPbkContactStoreProperties . This must be confirmed before using SetFieldLabelL or MaxLabelLength.