CContactLocalView in Application Engines CNTMODEL

class CContactLocalView : public CContactViewBase, public MContactDbObserver;

Description

An instantiable base class for contact views.

The data associated with a local view is allocated within the client's memory space; CContactRemoteView should be used in preference if the view is likely to be shared between multiple clients. It is kept up to date by receiving change events from the underlying CContactDatabase object which it observes. The view preferences and sort order are specified on construction.

Derivation

MContactDbObserver - The interface for an observer that handles changes to a contact database

CBase - Base class for all classes to be instantiated on the heap

CContactViewBase - The abstract base class for all contact view classes

CContactLocalView - An instantiable base class for contact views

Members

Defined in CContactLocalView:

AllFieldsLC()Gets a descriptor containing the contents of all fields specified in the view's sort order for an item in the view
AtL()Returns the ID of the contact item at a specified index into the view
CContactLocalView()Protected C++ constructor
CContactLocalView_Reserved_1()
CContactLocalView_Reserved_2()
CContactViewBase_Reserved_1()This is a reserved virtual exported function that is used for BC proofing against addition of new exported virtual functions
ConstructL()Protected second phase constructor
ContactAtL()Returns the contact item at a specified index into the view
ContactViewPreferences()Gets the view preferences, as set during construction
CountL()Gets the total number of contact items in the view
FindL()Searches for a contact item in the view with the specified ID
HandleDatabaseEventL()Tests the contact database observer event type and handles it
InsertL()Inserts a contact item into the view, maintaining the view's sort order
NewL()Allocates and constructs the local view object
NewL()Allocates and constructs the local view object
RemoveL()Removes a contact item from the view
SortL()Sorts the view using the specified sort order, using a low priority idle time active object
SortOrder()Gets the sort order, as set during construction
SortOrderL()Gets the sort order, as set during construction
iSortOrderThe sort order
~CContactLocalView()Destructor

Inherited from CBase:

Delete()Deletes the specified object
Extension_()Extension function
operator new()Initialises the object to binary zeroes

Inherited from CContactViewBase:

Close()Removes an observer from the view's observer array
CompareFieldsL()Collates two contact items' field contents
ContactsMatchingCriteriaL()Searches all contact items in the view for fields that contain all of the search strings specified
ContactsMatchingPrefixL()Searches all contact items in the view for fields that contain all of the search strings specified
ECContactViewBaseVirtualFunction1Identifies the function CContactViewBase::GetContactIdsL()
ECContactViewBaseVirtualFunction2Identifies the function CContactViewBase::GetContactsMatchingFilterL()
ECContactViewBaseVirtualFunction3Identifies the function CContactViewBase::InsertContactInView()
EFullSearchThe search uses full wildcard matching so that the search string can occur anywhere in the item's fields
EInitializingThe view is initialising
ENotReadyThe view is not ready to be used, for instance immediately after the sort order has changed, or after an error has occurred
EPrefixSearchThe search uses partial wildcard matching so that the search string can only occur at the beginning of the item's fields
EReadyThe view is ready to be used
Error()Gets the recorded error value
FieldsWithSeparatorLC()Allocates and returns a descriptor filled with the contents of all the fields in a contact item
GetContactIdsL()Gets an array containing the IDs of the contact items at the specified view indexes
GetViewFindConfigPlugin()Gets the UID of the view's find configuration plug-in, as set by SetViewFindConfigPlugin()
IdsEqual()Tests whether the IDs of two contact items are the same
IdsMatch()Tests whether the IDs of two contact items are the same
IndexesEqual()Tests whether the view indexes of two contact items are the same
MatchesCriteriaL()Searches a single contact item for fields that contain one or more search strings
NotifyObserverAsync()Called to notify a single view observer asynchronously of an event
NotifyObservers()Called by derived view classes to notify their observers synchronously of an event, by calling their HandleContactViewEvent() function
Open()Appends an observer to the view's observer array
OpenL()Appends an observer to the view's observer array
SetViewFindConfigPlugin()Sets the UID of the view's find configuration plug-in to use in calls to ContactsMatchingCriteriaL(), ContactsMatchingPrefixL() and MatchesCriteriaL()
TFunctionIdentifies the functions that have been added to CContactViewBase, or that may be added in the future
TSearchTypeSearch type
TStateDefines the contact view states
TVirtualFunction1ParamsHolds the two parameters passed to the helper method GetContactIdsL() from the reserved function CContactViewBase_Reserved_1()
TVirtualFunction2ParamsHolds the two parameters passed to the method GetContactsMatchingFilterL() from the reserved function CContactViewBase_Reserved_1()
iDb
iExtension
iState

Description

Allocates and constructs the local view object.

The view is sorted according to the sort order and view preferences specified, using a low priority idle time active object. The specified view observer is notified when the view is sorted and ready for use.

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. Any attempt to use the view before this notification will Leave with KErrNotReady
`const CContactDatabase &aDb`	The underlying database that contains the contact items. The view observes the database, so that it handles change events sent from the database.
`const RContactViewSortOrder &aSortOrder`	Specifies the fields to use to sort the items in the 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

CContactLocalView *

The newly constructed local view object.

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

Description

Allocates and constructs the local view object.

The view is sorted according to the sort order and view preferences specified, using a low priority idle time active object. The specified view observer is notified when the view is sorted and ready for use.

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. Any attempt to use the view before this notification will Leave with KErrNotReady
`const CContactDatabase &aDb`	The underlying database that contains the contact items. The view observes the database, so that it handles change events sent from the database.
`const RContactViewSortOrder &aSortOrder`	Specifies the fields to use to sort the items in the 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

CContactLocalView *

The newly constructed local view object.

protected: IMPORT_C ~CContactLocalView();

Description

Destructor.

Deletes all resources owned by the object, and removes itself as the contact database observer.

protected: IMPORT_C CContactLocalView(const CContactDatabase &aDb, TContactViewPreferences aContactTypes);

Description

Protected C++ constructor.

Called by NewL().

Parameters

`const CContactDatabase &aDb`	The underlying database that contains the contact items.
`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.

protected: IMPORT_C void ConstructL(MContactViewObserver &aObserver, const RContactViewSortOrder &aSortOrder);

Description

Protected second phase constructor.

The view is sorted according to the sort order and view preferences specified, using a low priority idle time active object. The specified view observer is notified when the view is sorted and ready for use.

Called by NewL().

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. Any attempt to use the view before this notification will Leave with KErrNotReady.
`const RContactViewSortOrder &aSortOrder`	Specifies the fields to use to sort the items in the view.

IMPORT_C const RContactViewSortOrder &SortOrder() const;

Description

Gets the sort order, as set during construction.

Return value

const RContactViewSortOrder &

The sort order.

virtual TContactItemId AtL(TInt aIndex) const;

Description

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

Parameters


                                 						TInt aIndex

An index into the view.

Return value


                                 						TContactItemId

The ID of the contact item at the specified index.

Leave codes

`KErrNotFound`	The index is out of bounds.
`KErrNotReady`	The view is not ready for use.

virtual TInt CountL() const;

Description

Gets the total number of contact items in the view.

Return value


                                 						TInt

The number of contact items in the view. This includes both sorted and unsorted items.

Leave codes

KErrNotReady

The view is not ready for use.

virtual TInt FindL(TContactItemId aId) const;

Description

Searches for a contact item in the view with the specified ID.

Parameters


                                 						TContactItemId aId

The ID of the contact item to search for.

Return value


                                 						TInt

If found, the index into the view of the matching item. Otherwise, KErrNotFound.

Leave codes

KErrNotReady

The view is not ready for use.

virtual HBufC *AllFieldsLC(TInt aIndex, const TDesC &aSeparator) const;

Description

Gets a descriptor containing the contents of all fields specified in the view's sort order 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.

Parameters

`TInt aIndex`	The index of the contact item into the view.
`const TDesC &aSeparator`	The string to use to separate the fields.

Return value


                                 						HBufC *

Pointer to the contact item descriptor.

virtual const CViewContact &ContactAtL(TInt aIndex) const;

Description

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

Parameters


                                 						TInt aIndex

An index into the view.

Return value

const CViewContact &

The contact item at the specified index.

Leave codes

`KErrNotFound`	The index is out of bounds.
`KErrNotReady`	The view is not ready for use.

virtual TContactViewPreferences ContactViewPreferences();

Description

Gets the view preferences, as set during construction.

Return value


                                 						TContactViewPreferences

The view preferences.

virtual const RContactViewSortOrder &SortOrderL() const;

Description

Gets the sort order, as set during construction.

This function cannot leave.

Return value

const RContactViewSortOrder &

The sort order.

Capability:

ReadUserData

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

Description

This is a reserved virtual exported function that is used for BC proofing against addition of new exported virtual functions. This function now aids addition of new exported virtual methods without having to break BC,by simply having those virtual methods as non-virtual and helper methods, called from this one and only reserved virtual exported method.A public enumeration type that is defined in the base class CContactViewBase identifies which of the helper 'virtual' methods are being called. All derived classes of CContactViewBase that are public should mandatorily implement this method.

Returns any return values of the helper methods called from this function.

Parameters

`TFunction aFunction`	an enum value that identifies which helper method is called.
`TAny *aParams`	parameters to the helper method being called.

Return value

TAny *

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

protected: virtual IMPORT_C void SortL(const RContactViewSortOrder &aSortOrder);

Description

Sorts the view using the specified sort order, using a low priority idle time active object.

This function is called during view construction and on receipt of certain change events from the underlying database.

Parameters

const RContactViewSortOrder &aSortOrder

Specifies the fields to use to sort the items in the view.

protected: virtual IMPORT_C TInt InsertL(TContactItemId aId);

Description

Inserts a contact item into the view, maintaining the view's sort order.

For the item to be inserted, it must exist in the underlying database, and it must be of the correct type according to the view preferences.

This function is called when a contact item or group is added to or changed in the underlying database.

Parameters


                                 						TContactItemId aId

The ID of a contact item that exists in the underlying database.

Return value

TInt

The index at which the item was inserted into the view, or KErrNotFound if the contact item was not found in the underlying database, or it already exists in the view.

protected: virtual IMPORT_C TInt RemoveL(TContactItemId aId);

Description

Removes a contact item from the view.

This function is called when a contact item or group is deleted from or changed in the underlying database.

Parameters


                                 						TContactItemId aId

The ID of the contact item to remove from the view.

Return value

TInt

The index of the removed item into the view's list of sorted or unsorted contact items, or KErrNotFound if the item was not found in the view.

private: virtual void HandleDatabaseEventL(TContactDbObserverEvent aEvent);

Description

Tests the contact database observer event type and handles it. The ID of a contact affected by the change event, if relevant, can be retrieved via TContactDbObserverEvent::iContactId.

Parameters


                                 						TContactDbObserverEvent aEvent

Provides information about the change event.

private: virtual IMPORT_C void CContactLocalView_Reserved_1();

Description

private: virtual IMPORT_C void CContactLocalView_Reserved_2();

Description

protected: RContactViewSortOrder iSortOrder;

Description

The sort order. This is set during construction or when SortL() is called.

Class CContactLocalView

Description

Derivation

Members

Related Topics

Construction and destruction

NewL()

Description

Parameters

Return value

NewL()

Description

Parameters

Return value