Class CContactViewDef

class CContactViewDef : public CBase;

Description

Specifies a subset of fields to be loaded when reading a contact item.

A default view definition is owned by the contact database. It is set using CContactDatabase::SetViewDefinitionL() and is used in calls to CContactDatabase::ReadContactL(), ReadContactLC() and ReadContactAndAgentL() when no view definition is specified.

The view definition owns the item view definition (see the CContactItemViewDef class), which stores the view definition's field types, use and mode.

The following functions declared in class CContactViewDef have not been implemented:- Groups(), AddL().

Derivation

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

• CContactViewDef - Specifies a subset of fields to be loaded when reading a contact item

Members

Defined in CContactViewDef:

• AddL()This function is not implemented
• ExternalizeL()Externalises the object's item view definition to a write stream
• Groups()This function is not implemented
• InternalizeL()Internalises the object's item view definition from a read stream
• ItemDef()Gets the object's item view definition
• NewL()Allocates and constructs a view definition
• NewL()Allocates and constructs a view definition
• NewLC()Allocates and constructs a view definition, leaving it on the cleanup stack
• NewLC()Allocates and constructs a view definition
• ~CContactViewDef()Destroys the view definition object and deletes its owned item view definition

Inherited from CBase:

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

static IMPORT_C CContactViewDef *NewL();

Description

Allocates and constructs a view definition.

Return value

CContactViewDef * Pointer to the new view definition.

static IMPORT_C CContactViewDef *NewLC();

Description

Allocates and constructs a view definition, leaving it on the cleanup stack.

Return value

CContactViewDef * Pointer to the new view definition.

static IMPORT_C CContactViewDef *NewL(CContactItemViewDef *aItemDef);

Description

Allocates and constructs a view definition.

Parameters

CContactItemViewDef *aItemDef Pointer to the item view definition. This contains the view definition's field types, use and mode. The view definition takes ownership of this.

Return value

CContactViewDef * Pointer to the new view definition.

static IMPORT_C CContactViewDef *NewLC(CContactItemViewDef *aItemDef);

Description

Allocates and constructs a view definition.

Parameters

CContactItemViewDef *aItemDef Pointer to the item view definition. This contains the view definition's field types, use and mode. The view definition takes ownership of this.

Return value

CContactViewDef * Pointer to the new view definition. This is left on the cleanup stack.

IMPORT_C ~CContactViewDef();

Description

Destroys the view definition object and deletes its owned item view definition.

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises the object's item view definition from a read stream.

Parameters

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

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises the object's item view definition to a write stream.

Parameters

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

IMPORT_C CContactItemViewDef &ItemDef() const;

Description

Gets the object's item view definition.

Return value

CContactItemViewDef & Reference to the item view definition.

IMPORT_C CContactIdArray &Groups() const;

Description

This function is not implemented

Return value

CContactIdArray &

inline void AddL(TFieldType aFieldType);

Description

This function is not implemented.

Parameters

TFieldType aFieldType The field type to append to the array of field types.