#include <app/CVPbkContactViewDefinition.h>
| class CVPbkContactViewDefinition : public CBase |
A contact view definition.
This class is needed when a client needs to create a contact view. A client can define a structure of VPBK_CONTACT_VIEW from VPbkContactView.rh and use this class to read the definition or construct an empty definition and then set the information to it.
A view definition enables complex view structures. A client can e.g. create a composite view that contains subviews from multiple contact stores. However, it's up to client to understand that there are certain limits for the structure. E.g. a contact view is a leaf view and can not have subviews. Another important thing to keep in mind is that complex view structures consumes more RAM that can be a problem if there are thousands of contacts in the view.
See also: VPBK_CONTACT_VIEW in VPbkContactView.rh CVPbkContactManager::CreateContactViewLC
| IMPORT_C void | AddSubViewL | ( | CVPbkContactViewDefinition * | aSubView | ) |
Adds new view as a subview. This object takes ownership of the subview. If this function leaves ownership is not taken.
| Parameter | Description |
|---|---|
| aSubView | The new subview to add. |
| IMPORT_C MVPbkContactSelector * | ContactSelector | ( | ) | const |
Gives either the contact selector or NULL. Ownership is not transferred.
| IMPORT_C CVPbkFieldTypeSelector * | FieldTypeFilter | ( | ) | const |
Returns the field type selector used to filter the view or NULL.
The view contains only contacts having the fields defined by the field type filter.
Returns: The field type filter.
| IMPORT_C TBool | FlagIsOn | ( | TVPbkContactViewFlag | aFlag | ) | const |
Returns ETrue if aFlag is on, otherwise EFalse.
| Parameter | Description |
|---|---|
| aFlag | The flag to check. |
Returns: A flag state.
| IMPORT_C const TDesC & | Name | ( | ) | const |
Returns the name of the view. Default is KNullDesC.
In view types EVPbkContactsView and EVPbkGroupsView the name can be used as a shared view identifier by the store. Shared view creation is indicated by TVPbkContactViewSharing. If the name is empty for shared view then store implementation uses its default name. This is a preferred way to use shared views in the platform.
In view type EVPbkFoldingView the name is the label of the only contact in the view.
In view type EVPbkCompositeView the name has no meaning.
Returns: The name of the view.
| IMPORT_C CVPbkContactViewDefinition * | NewL | ( | TResourceReader & | aReader | ) | [static] |
Creates a new contact view definition and initializes it from resource. Takes a VPBK_CONTACT_VIEW resource structure as a parameter.
| Parameter | Description |
|---|---|
| aReader | A resource reader to a VPBK_CONTACT_VIEW structure. |
Returns: A new instance of this class.
| IMPORT_C CVPbkContactViewDefinition * | NewL | ( | ) | [static] |
Creates a new empty contact view definition. Client must then set the needed information.
Returns: A new instance of this class.
| IMPORT_C CVPbkContactViewDefinition * | NewL | ( | const CVPbkContactViewDefinition & | aViewDef | ) | [static] |
Constructs a new contact view definition from an existing one by copying the data.
| Parameter | Description |
|---|---|
| aViewDef | A view definition to copy. |
Returns: A new instance of this class.
| IMPORT_C CVPbkContactViewDefinition * | NewLC | ( | TResourceReader & | aReader | ) | [static] |
Creates a new contact view definition and initializes it from resource. Takes a VPBK_CONTACT_VIEW resource structure as a parameter.
| Parameter | Description |
|---|---|
| aReader | A resource reader to a VPBK_CONTACT_VIEW structure. |
Returns: A new instance of this class.
| IMPORT_C CVPbkContactViewDefinition * | NewLC | ( | ) | [static] |
Creates a new empty contact view definition. Client must then set the needed information.
Returns: A new instance of this class.
| IMPORT_C CVPbkContactViewDefinition * | NewLC | ( | const CVPbkContactViewDefinition & | aViewDef | ) | [static] |
Constructs a new contact view definition from an existing one by copying the data.
| Parameter | Description |
|---|---|
| aViewDef | A view definition to copy. |
Returns: A new instance of this class.
| IMPORT_C void | SetContactSelector | ( | MVPbkContactSelector * | aContactSelector | ) |
Sets the contact selector used to filter the view.
The view contains only contacts accepted by the selector.
| Parameter | Description |
|---|---|
| aContactSelector | The contact selector. Use NULL to filter nothing. Ownership not transferred. |
| IMPORT_C void | SetFieldTypeFilterL | ( | CVPbkFieldTypeSelector * | aFilter | ) |
Sets the field type selector used to filter the view.
The view contains only contacts having the fields defined by the field type filter.
| Parameter | Description |
|---|---|
| aFilter | The field type filter. Use NULL to filter nothing. |
| IMPORT_C void | SetFlag | ( | TVPbkContactViewFlag | aFlag, |
| TBool | aState | |||
| ) | ||||
Sets the saFlag's state as aState.
| Parameter | Description |
|---|---|
| aFlag | The flag to modify. |
| aState | The state to set. |
| IMPORT_C void | SetNameL | ( | const TDesC & | aName | ) |
Sets aName as this views Name. This function takes a copy of aName.
| Parameter | Description |
|---|---|
| aName | The name to set. |
| IMPORT_C void | SetSharing | ( | TVPbkContactViewSharing | aViewSharing | ) |
Sets the view sharing type.
| Parameter | Description |
|---|---|
| aViewSharing | One of the values defined in VPbkContactView.hrh. |
| IMPORT_C void | SetSortPolicy | ( | TVPbkContactViewSortPolicy | aSortPolicy | ) |
Sets aSortPolicy as this views sorting policy.
| Parameter | Description |
|---|---|
| aSortPolicy | The sort policy to set. |
| IMPORT_C void | SetType | ( | TVPbkContactViewType | aType | ) |
Sets aType as this views type.
| Parameter | Description |
|---|---|
| aType | The type to set. |
| IMPORT_C void | SetUriL | ( | const TDesC & | aUri | ) |
Sets aUri as this views URI. This function takes a copy of aUri.
| Parameter | Description |
|---|---|
| aUri | The URI to set. |
| IMPORT_C TVPbkContactViewSharing | Sharing | ( | ) | const |
Returns the view sharing type. The store can support a shared view creation for saving RAM.
Default value for types EVPbkContactsView and EVPbkGroupsView is EVPbkSharedView. Store implementation creates then a shared view if it's possible for the store. Prefer using the default values for saving resources.
For view types EVPbkFoldingView and EVPbkCompositeView the sharing has no effect.
See also the documentation of Name()
Returns: The view sharing type.
| IMPORT_C TVPbkContactViewSortPolicy | SortPolicy | ( | ) | const |
Returns the sorting policy of this view.
Returns: The sorting policy of this view.
| IMPORT_C const CVPbkContactViewDefinition & | SubViewAt | ( | TInt | aIndex | ) | const |
Returns the sub view definition at aIndex.
| Parameter | Description |
|---|---|
| aIndex | The index of the sub view definition. |
Returns: The sub view definition at aIndex.
| IMPORT_C CVPbkContactViewDefinition & | SubViewAt | ( | TInt | aIndex | ) |
Returns the sub view definition at aIndex.
| Parameter | Description |
|---|---|
| aIndex | The index to query. |
Returns: The sub view definition.
| IMPORT_C TInt | SubViewCount | ( | ) | const |
Returns the number of sub views owned by this view.
Returns: The number of sub views.
| IMPORT_C TVPbkContactViewType | Type | ( | ) | const |
Returns the type of this view.
Returns: The type of this view.
| IMPORT_C const TDesC & | Uri | ( | ) | const |
Returns the URI of this view. KNullDesC if this is not a leaf node.
Returns: The URI of this view or KNullDesC.