Class CContactSubView

class CContactSubView : public CContactViewBase, public MContactViewObserver;

Description

Provides a view of a range of contact items from a potentially larger underlying view (another CContactViewBase-derived object).

All contact items between a lower and upper boundary in the underlying view are included in the sub view. For example, the sub view might contain all items whose name begins with a character between 'd' and 'f'.

The sub view observes its underlying view so that as the underlying view changes, the sub view is kept up to date.

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

• CContactSubView - Provides a view of a range of contact items from a potentially larger underlying view (another CContactViewBase-derived object)

Members

Defined in CContactSubView:

• AllFieldsLC()Returns a descriptor containing the contents of all fields for an item in the sub view
• AtL()Gets the contact item ID at the specified index into the sub view
• CContactViewBase_Reserved_1()This is a reserved virtual exported function that is used for BC proofing against present and future additions of new exported virtual functions
• ContactAtL()Gets the contact item at the specified index into the sub view
• ContactViewPreferences()Gets the underlying view's view preferences
• CountL()Gets the number of contact item IDs in the sub view
• FindL()Finds the index into the sub view of the specified contact item
• HandleContactViewEvent()Handles an event in an observed contact view
• NewL()Allocates and constructs a new CContactSubView version 1 object, specifying the sub view's criteria
• NewL()Allocates and constructs a new CContactSubView version 1 object, specifying the sub view's upper and lower boundary criteria
• NewL()Allocates and constructs a new CContactSubView version 2 object, specifying the sub view's criteria
• NewL()Allocates and constructs a new CContactSubView version 2 object, specifying the sub view's upper and lower boundary criteria
• SortOrderL()Gets the underlying view's sort order

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 CContactSubView *NewL(MContactViewObserver &aObserver, const CContactDatabase &aDb, CContactViewBase &aView, const TDesC &aBoundary);

Description

Allocates and constructs a new CContactSubView version 1 object, specifying the sub view's criteria.

When adding/deleting contacts in the view, MContactViewObserver observer will receive TContactViewEvent events with iInt parameter set to KErrNone.

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 containing the contact items. CContactViewBase &aView The underlying view. const TDesC &aBoundary A string containing the sub view criteria. Possible values are: <, >, <=, or >=, followed by a character.

Return value

CContactSubView * The newly constructed sub view object.

static IMPORT_C CContactSubView *NewL(MContactViewObserver &aObserver, const CContactDatabase &aDb, CContactViewBase &aView, const TDesC &aLowBoundary, const TDesC &aHighBoundary);

Description

Allocates and constructs a new CContactSubView version 1 object, specifying the sub view's upper and lower boundary criteria.

When adding/deleting contacts in the view, MContactViewObserver observer will receive TContactViewEvent events with iInt parameter set to KErrNone.

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 containing the contact items. CContactViewBase &aView The underlying view. const TDesC &aLowBoundary A string containing the sub view's lower boundary criteria. Possible values are: > or >=, followed by a character. const TDesC &aHighBoundary A string containing the sub view's upper boundary criteria. Possible values are: < or <=, followed by a character.

Return value

CContactSubView * The newly constructed sub view object.

static IMPORT_C CContactSubView *NewL(CContactViewBase &aView, const CContactDatabase &aDb, MContactViewObserver &aObserver, const TDesC &aBoundary);

Description

Allocates and constructs a new CContactSubView version 2 object, specifying the sub view's criteria.

When adding/deleting contacts in the view, MContactViewObserver observer will receive TContactViewEvent events with iInt parameter set to index into the observed view of the added/deleted item

Parameters

CContactViewBase &aView The underlying view. const CContactDatabase &aDb The database containing the contact items. 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 &aBoundary A string containing the sub view criteria. Possible values are: <, >, <=, or >=, followed by a character.

Return value

CContactSubView * The newly constructed sub view object.

static IMPORT_C CContactSubView *NewL(CContactViewBase &aView, const CContactDatabase &aDb, MContactViewObserver &aObserver, const TDesC &aLowBoundary, const TDesC &aHighBoundary);

Description

Allocates and constructs a new CContactSubView version 2 object, specifying the sub view's upper and lower boundary criteria.

When adding/deleting contacts in the view, MContactViewObserver observer will receive TContactViewEvent events with iInt parameter set to index into the observed view of the added/deleted item

Parameters

CContactViewBase &aView The underlying view. const CContactDatabase &aDb The database containing the contact items. 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 &aLowBoundary A string containing the sub view's lower boundary criteria. Possible values are: > or >=, followed by a character. const TDesC &aHighBoundary A string containing the sub view's upper boundary criteria. Possible values are: < or <=, followed by a character.

Return value

CContactSubView * The newly constructed sub view object.

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

Description

This is a reserved virtual exported function that is used for BC proofing against present and future additions of new exported virtual functions.

Parameters

TFunction aFunction TAny *aParams

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 sub view.

In release builds, zero is returned if the sub view's upper and lower boundaries have not been set, (in debug builds, a panic occurs).

Parameters

TInt aIndex Index into the sub view of a contact item ID.

Return value

TContactItemId The contact item ID.

Leave codes

KErrNotFound aIndex is outside the bounds of the sub view's array.

virtual TInt CountL() const;

Description

Gets the number of contact item IDs in the sub view.

Zero is returned if the sub view's upper and lower boundaries have not been set.

Return value

TInt The number of contact item IDs in the sub view.

virtual TInt FindL(TContactItemId aId) const;

Description

Finds the index into the sub 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 sub view or KErrNotFound if the sub view's upper and lower boundaries have not been set or if the item is not in the sub view.

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

Description

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

NULL is returned if the sub view's upper and lower boundaries have not been set (in debug builds, a panic occurs).

Parameters

TInt aIndex The index into the sub 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.

virtual const CViewContact &ContactAtL(TInt aIndex) const;

Description

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

A NULL contact item is returned if the sub view's upper and lower boundaries have not been set (in debug builds, a panic occurs).

Parameters

TInt aIndex Index into the sub view of the required item.

Return value

const CViewContact & The contact item.

Leave codes

KErrNotFound aIndex is outside the bounds of the sub view's array.

virtual TContactViewPreferences ContactViewPreferences();

Description

Gets the underlying view's view preferences.

Return value

TContactViewPreferences The view preferences.

virtual const RContactViewSortOrder &SortOrderL() const;

Description

Gets the underlying view's sort order.

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.