CContactRemoteViewBase Class Reference

class CContactRemoteViewBase : public CContactViewBase

Base class for all remote contact view classes.

It implements all the pure virtual functions in CContactViewBase and additionally it handles remote view notifications. The data associated with remote views is allocated within the memory space of the contacts server. This means that multiple clients can share the same server side view object, thereby reducing the overhead associated with initial sorting of the view data and keeping it in sync with the underlying data. Remote views should therefore be used when the same view is likely to be needed by more than one client.

Inherits from

Public Member Functions
HBufC *AllFieldsLC(TInt, const TDesC &)
TContactItemId AtL(TInt)
TAny *CContactViewBase_Reserved_1(TFunction, TAny *)
const CViewContact &ContactAtL(TInt)
TContactViewPreferences ContactViewPreferences()
voidContactsMatchingCriteriaL(const MDesCArray &, RPointerArray< CViewContact > &)
voidContactsMatchingPrefixL(const MDesCArray &, RPointerArray< CViewContact > &)
TInt CountL()
TInt FindL(TContactItemId)
voidGetContactIdsL(const CArrayFix< TInt > &, CContactIdArray &)
voidGetContactsMatchingFilterL(TInt, RArray< TContactIdWithMapping > &)
const RContactViewSortOrder &SortOrderL()
Protected Member Functions
CContactRemoteViewBase(const CContactDatabase &)
~CContactRemoteViewBase()
voidConstructL(MContactViewObserver &)
Private Member Functions
voidHandleContactViewEvent(const TContactViewEvent &)
TInt NotifierCallBack(TAny *)
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()
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
Protected Attributes
RContactRemoteView iView
Private Attributes
TInt iCount
CContactRemoteViewNotifier *iNotifier
Inherited Attributes
CContactViewBase::iDb
CContactViewBase::iExtension
CContactViewBase::iState

Constructor & Destructor Documentation

CContactRemoteViewBase(const CContactDatabase &)

CContactRemoteViewBase(const CContactDatabase &aDb)[protected]

Parameters

const CContactDatabase & aDb

~CContactRemoteViewBase()

~CContactRemoteViewBase()[protected]

Member Functions Documentation

AllFieldsLC(TInt, const TDesC &)

HBufC *AllFieldsLC(TIntaIndex,
const TDesC &aSeparator
)const [virtual]

Returns a descriptor containing the contents of all fields for an item in the view.

The field separator is used to separate the contents of each field. It is not appended to the last field.

capability

ReadUserData

Pointer to the contact item descriptor.

Parameters

TInt aIndexThe index of the contact item into the view.
const TDesC & aSeparatorThe string to use to separate the fields.

AtL(TInt)

TContactItemId AtL(TIntaIndex)const [virtual]

Returns the contact item ID at the specified index into the view.

capability

ReadUserData

The contact item ID.

Parameters

TInt aIndexIndex of the contact item ID into the view.

CContactViewBase_Reserved_1(TFunction, TAny *)

TAny *CContactViewBase_Reserved_1(TFunctionaFunction,
TAny *aParams
)[virtual]

Parameters

TFunction aFunction
TAny * aParams

ConstructL(MContactViewObserver &)

voidConstructL(MContactViewObserver &aObserver)[protected]

Parameters

MContactViewObserver & aObserver

ContactAtL(TInt)

const CViewContact &ContactAtL(TIntaIndex)const [virtual]

Returns the contact item at the specified index into the view.

capability

ReadUserData

The contact item.

Parameters

TInt aIndexIndex of the contact item into the view.

ContactViewPreferences()

TContactViewPreferences ContactViewPreferences()[virtual]

Gets the view preferences.

capability

ReadUserData

The view preferences.

ContactsMatchingCriteriaL(const MDesCArray &, RPointerArray< CViewContact > &)

voidContactsMatchingCriteriaL(const MDesCArray &aFindWords,
RPointerArray< CViewContact > &aMatchedContacts
)[virtual]

Parameters

const MDesCArray & aFindWords
RPointerArray< CViewContact > & aMatchedContacts

ContactsMatchingPrefixL(const MDesCArray &, RPointerArray< CViewContact > &)

voidContactsMatchingPrefixL(const MDesCArray &aFindWords,
RPointerArray< CViewContact > &aMatchedContacts
)[virtual]

Parameters

const MDesCArray & aFindWords
RPointerArray< CViewContact > & aMatchedContacts

CountL()

TInt CountL()const [virtual]

Returns the number of contact items in the view.

capability

ReadUserData

The number of contact items in the view.

FindL(TContactItemId)

TInt FindL(TContactItemIdaId)const [virtual]

Returns the index into the view of the specified contact item.

capability

ReadUserData

The index into the view of the contact item ID, or KErrNotFound if no matching ID can be found.

Parameters

TContactItemId aIdThe contact item ID to search for.

GetContactIdsL(const CArrayFix< TInt > &, CContactIdArray &)

voidGetContactIdsL(const CArrayFix< TInt > &aIndexes,
CContactIdArray &aContactIds
)[virtual]

Parameters

const CArrayFix< TInt > & aIndexes
CContactIdArray & aContactIds

GetContactsMatchingFilterL(TInt, RArray< TContactIdWithMapping > &)

voidGetContactsMatchingFilterL(TIntaFilter,
RArray< TContactIdWithMapping > &aMatchingContacts
)

Parameters

TInt aFilter
RArray< TContactIdWithMapping > & aMatchingContacts

HandleContactViewEvent(const TContactViewEvent &)

voidHandleContactViewEvent(const TContactViewEvent &aEvent)[private]

Parameters

const TContactViewEvent & aEvent

NotifierCallBack(TAny *)

TInt NotifierCallBack(TAny *aSelf)[private, static]

Parameters

TAny * aSelf

SortOrderL()

const RContactViewSortOrder &SortOrderL()const [virtual]

Gets the view's sort order.

capability

ReadUserData

The sort order.

Member Data Documentation

TInt iCount

TInt iCount[private]

Cached copy of the count of the local view in the contacts server. If this is KCachedItemCountInvalid then next time CountL is called the current count is retrieved from the contacts server.

CContactRemoteViewNotifier * iNotifier

CContactRemoteViewNotifier *iNotifier[private]

RContactRemoteView iView

RContactRemoteView iView[protected]

A handle to the server side view.