CContactNamedRemoteView Class Reference
|
class CContactNamedRemoteView : public CContactRemoteView
|
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.
|
Public Member Functions
|
|
TAny
*
|
CContactViewBase_Reserved_1
(
TFunction
,
TAny
*)
|
|
IMPORT_C void
|
ChangeSortOrderL
(const
RContactViewSortOrder
&)
|
|
IMPORT_C
CContactNamedRemoteView
*
|
NewL
(
MContactViewObserver
&, const
TDesC
&, const
CContactDatabase
&, const
RContactViewSortOrder
&,
TContactViewPreferences
)
|
|
IMPORT_C
CContactNamedRemoteView
*
|
NewL
(
MContactViewObserver
&, const
TDesC
&, const
CContactDatabase
&, const
RContactViewSortOrder
&,
TContactViewPreferences
, const
TDesC8
&)
|
|
Inherited Functions
|
|
|
CBase::CBase()
|
|
|
CBase::Delete(CBase *)
|
|
|
CBase::Extension_(TUint,TAny *&,TAny *)
|
|
|
CBase::operator new(TUint)
|
|
|
CBase::operator new(TUint,TAny *)
|
|
|
CBase::operator new(TUint,TLeave)
|
|
|
CBase::operator new(TUint,TLeave,TUint)
|
|
|
CBase::operator new(TUint,TUint)
|
|
|
CBase::~CBase()
|
|
|
CContactRemoteView::CContactRemoteView(const CContactDatabase &)
|
|
|
CContactRemoteView::GetSortOrderL(RContactViewSortOrder &)
|
|
|
CContactRemoteView::NewL(MContactViewObserver &,const CContactDatabase &,const RContactViewSortOrder &,TContactViewPreferences)
|
|
|
CContactRemoteView::NewL(MContactViewObserver &,const CContactDatabase &,const RContactViewSortOrder &,TContactViewPreferences,const TDesC8 &)
|
|
|
CContactRemoteView::~CContactRemoteView()
|
|
|
CContactRemoteViewBase::AllFieldsLC(TInt,const TDesC &)const
|
|
|
CContactRemoteViewBase::AtL(TInt)const
|
|
|
CContactRemoteViewBase::CContactRemoteViewBase(const CContactDatabase &)
|
|
|
CContactRemoteViewBase::ConstructL(MContactViewObserver &)
|
|
|
CContactRemoteViewBase::ContactAtL(TInt)const
|
|
|
CContactRemoteViewBase::ContactViewPreferences()
|
|
|
CContactRemoteViewBase::ContactsMatchingCriteriaL(const MDesCArray &,RPointerArray< CViewContact > &)
|
|
|
CContactRemoteViewBase::ContactsMatchingPrefixL(const MDesCArray &,RPointerArray< CViewContact > &)
|
|
|
CContactRemoteViewBase::CountL()const
|
|
|
CContactRemoteViewBase::FindL(TContactItemId)const
|
|
|
CContactRemoteViewBase::GetContactIdsL(const CArrayFix< TInt > &,CContactIdArray &)
|
|
|
CContactRemoteViewBase::GetContactsMatchingFilterL(TInt,RArray< TContactIdWithMapping > &)
|
|
|
CContactRemoteViewBase::SortOrderL()const
|
|
|
CContactRemoteViewBase::~CContactRemoteViewBase()
|
|
|
CContactViewBase::CContactViewBase(const CContactDatabase &)
|
|
|
CContactViewBase::Close(const MContactViewObserver &)
|
|
|
CContactViewBase::CompareContactIds(const CViewContact &,const CViewContact &)
|
|
|
CContactViewBase::CompareContactsAndIdsL(const CViewContact &,const CViewContact &)const
|
|
|
CContactViewBase::CompareFieldsL(const CViewContact &,const CViewContact &)
|
|
|
CContactViewBase::ConstructL()
|
|
|
CContactViewBase::ContactIsSortable(const CViewContact &)
|
|
|
CContactViewBase::Error()const
|
|
|
CContactViewBase::FieldsWithSeparatorLC(const RPointerArray< CViewContact > &,TInt,const TDesC &)const
|
|
|
CContactViewBase::FindDefaultViewSortPluginImplL()const
|
|
|
CContactViewBase::FindSortPluginImplL(const TDesC8 &,TBool)const
|
|
|
CContactViewBase::GetViewFindConfigPlugin()
|
|
|
CContactViewBase::GetViewSortPluginImplUid()const
|
|
|
CContactViewBase::IdsEqual(const TContactIdWithMapping &,const TContactIdWithMapping &)
|
|
|
CContactViewBase::IdsMatch(const CViewContact &,const CViewContact &)
|
|
|
CContactViewBase::IndexesEqual(const TContactIdWithMapping &,const TContactIdWithMapping &)
|
|
|
CContactViewBase::InsertContactInView(RPointerArray< CViewContact > &,const CViewContact *,TBool,TInt *)const
|
|
|
CContactViewBase::IsContactSortable(const CViewContact &,TContactViewPreferences &)const
|
|
|
CContactViewBase::LoadViewSortPluginL(TUid,TContactViewPreferences &)
|
|
|
CContactViewBase::MatchesCriteriaL(const CViewContact &,const MDesCArray &)
|
|
|
CContactViewBase::MatchesCriteriaL(const CViewContact &,const MDesCArray &,TSearchType)
|
|
|
CContactViewBase::MatchesCriteriaL(const CViewContact &,const MDesCArray &,TSearchType,CContactViewBase::CContactViewBaseExtension *)
|
|
|
CContactViewBase::NotifyObserverAsync(MContactViewObserver &,const TContactViewEvent &)
|
|
|
CContactViewBase::NotifyObservers(const TContactViewEvent &)
|
|
|
CContactViewBase::Open(MContactViewObserver &)
|
|
|
CContactViewBase::OpenL(MContactViewObserver &)
|
|
|
CContactViewBase::SetViewFindConfigPlugin(TUid)
|
|
|
CContactViewBase::SortPluginImpl()const
|
|
|
CContactViewBase::~CContactViewBase()
|
Constructor & Destructor Documentation
CContactNamedRemoteView(const CContactDatabase &)
~CContactNamedRemoteView()
|
~CContactNamedRemoteView
|
(
|
)
|
[private]
|
Member Functions Documentation
CContactViewBase_Reserved_1(TFunction, TAny *)
This is a reserved virtual exported function that is used for BC proofing against present and future additions of new exported virtual functions.
-
capability
-
ReadUserData
Parameters
|
TFunction
aFunction
|
An enum value that identifies which helper function is called.
|
|
TAny
* aParams
|
Parameters to the helper function being called.
|
ChangeSortOrderL(const RContactViewSortOrder &)
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.
ConstructL(MContactViewObserver &, const TDesC &, const RContactViewSortOrder &, TContactViewPreferences)
ConstructL(MContactViewObserver &, const TDesC &, const RContactViewSortOrder &, TContactViewPreferences, const TDesC8 &)
NewL(MContactViewObserver &, const TDesC &, const CContactDatabase &, const RContactViewSortOrder &, TContactViewPreferences)
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.
|
NewL(MContactViewObserver &, const TDesC &, const CContactDatabase &, const RContactViewSortOrder &, TContactViewPreferences, const TDesC8 &)
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.
|
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.