CContactGroup Class Reference

class CContactGroup : public CContactItemPlusGroup

A contact group.

A contact group is a contact item which holds a set of associated contact item IDs. The members of the group may be contact cards, own cards, or even other groups. The group has a label which identifies the group to users, e.g. "family", or "colleagues". The type of a contact group is KUidContactGroup, as returned by Type().

Objects of this class are constructed using CContactDatabase::CreateContactGroupL() or CreateContactGroupLC(). These functions create the group, optionally with a label, add it to the database, and return a pointer to it.

To create an association between a card and a group, use CContactDatabase::AddContactToGroupL() and to remove the association, use RemoveContactFromGroupL(). To find out which groups a card belongs to, use CContactCard::GroupsJoinedLC() or CContactOwnCard::GroupsJoinedLC().

The function CContactDatabase::GetGroupIdListL() may be used to retrieve a list of IDs for all groups in the database.

Inherits from

Public Member Functions
~CContactGroup()
IMPORT_C voidAddContactL(TContactItemId)
IMPORT_C TBoolContainsItem(TContactItemId)
voidExternalizeL(RWriteStream &)
IMPORT_C TPtrCGetGroupLabelL()
IMPORT_C CContactIdArray *GroupsJoinedLC()
IMPORT_C TBoolHasItemLabelField()
voidInternalizeL(RReadStream &)
IMPORT_C TBoolIsSystem()
IMPORT_C const CContactIdArray *ItemsContained()
IMPORT_C CContactIdArray *ItemsContainedLC()
IMPORT_C CContactGroup *NewL()
IMPORT_C CContactGroup *NewLC()
IMPORT_C voidRemoveContactL(TContactItemId)
IMPORT_C voidResetItems()
IMPORT_C voidSetGroupLabelL(const TDesC &)
IMPORT_C voidSetItems(CContactIdArray *)
IMPORT_C voidSetSystem(TBool)
IMPORT_C TUidType()
Private Member Functions
CContactGroup()
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::Guid()
CContactItem::Id()const
CContactItem::IncAccessCount()
CContactItem::InsertFieldL(CContactItemField &,TInt)
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::SetTemplateRefId(TContactItemId)
CContactItem::SetUidStringL(TDesC &)
CContactItem::TemplateRefId()const
CContactItem::UidStringL(TInt64)const
CContactItem::UpdateFieldSet(CContactItemFieldSet *)
CContactItem::~CContactItem()
CContactItemPlusGroup::CContactItemPlusGroup()
CContactItemPlusGroup::GroupsJoined()const
CContactItemPlusGroup::ResetGroups()
CContactItemPlusGroup::SetGroups(CContactIdArray *)
CContactItemPlusGroup::~CContactItemPlusGroup()
Inherited Enumerations
CContactItem:@338
Private Attributes
CContactIdArray *iItems

Constructor & Destructor Documentation

CContactGroup()

CContactGroup()[private]

~CContactGroup()

IMPORT_C~CContactGroup()

Member Functions Documentation

AddContactL(TContactItemId)

IMPORT_C voidAddContactL(TContactItemIdaContactId)

Parameters

TContactItemId aContactId

ContainsItem(TContactItemId)

IMPORT_C TBoolContainsItem(TContactItemIdaContactId)

Parameters

TContactItemId aContactId

ExternalizeL(RWriteStream &)

voidExternalizeL(RWriteStream &aStream)const [virtual]

Parameters

RWriteStream & aStream

GetGroupLabelL()

IMPORT_C TPtrCGetGroupLabelL()

GroupsJoinedLC()

IMPORT_C CContactIdArray *GroupsJoinedLC()const

HasItemLabelField()

IMPORT_C TBoolHasItemLabelField()

InternalizeL(RReadStream &)

voidInternalizeL(RReadStream &aStream)[virtual]

Parameters

RReadStream & aStream

IsSystem()

IMPORT_C TBoolIsSystem()const

ItemsContained()

IMPORT_C const CContactIdArray *ItemsContained()const

ItemsContainedLC()

IMPORT_C CContactIdArray *ItemsContainedLC()const

NewL()

IMPORT_C CContactGroup *NewL()[static]

NewLC()

IMPORT_C CContactGroup *NewLC()[static]

RemoveContactL(TContactItemId)

IMPORT_C voidRemoveContactL(TContactItemIdaContactId)

Parameters

TContactItemId aContactId

ResetItems()

IMPORT_C voidResetItems()

SetGroupLabelL(const TDesC &)

IMPORT_C voidSetGroupLabelL(const TDesC &aLabel)

Parameters

const TDesC & aLabel

SetItems(CContactIdArray *)

IMPORT_C voidSetItems(CContactIdArray *aItems)

Parameters

CContactIdArray * aItems

SetSystem(TBool)

IMPORT_C voidSetSystem(TBoolaSystem)

Parameters

TBool aSystem

Type()

IMPORT_C TUidType()const [virtual]

Gets the contact item's type.

The contact item's type.

Member Data Documentation

CContactIdArray * iItems

CContactIdArray *iItems[private]