| 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.
| Public Member Functions | |
|---|---|
| IMPORT_C void | AddL(TFieldType) |
| IMPORT_C TBool | Contains(const CContactItem &) |
| TInt | Count() |
| IMPORT_C void | ExternalizeL(RWriteStream &) |
| IMPORT_C TInt | Find(const CContentType &) |
| IMPORT_C TInt | Find(TFieldType) |
| IMPORT_C void | InternalizeL(RReadStream &) |
| IMPORT_C TBool | MatchesAll() |
| TMode | Mode() |
| IMPORT_C CContactItemViewDef * | NewL(TUse, TMode) |
| IMPORT_C CContactItemViewDef * | NewLC(TUse, TMode) |
| CContactItemViewDef * | NewLC(RReadStream &) |
| IMPORT_C void | Remove(TFieldType) |
| IMPORT_C void | Remove(TInt) |
| void | Reset() |
| void | SetMode(TMode) |
| void | SetUse(TUse) |
| TUse | Use() |
| TUid | operator[](TInt) |
| Private Member Functions | |
|---|---|
| CContactItemViewDef(TUse, TMode) | |
| Public Member Enumerations | |
|---|---|
| enum | TMode { EIncludeHiddenFields, EMaskHiddenFields } |
| enum | TUse { EIncludeFields, EMaskFields } |
| Private Attributes | |
|---|---|
| CArrayFixFlat< TUid > | iFieldTypes |
| TMode | iMode |
| TUse | iUse |
| IMPORT_C TBool | Contains | ( | const CContactItem & | aItem | ) |
| const CContactItem & aItem |
| TInt | Count | ( | ) | const [inline] |
Gets the number of field types in the view definition.
The number of field types in the view definition.
| IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream | ) | const |
| RWriteStream & aStream |
| IMPORT_C TInt | Find | ( | const CContentType & | aContentType | ) | const |
| const CContentType & aContentType |
| IMPORT_C void | InternalizeL | ( | RReadStream & | aStream | ) |
| RReadStream & aStream |
| CContactItemViewDef * | NewLC | ( | RReadStream & | aStream | ) | [static] |
| RReadStream & aStream |
| void | SetMode | ( | TMode | aMode | ) | [inline] |
Sets the view definition's mode.
| TMode aMode | The new TMode setting. |
| void | SetUse | ( | TUse | aUse | ) | [inline] |
Sets the view definition's use.
| TUse aUse | The new TUse setting. |
| TUid | operator[] | ( | TInt | aIndex | ) | const [inline] |
Gets the field type located at a specified index position within the field type array.
The field type located at index aIndex within the array (this is equivalent to a TFieldType).
| 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. |
Include or exclude hidden fields.
| EIncludeHiddenFields |
Include hidden fields in the view. |
| EMaskHiddenFields |
Exclude hidden fields from the view. |
Include or exclude specified fields.
| EIncludeFields |
Include specified fields in the view. |
| EMaskFields |
Exclude specified fields from the view. |