Class CContactGroup

class CContactGroup : public CContactItemPlusGroup;

Description

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.

Derivation

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

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

• CContactItemPlusGroup - Abstract base class for CContactGroup, CContactCard and CContactOwnCard

• CContactGroup - A contact group

Members

Defined in CContactGroup:

• ContainsItem()Tests whether a contact item is a member of the group
• ExternalizeL()Externalises a CContactGroup object to a write stream
• GetGroupLabelL()Gets the group label
• GroupsJoinedLC()Returns a pointer to a list of contact groups to which the current group belongs (a contact group can belong to other groups)
• HasItemLabelField()Tests whether the group has a label field (of type KUidContactFieldTemplateLabel)
• InternalizeL()Internalises a CContactGroup object from a read stream
• IsSystem()Tests the value of the group's system attribute
• ItemsContained()Returns a constant pointer to the group's list of members
• ItemsContainedLC()Returns a pointer to a copy of the group's list of members
• NewL()Allocates and constructs a new default contact card group
• NewLC()Allocates and constructs a new default contact card group
• SetGroupLabelL()Sets the group label, replacing any existing one
• SetSystem()Sets the value of the group's system attribute
• Type()Implements CContactItem::Type()
• ~CContactGroup()The destructor frees all resources owned by the contact group, prior to its destruction

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
• 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
• 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
• 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
• 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

Inherited from CContactItemPlusGroup:

• GroupsJoined()Returns a pointer to a list of contact item IDs which identify the groups to which the derived class object belongs

static IMPORT_C CContactGroup *NewL();

Description

Allocates and constructs a new default contact card group. The group has no label and its list of members is NULL.

Contact groups should be constructed using the factory functions provided in class CContactDatabase, for example CreateContactGroupL().

Return value

CContactGroup * Pointer to the new contact card group.

static IMPORT_C CContactGroup *NewLC();

Description

Allocates and constructs a new default contact card group.

The group has no label and its list of members is NULL.

Contact groups should be constructed using the factory functions provided in class CContactDatabase, for example CreateContactGroupLC().

Return value

CContactGroup * Pointer to the new contact card group. This is left on the cleanup stack.

IMPORT_C ~CContactGroup();

Description

The destructor frees all resources owned by the contact group, prior to its destruction.

virtual IMPORT_C TUid Type() const;

Description

Implements CContactItem::Type().

Return value

TUid KUidContactGroup.

IMPORT_C CContactIdArray *ItemsContainedLC() const;

Description

Returns a pointer to a copy of the group's list of members.

Return value

CContactIdArray * Pointer to a copy of the group's list of members. This is left on the cleanup stack.

IMPORT_C const CContactIdArray *ItemsContained() const;

Description

Returns a constant pointer to the group's list of members.

Return value

const CContactIdArray * Pointer to the group's list of members.

IMPORT_C TBool IsSystem() const;

Description

Tests the value of the group's system attribute.

The system attribute is not currently used in the Contacts Model API.

Return value

TBool ETrue if system, EFalse if not.

IMPORT_C void SetSystem(TBool aSystem);

Description

Sets the value of the group's system attribute.

The system attribute is not currently used in the Contacts Model API.

Parameters

TBool aSystem ETrue to set the system attribute, EFalse to unset it.

IMPORT_C TBool ContainsItem(TContactItemId aContactId);

Description

Tests whether a contact item is a member of the group.

Parameters

TContactItemId aContactId The ID of the contact item to test.

Return value

TBool ETrue if the item is a member of the group, EFalse if not.

IMPORT_C void SetGroupLabelL(const TDesC &aLabel);

Description

Sets the group label, replacing any existing one.

Parameters

const TDesC &aLabel The new group label.

Leave codes

KErrNotFound The group has no label field (of type KUidContactFieldTemplateLabel).

IMPORT_C TPtrC GetGroupLabelL();

Description

Gets the group label.

Return value

TPtrC The new group label.

Leave codes

KErrNotFound The group has no label field (of type KUidContactFieldTemplateLabel).

IMPORT_C TBool HasItemLabelField();

Description

Tests whether the group has a label field (of type KUidContactFieldTemplateLabel).

Return value

TBool ETrue if the group has a label field. EFalse if not.

IMPORT_C CContactIdArray *GroupsJoinedLC() const;

Description

Returns a pointer to a list of contact groups to which the current group belongs (a contact group can belong to other groups).

Return value

CContactIdArray * A pointer to a copy of the array of groups IDs to which this group belongs. This array is empty if the group is not a member of any other groups. The caller takes ownership of this object, so is responsible for its deletion.

virtual void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises a CContactGroup object to a write stream.

Parameters

RWriteStream &aStream Stream to which the object should be externalised.

virtual void InternalizeL(RReadStream &aStream);

Description

Internalises a CContactGroup object from a read stream.

Parameters

RReadStream &aStream Stream from which the object should be internalised.