Class CContactItemViewDef

class CContactItemViewDef : public CBase;

Description

A view definition for a contact item.

When reading or opening a contact item using the CContactDatabase class, a view definition may be specified to indicate which field data should be retrieved. See for instance CContactDatabase::ReadContactL().

A view definition for a contact item contains an array of field types, a use (CContactItemViewDef::TUse) and a mode (CContactItemViewDef::TMode). The use indicates whether the field types contained in the view definition should be included in or excluded from the view. The mode indicates whether fields with the hidden attribute should be included or excluded.

Derivation

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

• CContactItemViewDef - A view definition for a contact item

Members

Defined in CContactItemViewDef:
AddL(), Contains(), Count(), EIncludeFields, EIncludeHiddenFields, EMaskFields, EMaskHiddenFields, ExternalizeL(), Find(), Find(), InternalizeL(), MatchesAll(), Mode(), NewL(), NewLC(), Remove(), Remove(), Reset(), SetMode(), SetUse(), TMode, TUse, Use(), operator[]()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CContactItemViewDef *NewL(TUse aUse, TMode aMode);

Description

Allocates and constructs a new CContactItemViewDef, with a use and a mode.

Parameters

TUse aUse Specifies whether to include or exclude specified fields. TMode aMode Specifies whether to include or exclude hidden fields.

Return value

CContactItemViewDef * Pointer to the newly created view definition.

static IMPORT_C CContactItemViewDef *NewLC(TUse aUse, TMode aMode);

Description

Allocates and constructs a new CContactItemViewDef, specifying a use and a mode, leaving the object on the cleanup stack.

Parameters

TUse aUse Specifies whether to include or exclude specified fields. TMode aMode Specifies whether to include or exclude hidden fields.

Return value

CContactItemViewDef * Pointer to the newly created view definition.

inline TUid operator[](TInt aIndex) const;

Description

Gets the field type located at a specified index position within the field type array.

Parameters

TInt aIndex The position of the field type in the array, relative to zero. It must be non-negative and less than the number of objects in the array otherwise the function raises a panic.

Return value

TUid The field type located at index aIndex within the array (this is equivalent to a TFieldType).

IMPORT_C TInt Find(const CContentType &aContentType) const;

Description

Searches the view definition for any field type contained in the specified content type.

Parameters

const CContentType &aContentType Content type containing the field types to search for.

Return value

TInt The index in the view definition of the first matching field type or KErrNotFound.

IMPORT_C TInt Find(TFieldType aFieldType) const;

Description

Searches the view definition for the specified field type.

Parameters

TFieldType aFieldType The field type to search for.

Return value

TInt The index in the view definition of the matching field type, or KErrNotFound.

inline TInt Count() const;

Description

Gets the number of field types in the view definition.

Return value

TInt The number of field types in the view definition.

inline void Reset();

Description

Deletes all field types from the view definition's field type array.

IMPORT_C void AddL(TFieldType aFieldType);

Description

Appends a field type to the view definition's array of field types.

Parameters

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

IMPORT_C void Remove(TFieldType aFieldType);

Description

Removes a field type, identified by its UID.

Parameters

TFieldType aFieldType The field type to remove from the list. This must be present in the CContactItemViewDef object, or the function raises a panic.

IMPORT_C void Remove(TInt aIndex);

Description

Removes a field type, identified by its index into the array of field types.

Parameters

TInt aIndex The index of the element to delete. The position is relative to zero. This value must not be negative and must not be greater than the number of elements currently in the list, or the function raises a panic.

inline TUse Use() const;

Description

Gets the view definition's use.

Return value

TUse The current TUse setting.

inline void SetUse(TUse aUse);

Description

Sets the view definition's use.

Parameters

TUse aUse The new TUse setting.

inline TMode Mode() const;

Description

Gets the view definition's mode.

Return value

TMode The current TMode setting.

inline void SetMode(TMode aMode);

Description

Sets the view definition's mode.

Parameters

TMode aMode The new TMode setting.

IMPORT_C TBool Contains(const CContactItem &aItem);

Description

Tests whether a contact item complies with the view definition.

This indicates whether or not the item will be included in the view.

Parameters

const CContactItem &aItem The contact item to test.

Return value

TBool ETrue if any of the item's fields are contained in the view definition (so that the item will be included in the view), EFalse if none of the item's fields are contained in the view definition (so that the item will not be included in the view).

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises the item view definition from a read stream. The presence of this function means that the standard templated operator>>() (defined in s32strm.h) is available to internalise objects of this class.

Parameters

RReadStream &aStream Stream from which the item view definition should be internalised.

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises the item view definition to a write stream. The presence of this function means that the standard templated operator<<() (defined in s32strm.h) is available to externalise objects of this class.

Parameters

RWriteStream &aStream Stream to which the item view definition should be externalised.

IMPORT_C TBool MatchesAll() const;

Description

Tests whether the view definition contains a field type with the value KUidContactFieldMatchAll.

If this is the case, all fields in the contact item are retrieved, regardless of the other field types specified in the view definition.

Return value

TBool ETrue if all field types are matched, EFalse if not.

TUse

Description

Include or exclude specified fields.

EIncludeFields Include specified fields in the view. EMaskFields Exclude specified fields from the view.

TMode

Description

Include or exclude hidden fields.

EIncludeHiddenFields Include hidden fields in the view. EMaskHiddenFields Exclude hidden fields from the view.