#include <cntviewbase.h>
Link against:
cntmodel.lib
Class CContactNamedRemoteView
class CContactNamedRemoteView : public CContactRemoteView;
Description
A named remote contact view.
This class enables multiple clients to share a named server side view. It also provides a function to change the sort order.
If the sort order is changed, a notification is sent to all users of the named view.
Derivation
CContactRemoteViewBase
- No description.
CContactNamedRemoteView
- A named remote contact view
Members
Defined in CContactNamedRemoteView
:
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
ChangeSortOrderL()
Re-sorts the server side view using the specified sort order
NewL()
Allocates and constructs a named remote contact view object
NewL()
Allocates and constructs a named remote contact view object
Inherited from CContactRemoteView
:
GetSortOrderL()
Gets the server side view's sort order, as set in the NewL() function
Construction and destruction
static IMPORT_C CContactNamedRemoteView *NewL(MContactViewObserver &aObserver, const TDesC &aName, const CContactDatabase
&aDb, const RContactViewSortOrder &aSortOrder, TContactViewPreferences aContactTypes);
Description
Allocates and constructs a named remote contact view object.
This function causes a new named local view object to be created in the contacts server, unless one already exists with the
specified name. In that case, this client is given shared access to it.
The sort order and view preferences parameters are only used if a new view object is created in the server. They cannot be
used to change the sort order or view preferences of an existing view in the server. If you want to re-sort a shared view,
use ChangeSortOrderL()
.
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 TDesC &aName |
The name of the view object in the server. If a view with this name already exists, it is shared. If not, a new view with
this name is created.
|
const CContactDatabase &aDb |
The underlying database containing the contact items.
|
const RContactViewSortOrder &aSortOrder |
Specifies the fields to use to sort the items in the new server side view, if one is created.
|
TContactViewPreferences aContactTypes |
Specifies which types of contact items should be included in the new server side view and the behaviour for items that do
not have content in any of the fields specified in the sort order. This is only used if a new server side view is created.
|
|
Return value
static IMPORT_C CContactNamedRemoteView *NewL(MContactViewObserver &aObserver, const TDesC &aName, const CContactDatabase
&aDb, const RContactViewSortOrder &aSortOrder, TContactViewPreferences aContactTypes, const TDesC8 &aSortPluginName);
Description
Allocates and constructs a named remote contact view object.
This function causes a new named local view object to be created in the contacts server, unless one already exists with the
specified name. In that case, this client is given shared access to it.
The sort order and view preferences parameters are only used if a new view object is created in the server. They cannot be
used to change the sort order or view preferences of an existing view in the server. If you want to re-sort a shared view,
use ChangeSortOrderL()
.
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 TDesC &aName |
The name of the view object in the server. If a view with this name already exists, it is shared. If not, a new view with
this name is created.
|
const CContactDatabase &aDb |
The underlying database containing the contact items.
|
const RContactViewSortOrder &aSortOrder |
Specifies the fields to use to sort the items in the new server side view, if one is created.
|
TContactViewPreferences aContactTypes |
Specifies which types of contact items should be included in the new server side view and the behaviour for items that do
not have content in any of the fields specified in the sort order. This is only used if a new server side view is created.
|
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
IMPORT_C void ChangeSortOrderL(const RContactViewSortOrder &aSortOrder);
Description
Re-sorts the server side view using the specified sort order.
The sort is done using a low priority idle time active object. When sorting is complete, all view observers are notified.
Parameters
CContactViewBase_Reserved_1()
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.
|
|