Symbian^3 Application Developer Library >

CContactRemoteView Class Reference

class CContactRemoteView : public CContactRemoteViewBase

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.

Inherits from

Public Member Functions
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 ()
Private Member Functions
void ConstructL ( MContactViewObserver &, const RContactViewSortOrder &, TContactViewPreferences )
void ConstructL ( MContactViewObserver &, 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()
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()
Inherited Enumerations
CContactViewBase:TFunction
CContactViewBase:TSearchType
CContactViewBase:TState
Inherited Attributes
CContactRemoteViewBase::iView
CContactViewBase::iDb
CContactViewBase::iExtension
CContactViewBase::iState

Constructor & Destructor Documentation

CContactRemoteView(const CContactDatabase &)

CContactRemoteView ( const CContactDatabase & aDb ) [protected]

Protected C++ constructor.

Parameters

const CContactDatabase & aDb The underlying database containing the contact items.

~CContactRemoteView()

~CContactRemoteView ( ) [protected]

Empty destructor.

Member Functions Documentation

CContactViewBase_Reserved_1(TFunction, TAny *)

TAny * CContactViewBase_Reserved_1 ( TFunction aFunction,
TAny * aParams
) [virtual]
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.

ConstructL(MContactViewObserver &, const RContactViewSortOrder &, TContactViewPreferences)

void ConstructL ( MContactViewObserver & aObserver,
const RContactViewSortOrder & aSortOrder,
TContactViewPreferences aContactTypes
) [private]
capability
ReadUserData

Parameters

MContactViewObserver & aObserver
const RContactViewSortOrder & aSortOrder
TContactViewPreferences aContactTypes

ConstructL(MContactViewObserver &, const RContactViewSortOrder &, TContactViewPreferences, const TDesC8 &)

void ConstructL ( MContactViewObserver & aObserver,
const RContactViewSortOrder & aSortOrder,
TContactViewPreferences aContactTypesconst,
const TDesC8 & aSortPluginName
) [private]
capability
ReadUserData

Parameters

MContactViewObserver & aObserver
const RContactViewSortOrder & aSortOrder
TContactViewPreferences aContactTypesconst
const TDesC8 & aSortPluginName

GetSortOrderL(RContactViewSortOrder &)

IMPORT_C void GetSortOrderL ( RContactViewSortOrder & aSortOrder )

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

capability
ReadUserData

Parameters

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

NewL(MContactViewObserver &, const CContactDatabase &, const RContactViewSortOrder &, TContactViewPreferences)

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.

capability
ReadUserData

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.

NewL(MContactViewObserver &, const CContactDatabase &, const RContactViewSortOrder &, TContactViewPreferences, const TDesC8 &)

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.

capability
ReadUserData

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.

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.