Class CContactRemoteView

class CContactRemoteView : public CContactRemoteViewBase;

Description

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.

Derivation

• CContactRemoteViewBase - No description.

• CContactRemoteView - An instantiable remote contact view class

Members

Defined in CContactRemoteView:

• CContactViewBase_Reserved_1()This is a reserved virtual exported function that is used for BC proofing against present and future additions of new exported virtual functions
• GetSortOrderL()Gets the server side view's sort order, as set in the NewL() function
• NewL()Allocates and constructs a remote contact view object
• NewL()Allocates and constructs a remote contact view object

Capability:

ReadUserData

static IMPORT_C CContactRemoteView *NewL(MContactViewObserver &aObserver, const CContactDatabase &aDb, const RContactViewSortOrder &aSortOrder, TContactViewPreferences aContactTypes);

Description

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.

Parameters

MContactViewObserver &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. const CContactDatabase &aDb The underlying database containing the contact items. const RContactViewSortOrder &aSortOrder Specifies the fields to use to sort the items in the server side view. TContactViewPreferences 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.

Return value

CContactRemoteView * The newly constructed remote view object.

Capability:

ReadUserData

static IMPORT_C CContactRemoteView *NewL(MContactViewObserver &aObserver, const CContactDatabase &aDb, const RContactViewSortOrder &aSortOrder, TContactViewPreferences aContactTypes, const TDesC8 &aSortPluginName);

Description

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.

Parameters

MContactViewObserver &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. const CContactDatabase &aDb The underlying database containing the contact items. const RContactViewSortOrder &aSortOrder Specifies the fields to use to sort the items in the server side view. TContactViewPreferences 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. const TDesC8 &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.

Return value

CContactRemoteView * The newly constructed remote view object.

Capability:

ReadUserData

IMPORT_C void GetSortOrderL(RContactViewSortOrder &aSortOrder);

Description

Gets the server side view's sort order, as set in the NewL() function.

Parameters

RContactViewSortOrder &aSortOrder On return, the sort order for the server side view.

Capability:

ReadUserData

virtual TAny *CContactViewBase_Reserved_1(TFunction aFunction, TAny *aParams);

Description

This is a reserved virtual exported function that is used for BC proofing against present and future additions of new exported virtual functions.

Parameters

TFunction aFunction An enum value that identifies which helper function is called. TAny *aParams Parameters to the helper function being called.

Return value

TAny * Any return values of the helper function called from this function or NULL.