#include <app/cntdb.h>
| class CContactViewDef : public CBase |
| Public Member Functions | |
|---|---|
| ~CContactViewDef() | |
| void | AddL(TFieldType) |
| IMPORT_C void | ExternalizeL(RWriteStream &) |
| IMPORT_C CContactIdArray & | Groups() |
| IMPORT_C void | InternalizeL(RReadStream &) |
| IMPORT_C CContactItemViewDef & | ItemDef() |
| IMPORT_C CContactViewDef * | NewL() |
| IMPORT_C CContactViewDef * | NewL(CContactItemViewDef *) |
| IMPORT_C CContactViewDef * | NewLC() |
| IMPORT_C CContactViewDef * | NewLC(CContactItemViewDef *) |
| CContactViewDef * | NewLC(RReadStream &) |
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().
| IMPORT_C | ~CContactViewDef | ( | ) |
Destroys the view definition object and deletes its owned item view definition.
| void | AddL | ( | TFieldType | aFieldType | ) | [inline] |
This function is not implemented.
| Parameter | Description |
|---|---|
| aFieldType | The field type to append to the array of field types. |
| IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream | ) | const |
Externalises the object's item view definition to a write stream.
| Parameter | Description |
|---|---|
| aStream | Stream to which the object should be externalised. |
| IMPORT_C CContactIdArray & | Groups | ( | ) | const |
This function is not implemented
This function is not supported.
If called, it leaves with KErrNotSupported.
| IMPORT_C void | InternalizeL | ( | RReadStream & | aStream | ) |
Internalises the object's item view definition from a read stream.
| Parameter | Description |
|---|---|
| aStream | Stream from which the object should be internalised. |
| IMPORT_C CContactItemViewDef & | ItemDef | ( | ) | const |
Gets the object's item view definition.
Returns: Reference to the item view definition.
| IMPORT_C CContactViewDef * | NewL | ( | ) | [static] |
Allocates and constructs a view definition.
Returns: Pointer to the new view definition.
| IMPORT_C CContactViewDef * | NewL | ( | CContactItemViewDef * | aItemDef | ) | [static] |
Allocates and constructs a view definition.
| Parameter | Description |
|---|---|
| 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. |
Returns: Pointer to the new view definition.
| IMPORT_C CContactViewDef * | NewLC | ( | ) | [static] |
Allocates and constructs a view definition, leaving it on the cleanup stack.
Returns: Pointer to the new view definition.
| IMPORT_C CContactViewDef * | NewLC | ( | CContactItemViewDef * | aItemDef | ) | [static] |
Allocates and constructs a view definition.
| Parameter | Description |
|---|---|
| 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. |
Returns: Pointer to the new view definition. This is left on the cleanup stack.
| CContactViewDef * | NewLC | ( | RReadStream & | aStream | ) | [static] |
Allocates and constructs a view definition based on a RReadStream.
| Parameter | Description |
|---|---|
| aStream | RReadStream containing object to internalize. |
Returns: Pointer to the new view definition. This is left on the cleanup stack.