CContactItemViewDef Class Reference

class CContactItemViewDef : public CBase

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.

Inherits from

Constructor & Destructor Documentation

CContactItemViewDef(TUse, TMode)

CContactItemViewDef(TUseaUse,
TModeaMode
)[private]

Parameters

TUse aUse
TMode aMode

Member Functions Documentation

AddL(TFieldType)

IMPORT_C voidAddL(TFieldTypeaFieldType)

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

Parameters

TFieldType aFieldTypeThe field type to append to the array of field types.

Contains(const CContactItem &)

IMPORT_C TBoolContains(const CContactItem &aItem)

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 & aItemThe contact item to test.

Count()

TInt Count()const [inline]

Gets the number of field types in the view definition.

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

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 & aStreamStream to which the item view definition should be externalised.

Find(const CContentType &)

IMPORT_C TIntFind(const CContentType &aContentType)const

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

Parameters

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

Find(TFieldType)

IMPORT_C TIntFind(TFieldTypeaFieldType)const

Searches the view definition for the specified field type.

Parameters

TFieldType aFieldTypeThe field type to search for.

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)

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 & aStreamStream from which the item view definition should be internalised.

MatchesAll()

IMPORT_C TBoolMatchesAll()const

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.

Mode()

TMode Mode()const [inline]

Gets the view definition's mode.

NewL(TUse, TMode)

IMPORT_C CContactItemViewDef *NewL(TUseaUse,
TModeaMode
)[static]

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

Parameters

TUse aUseSpecifies whether to include or exclude specified fields.
TMode aModeSpecifies whether to include or exclude hidden fields.

NewLC(TUse, TMode)

IMPORT_C CContactItemViewDef *NewLC(TUseaUse,
TModeaMode
)[static]

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

Parameters

TUse aUseSpecifies whether to include or exclude specified fields.
TMode aModeSpecifies whether to include or exclude hidden fields.

NewLC(RReadStream &)

CContactItemViewDef *NewLC(RReadStream &aStream)[static]

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

Parameters

RReadStream & aStreamRReadStream containing object to internalize.

Remove(TFieldType)

IMPORT_C voidRemove(TFieldTypeaFieldType)

Removes a field type, identified by its UID.

Parameters

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

Remove(TInt)

IMPORT_C voidRemove(TIntaIndex)

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

Parameters

TInt aIndexThe 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.

Reset()

voidReset()[inline]

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

SetMode(TMode)

voidSetMode(TModeaMode)[inline]

Sets the view definition's mode.

Parameters

TMode aModeThe new TMode setting.

SetUse(TUse)

voidSetUse(TUseaUse)[inline]

Sets the view definition's use.

Parameters

TUse aUseThe new TUse setting.

Use()

TUse Use()const [inline]

Gets the view definition's use.

operator[](TInt)

TUid operator[](TIntaIndex)const [inline]

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

Parameters

TInt aIndexThe 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.

Member Enumerations Documentation

Enum TMode

Include or exclude hidden fields.

Enumerators

EIncludeHiddenFields

Include hidden fields in the view.

EMaskHiddenFields

Exclude hidden fields from the view.

Enum TUse

Include or exclude specified fields.

Enumerators

EIncludeFields

Include specified fields in the view.

EMaskFields

Exclude specified fields from the view.

Member Data Documentation

CArrayFixFlat< TUid > iFieldTypes

CArrayFixFlat< TUid >iFieldTypes[private]

TMode iMode

TMode iMode[private]

TUse iUse

TUse iUse[private]