Class CViewContact

class CViewContact : public CBase;

Description

The representation of a contact item used in contact views.

It stores the contact item ID and other information. This includes a buffer holding the contents of all the item's fields, an array of indexes into the buffer indicating the start position of each field and a hint bit field (a combination of CContactDatabase::TContactViewFilter values) which is used in filtered views.

The fields are defined by the view's sort order (RContactViewSortOrder).

Derivation

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

• CViewContact - The representation of a contact item used in contact views

Members

Defined in CViewContact:

• AddFieldL()
• CViewContact()Constructs a CViewContact object
• ContactMatchesFilter()Checks if this contact matches the supplied filter
• ContactType()Gets the view item's type
• EContactItemThe contact view item is not a contact group
• EGroupThe contact view item is a contact group (CContactGroup)
• ExternalizeL()Externalises a CViewContact object to a write stream
• ExternalizedSize()Retrieves the number of bytes required to store the contact view item when externalised
• Field()Gets a pointer descriptor to the contents of the single field located at the specified field index
• FieldCount()Gets the number of fields in the contact view item
• Id()Gets the view item's ID
• InternalizeL()Internalises a CViewContact object from a read stream
• NewL()Allocates and constructs a CViewContact object, based on an existing one
• NewLC()Allocates and constructs a CViewContact object, based on an existing one
• SetContactType()Sets the view item's type
• SetId()Sets the view item's ID
• TViewContactTypeDefines whether the contact view item is a contact group
• ~CViewContact()Destructor

Inherited from CBase:

• Delete()Deletes the specified object
• Extension_()Extension function
• operator new()Initialises the object to binary zeroes

IMPORT_C CViewContact(TContactItemId aId);

Description

Constructs a CViewContact object.

This should not be called by clients. CViewContact::NewLC() should be used instead.

Parameters

static IMPORT_C CViewContact *NewL(const CViewContact &aContact);

Description

Allocates and constructs a CViewContact object, based on an existing one.

Parameters

Return value

static IMPORT_C CViewContact *NewLC(TContactItemId aId);

Description

Allocates and constructs a CViewContact object, based on an existing one.

Parameters

Return value

IMPORT_C ~CViewContact();

Description

Destructor.

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises a CViewContact object from a read stream.

Parameters

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises a CViewContact object to a write stream.

Parameters

IMPORT_C TInt ExternalizedSize() const;

Description

Retrieves the number of bytes required to store the contact view item when externalised.

Return value

IMPORT_C TInt FieldCount() const;

Description

Gets the number of fields in the contact view item.

Return value

IMPORT_C TPtrC Field(TInt aPosition) const;

Description

Gets a pointer descriptor to the contents of the single field located at the specified field index.

Parameters

Return value

Panic codes

IMPORT_C TBool ContactMatchesFilter(TInt aFilter) const;

Description

Checks if this contact matches the supplied filter.

Parameters

Return value

IMPORT_C void AddFieldL(const TDesC &aField);

Description

Parameters

inline TContactItemId Id() const;

Description

Gets the view item's ID.

Return value

inline TViewContactType ContactType() const;

Description

Gets the view item's type.

Return value

inline void SetId(TContactItemId aId);

Description

Sets the view item's ID.

Parameters

inline void SetContactType(CViewContact::TViewContactType aContactType);

Description

Sets the view item's type.

Parameters

TViewContactType

Description

Defines whether the contact view item is a contact group.