Class CContactItemPlusGroup

class CContactItemPlusGroup : public CContactItem;

Description

Abstract base class for CContactGroup, CContactCard and CContactOwnCard.

The purpose of this class is to avoid duplication of group functionality in its derived classes.

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

Members

Defined in CContactItemPlusGroup:

• ExternalizeL()Externalises a CContactItemPlusGroup object to a write stream
• GroupsJoined()Returns a pointer to a list of contact item IDs which identify the groups to which the derived class object belongs
• GroupsJoinedLC()Returns a pointer to a list of contact item IDs which identify the groups to which the derived class object belongs
• InternalizeL()Internalises a CContactItemPlusGroup object from a read stream
• ~CContactItemPlusGroup()Frees the array of group IDs to which the derived class object belongs

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
• 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
• Type()Gets the contact item's type
• 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: IMPORT_C ~CContactItemPlusGroup();

Description

Frees the array of group IDs to which the derived class object belongs. Frees the array of contact item IDs which identify the groups to which the derived class object belongs, prior to its destruction.

IMPORT_C const CContactIdArray *GroupsJoined() const;

Description

Returns a pointer to a list of contact item IDs which identify the groups to which the derived class object belongs.

Return value

const CContactIdArray * A pointer to the array of groups IDs to which the derived class object belongs. NULL if the object is not a member of any groups.

IMPORT_C CContactIdArray *GroupsJoinedLC() const;

Description

Returns a pointer to a list of contact item IDs which identify the groups to which the derived class object belongs.

Return value

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

virtual void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises a CContactItemPlusGroup object to a write stream.

Parameters

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

virtual void InternalizeL(RReadStream &aStream);

Description

Internalises a CContactItemPlusGroup object from a read stream.

Parameters

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