CContactCardTemplate Class Reference

#include <app/cntitem.h>

Link against: cntmodel.lib

class CContactCardTemplate : public CContactItem

Inherits from

Public Member Functions
IMPORT_C TPtrCGetTemplateLabelL()
IMPORT_C voidSetTemplateLabelL(const TDesC &)
Protected Member Functions
IMPORT_C TBoolHasItemLabelField()
IMPORT_C CContactCardTemplate *NewL()
IMPORT_C CContactCardTemplate *NewL(const CContactItem *)
IMPORT_C CContactCardTemplate *NewLC()
IMPORT_C CContactCardTemplate *NewLC(const CContactItem *)
IMPORT_C voidReservedFunction1()
IMPORT_C voidReservedFunction2()
virtual IMPORT_C TUidType()
Inherited Enumerations
CContactItem:@64
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()
CContactItem::AccessCount()const
CContactItem::AddFieldL(CContactItemField &)
CContactItem::AddLabelFieldL()
CContactItem::Agent()
CContactItem::Attributes()const
CContactItem::CardFields()const
CContactItem::ClearFieldContent()
CContactItem::DecAccessCount()
CContactItem::ExternalizeL(RWriteStream &)const
CContactItem::Guid()
CContactItem::Id()const
CContactItem::IncAccessCount()
CContactItem::InsertFieldL(CContactItemField &,TInt)
CContactItem::InternalizeL(RReadStream &)
CContactItem::IsDeletable()
CContactItem::IsDeleted()const
CContactItem::IsHidden()
CContactItem::IsSystem()
CContactItem::LastModified()const
CContactItem::NewLC(RReadStream &)
CContactItem::NewLC(TUid)
CContactItem::PopulateStoreL(CStreamStore &,CArrayFix< TFieldHeader > &)const
CContactItem::RemoveField(TInt)
CContactItem::RestoreTemplateFieldsL(const CContactItemFieldSet &,const CContactItemFieldSet &,const CContactItemViewDef &)
CContactItem::SetAccessCount(TUint32)
CContactItem::SetAttributes(TUint32)
CContactItem::SetCreationDate(const TTime &)
CContactItem::SetDeleted(TBool)
CContactItem::SetHidden(TBool)
CContactItem::SetId(TContactItemId)
CContactItem::SetLastModified(const TTime &)
CContactItem::SetSystem(TBool)
CContactItem::SetTemplateRefId(TContactItemId)
CContactItem::SetUidStringL(TDesC &)
CContactItem::TemplateRefId()const
CContactItem::UidStringL(TInt64)const
CContactItem::UpdateFieldSet(CContactItemFieldSet *)
CContactItem::~CContactItem()

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

Member Function Documentation

GetTemplateLabelL ( )

IMPORT_C TPtrCGetTemplateLabelL()

Gets the label for a contact card template.

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

Returns: The template label.

HasItemLabelField ( )

IMPORT_C TBoolHasItemLabelField()[protected]

NewL ( )

IMPORT_C CContactCardTemplate *NewL()[protected, static]

NewL ( const CContactItem * )

IMPORT_C CContactCardTemplate *NewL(const CContactItem *aTemplate)[protected, static]

NewLC ( )

IMPORT_C CContactCardTemplate *NewLC()[protected, static]

NewLC ( const CContactItem * )

IMPORT_C CContactCardTemplate *NewLC(const CContactItem *aTemplate)[protected, static]

ReservedFunction1 ( )

IMPORT_C voidReservedFunction1()[protected]

Intended usage: Reserved to preserve future BC

ReservedFunction2 ( )

IMPORT_C voidReservedFunction2()[protected]

Intended usage: Reserved to preserve future BC

SetTemplateLabelL ( const TDesC & )

IMPORT_C voidSetTemplateLabelL(const TDesC &aLabel)

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.

leave
KErrNotFound Indicates there is no template label field in the template.
ParameterDescription
aLabelThe new template label.

Type ( )

IMPORT_C TUidType()const [protected, virtual]

Reimplemented from CContactItem::Type()const

Gets the contact item's type.

Returns: The contact item's type.