Class CContactCardTemplate

CContactCardTemplate

Support

Supported from 6.0

Description

Provides support for multiple contact card templates. A contact card template 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 CContactCardTemplate Provides support for multiple contact card templates CContactItem The abstract base class for contact cards, templates and groups

Defined in CContactCardTemplate:
GetTemplateLabelL(), SetTemplateLabelL()

Inherited from CBase:
operator new()

Inherited from CContactItem:
AccessCount(), AddFieldL(), CardFields(), DecAccessCount(), Id(), IncAccessCount(), InsertFieldL(), IsDeletable(), IsDeleted(), IsHidden(), IsSystem(), LastModified(), RemoveField(), SetDeleteFlag(), SetDeleted(), SetHidden(), SetLastModified(), SetSystem(), SetTemplateRefId(), SetUidStringL(), TemplateRefId(), Type(), UidStringL(), UpdateFieldSet()

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.

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.