#include <app/cntviewbase.h>
| class CContactRemoteView : public CContactRemoteViewBase |
| Public Member Functions | |
|---|---|
| virtual TAny * | CContactViewBase_Reserved_1(TFunction, TAny *) |
| IMPORT_C void | GetSortOrderL(RContactViewSortOrder &) |
| IMPORT_C CContactRemoteView * | NewL(MContactViewObserver &, const CContactDatabase &, const RContactViewSortOrder &, TContactViewPreferences) |
| IMPORT_C CContactRemoteView * | NewL(MContactViewObserver &, const CContactDatabase &, const RContactViewSortOrder &, TContactViewPreferences, const TDesC8 &) |
| Protected Member Functions | |
|---|---|
| CContactRemoteView(const CContactDatabase &) | |
| ~CContactRemoteView() | |
| Inherited Attributes | |
|---|---|
| CContactRemoteViewBase::iView | |
| CContactViewBase::iDb | |
| CContactViewBase::iExtension | |
| CContactViewBase::iState | |
| Inherited Enumerations | |
|---|---|
| CContactViewBase:TFunction | |
| CContactViewBase:TSearchType | |
| CContactViewBase:TState | |
An instantiable remote contact view class.
Remote views are associated with a CContactLocalView object held in the contacts server. They provide an efficient means for multiple clients to share the same underlying view.
The view preferences and sort order are specified on construction.
| CContactRemoteView | ( | const CContactDatabase & | aDb | ) | [protected] |
Protected C++ constructor.
| Parameter | Description |
|---|---|
| aDb | The underlying database containing the contact items. |
Reimplemented from CContactRemoteViewBase::CContactViewBase_Reserved_1(TFunction,TAny *)
| Parameter | Description |
|---|---|
| aFunction | An enum value that identifies which helper function is called. |
| aParams | Parameters to the helper function being called. |
Returns: Any return values of the helper function called from this function or NULL.
| IMPORT_C void | GetSortOrderL | ( | RContactViewSortOrder & | aSortOrder | ) |
Gets the server side view's sort order, as set in the NewL() function.
| Parameter | Description |
|---|---|
| aSortOrder | On return, the sort order for the server side view. |
| IMPORT_C CContactRemoteView * | NewL | ( | MContactViewObserver & | aObserver, |
| const CContactDatabase & | aDb, | |||
| const RContactViewSortOrder & | aSortOrder, | |||
| TContactViewPreferences | aContactTypes | |||
| ) | [static] | |||
Allocates and constructs a remote contact view object.
This function causes a new local view object to be created in the contacts server, unless one already exists with the specified view preferences and sort order. In that case, this client is given shared access to it.
Starts the active notifier, so that this view receives change events from the server side view object. These change events are in turn passed to this view's observers.
| Parameter | Description |
|---|---|
| aObserver | An observer that receives notifications when this view is ready for use and when changes take place in it. The observer receives a TContactViewEvent::EReady event when the view is ready. An attempt to use the view before this notification causes a panic. |
| aDb | The underlying database containing the contact items. |
| aSortOrder | Specifies the fields to use to sort the items in the server side view. |
| aContactTypes | Specifies which types of contact items should be included in the view and the behaviour for items that do not have content in any of the fields specified in the sort order. |
Returns: The newly constructed remote view object.
| IMPORT_C CContactRemoteView * | NewL | ( | MContactViewObserver & | aObserver, |
| const CContactDatabase & | aDb, | |||
| const RContactViewSortOrder & | aSortOrder, | |||
| TContactViewPreferences | aContactTypes, | |||
| const TDesC8 & | aSortPluginName | |||
| ) | [static] | |||
Allocates and constructs a remote contact view object.
This function causes a new local view object to be created in the contacts server, unless one already exists with the specified view preferences and sort order. In that case, this client is given shared access to it.
Starts the active notifier, so that this view receives change events from the server side view object. These change events are in turn passed to this view's observers.
| Parameter | Description |
|---|---|
| aObserver | An observer that receives notifications when this view is ready for use and when changes take place in it. The observer receives a TContactViewEvent::EReady event when the view is ready. An attempt to use the view before this notification causes a panic. |
| aDb | The underlying database containing the contact items. |
| aSortOrder | Specifies the fields to use to sort the items in the server side view. |
| aContactTypes | Specifies which types of contact items should be included in the view and the behaviour for items that do not have content in any of the fields specified in the sort order. |
| aSortPluginName | Specifies a plug-in that will be used to compare view contacts when the the view is sorted. This name is used by ECOM to select the plugin, and is matched with the "default_data" of all ECOM plugins that support the required interface. |
Returns: The newly constructed remote view object.