Class CContactCardTemplate

class CContactCardTemplate : public CContactItem;

Description

A contact card template.

This is a contact item containing a set of fields on which new contact items can be based. Templates have a label which is a string which identifies the template to a user. For instance, 'work template' could indicate a template used to create contact cards in the style of a work colleague. Contact card templates have a type of KUidContactCardTemplate, as returned by Type().

Objects of this class cannot be constructed directly because its constructors are protected. Instead, use either CContactDatabase::CreateContactCardTemplateL() or CreateContactCardTemplateLC(). These functions create a contact card template, add it to the database, and return a pointer to it.

The function CContactDatabase::GetCardTemplateIdListL() gets a list of the IDs of all contact card templates in the database.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CContactItem - The abstract base class for contact cards, templates and groups

• CContactCardTemplate - A contact card template

Members

Defined in CContactCardTemplate:

• GetTemplateLabelL()Gets the label for a contact card template
• HasItemLabelField()Tests whether a Template label field is present
• NewL()Allocates and constructs a new Contact Card Template
• NewL()Allocates and constructs a new Contact Card Template
• NewLC()Allocates and constructs a new Contact Card Template
• NewLC()Allocates and constructs a new Contact Card Template
• ReservedFunction1()Intended usage: Reserved to preserve future BC
• ReservedFunction2()Intended usage: Reserved to preserve future BC
• SetTemplateLabelL()Changes the label for a contact card template
• Type()Gets the contact item's type

Inherited from CBase:

• Delete()Deletes the specified object
• Extension_()Extension function
• operator new()Initialises the object to binary zeroes

Inherited from CContactItem:

• AccessCount()Gets the contact item's access count
• AddFieldL()Appends a field to the contact item's field set
• CardFields()Gets a reference to the contact item's field set
• DecAccessCount()Decrements the contact item's access count
• ECompressedGuidTo set the contact item's hidden attribute
• EDeletedTo set the contact item's Is deleted attribute
• EHiddenTo set the contact item's hidden attribute
• ESystemTo set the contact item's system attribute
• ExternalizeL()Externalises a CContactItem object to a write stream
• Guid()Accessor function for Contact Guid
• Id()Gets the contact item's ID
• IncAccessCount()Increments the contact item's access count
• InsertFieldL()Inserts a field into the contact item's field set
• InternalizeL()Internalises a CContactItem object from a read stream
• IsDeletable()Tests whether the contact item is deletable
• IsDeleted()Gets the value of the Is deleted attribute as set by SetDeleted()
• IsHidden()Gets the value of the contact item's hidden attribute
• IsSystem()Gets the value of the contact item's system attribute
• LastModified()Gets the contact item's last modified date/time
• RemoveField()Removes a field from the contact item's field set
• SetDeleted()Sets the value of the contact item's Is deleted attribute
• SetHidden()Sets the contact item's hidden attribute
• SetLastModified()Sets the last modified date/time value stored in the local copy of the contact item
• SetSystem()Sets the contact item's system attribute
• SetTemplateRefId()Sets the ID of the template on which this contact item is based
• SetUidStringL()Sets the item's UID string
• TemplateRefId()Gets the ID of the template which was used to create this contact item
• UidStringL()Returns a descriptor which contains the item's UID string
• UpdateFieldSet()Replaces the contact item's field set
• anonymousContact item's attribute flags

protected: static IMPORT_C CContactCardTemplate *NewL();

Description

Allocates and constructs a new Contact Card Template .

Return value

CContactCardTemplate * Pointer to the newly created Contact Card Template.

protected: static IMPORT_C CContactCardTemplate *NewLC();

Description

Allocates and constructs a new Contact Card Template .

Return value

CContactCardTemplate * Pointer to the newly created Contact Card Template. This is left on the cleanup stack.

protected: static IMPORT_C CContactCardTemplate *NewL(const CContactItem *aTemplate);

Description

Allocates and constructs a new Contact Card Template .

Parameters

const CContactItem *aTemplate Pointer to the template whose field set and field data are copied into the new contact card template

Return value

CContactCardTemplate * Pointer to the newly created Contact Card Template.

protected: static IMPORT_C CContactCardTemplate *NewLC(const CContactItem *aTemplate);

Description

Allocates and constructs a new Contact Card Template .

Parameters

const CContactItem *aTemplate Pointer to the template whose field set and field data are copied into the new contact card template

Return value

CContactCardTemplate * Pointer to the newly created Contact Card Template. This is left on the cleanup stack.

IMPORT_C void SetTemplateLabelL(const TDesC &aLabel);

Description

Changes the label for a contact card template. The label is initialised when the template is created. The template label is stored in a text field in the template. This field has a unique content type mapping of KUidContactFieldTemplateLabel. By default, this field is the first field in the field set; it must not be moved from this position.

Parameters

const TDesC &aLabel The new template label.

Leave codes

KErrNotFound Indicates there is no template label field in the template.

IMPORT_C TPtrC GetTemplateLabelL();

Description

Gets the label for a contact card template.

Return value

TPtrC The template label.

Leave codes

KErrNotFound Indicates there is no template label field in the template.

protected: IMPORT_C TBool HasItemLabelField();

Description

Tests whether a Template label field is present.

Return value

TBool ETrue if Template Label Field is present, EFalse otherwise.

protected: IMPORT_C void ReservedFunction1();

Description

Intended usage: Reserved to preserve future BC

protected: IMPORT_C void ReservedFunction2();

Description

Intended usage: Reserved to preserve future BC

protected: virtual IMPORT_C TUid Type() const;

Description

Gets the contact item's type.

Return value

TUid The contact item's type.