Class CContactConcatenatedView

class CContactConcatenatedView : public CContactViewBase, public MContactViewObserver;

Description

Concatenates multiple contact views into a single contiguous view.

The component views are ordered according to their order in the array passed into the NewL().

Derivation

• MContactViewObserver - The interface for a contact view observer

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

• CContactViewBase - The abstract base class for all contact view classes

• CContactConcatenatedView - Concatenates multiple contact views into a single contiguous view

Members

Defined in CContactConcatenatedView:

• AllFieldsLC()Returns a descriptor containing the contents of all fields in an item in the view
• AtL()Gets the contact item ID at the specified index into the concatenated view
• CContactViewBase_Reserved_1()This is a reserved virtual exported function that is used for BC proofing against addition of new exported virtual functions
• ContactAtL()Gets the contact item at the specified index into the view
• ContactViewPreferences()Gets the view preferences for the first component view
• CountL()Gets the number of contact items in the concatenated view
• FindL()Finds the index into the concatenated view of the specified contact item
• HandleContactViewEvent()Handles an event in an observed contact view
• NewL()Allocates and constructs a new CContactConcatenatedView object,
• SortOrderL()Gets the sort order for the first component view

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
• ConstructL()Protected second phase constructor
• 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

static IMPORT_C CContactConcatenatedView *NewL(MContactViewObserver &aObserver, const CContactDatabase &aDb, RPointerArray< CContactViewBase > &aComponentViews);

Description

Allocates and constructs a new CContactConcatenatedView object,

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 database that contains the contact items. RPointerArray< CContactViewBase > &aComponentViews An array of pointers to the component views to append to this view. The concatenated view creates its own copy of this array and sets itself to be the observer of each of the component views, unless an error occurs, in which case the function leaves.

Return value

CContactConcatenatedView * The newly constructed concatenated view object.

Capability:

ReadUserData

virtual 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.

virtual TContactItemId AtL(TInt aIndex) const;

Description

Gets the contact item ID at the specified index into the concatenated view.

Parameters

TInt aIndex Index into the concatenated view.

Return value

TContactItemId The contact item ID.

Leave codes

KErrNotReady The view is not ready for use. KErrNotFound The index is out of bounds. It must be less than the total number of items in all component views.

virtual TInt CountL() const;

Description

Gets the number of contact items in the concatenated view.

This is the total number of items in all component views.

Return value

TInt The number of items in the concatenated view.

Leave codes

KErrNotReady The view is not ready for use.

virtual TInt FindL(TContactItemId aId) const;

Description

Finds the index into the concatenated view of the specified contact item.

Parameters

TContactItemId aId The contact item ID to search for.

Return value

TInt The index of the first matching item in the concatenated view or KErrNotFound if no matching item can be found.

Leave codes

KErrNotReady The view is not ready for use.

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

Description

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

The fields are separated by aSeparator.

Parameters

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

Return value

HBufC * Pointer to the contact item descriptor.

Leave codes

KErrNotReady The view is not ready for use.

Panic codes

CNTMODEL 29 In debug builds, this indicates that the index is invalid. It must be less that the total number of items in the concatenated view. In release builds, a NULL pointer is returned instead.

virtual const CViewContact &ContactAtL(TInt aIndex) const;

Description

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

Parameters

TInt aIndex Index into the view.

Return value

const CViewContact & The contact item.

Leave codes

KErrNotReady The view is not ready for use. KErrNotFound The index is invalid. It must be less that the total number of items in the concatenated view.

virtual TContactViewPreferences ContactViewPreferences();

Description

Gets the view preferences for the first component view.

Return value

TContactViewPreferences The view preferences.

virtual const RContactViewSortOrder &SortOrderL() const;

Description

Gets the sort order for the first component view.

Return value

const RContactViewSortOrder & The sort order.

private: virtual void HandleContactViewEvent(const CContactViewBase &aView, const TContactViewEvent &aEvent);

Description

Handles an event in an observed contact view.

Parameters

const CContactViewBase &aView The contact view causing the notification. const TContactViewEvent &aEvent The event.