#include <app/cntview.h>
Link against: cntview.lib
| class CContactConcatenatedView : public CContactViewBase, public MContactViewObserver, public CContactViewBase, public MContactViewObserver |
| Public Member Functions | |
|---|---|
| virtual HBufC * | AllFieldsLC(TInt, const TDesC &) |
| virtual TContactItemId | AtL(TInt) |
| virtual TAny * | CContactViewBase_Reserved_1(TFunction, TAny *) |
| virtual const CViewContact & | ContactAtL(TInt) |
| virtual TContactViewPreferences | ContactViewPreferences() |
| virtual TInt | CountL() |
| virtual TInt | FindL(TContactItemId) |
| IMPORT_C CContactConcatenatedView * | NewL(MContactViewObserver &, const CContactDatabase &, RPointerArray< CContactViewBase > &) |
| virtual const RContactViewSortOrder & | SortOrderL() |
| Inherited Attributes | |
|---|---|
| CContactViewBase::iDb | |
| CContactViewBase::iExtension | |
| CContactViewBase::iState | |
| Inherited Enumerations | |
|---|---|
| CContactViewBase:TFunction | |
| CContactViewBase:TSearchType | |
| CContactViewBase:TState | |
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().
Reimplemented from CContactViewBase::AllFieldsLC(TInt,const TDesC &)const
Returns a descriptor containing the contents of all fields in an item in the view.
The fields are separated by aSeparator.
| Parameters | |
|---|---|
| aIndex | The index into the view of the contact item. |
| aSeparator | The string to use to separate the fields. |
| 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. |
| TContactItemId | AtL | ( | TInt | aIndex | ) | const [virtual] |
Reimplemented from CContactViewBase::AtL(TInt)const
Gets the contact item ID at the specified index into the concatenated view.
| Parameters | |
|---|---|
| aIndex | Index into the concatenated view. |
| 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. |
Reimplemented from CContactViewBase::CContactViewBase_Reserved_1(TFunction,TAny *)
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 | |
|---|---|
| aFunction | an enum value that identifies which helper method is called. |
| aParams | parameters to the helper method being called. |
| Capability | |
|---|---|
| ReadUserData |
| const CViewContact & | ContactAtL | ( | TInt | aIndex | ) | const [virtual] |
Reimplemented from CContactViewBase::ContactAtL(TInt)const
Gets the contact item at the specified index into the view.
| Parameters | |
|---|---|
| aIndex | Index into the view. |
| 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. |
| TContactViewPreferences | ContactViewPreferences | ( | ) | [virtual] |
Reimplemented from CContactViewBase::ContactViewPreferences()
Gets the view preferences for the first component view.
| TInt | CountL | ( | ) | const [virtual] |
Reimplemented from CContactViewBase::CountL()const
Gets the number of contact items in the concatenated view.
| Leave Codes | |
|---|---|
| KErrNotReady | The view is not ready for use. |
| TInt | FindL | ( | TContactItemId | aId | ) | const [virtual] |
Reimplemented from CContactViewBase::FindL(TContactItemId)const
Finds the index into the concatenated view of the specified contact item.
| Parameters | |
|---|---|
| aId | The contact item ID to search for. |
| Leave Codes | |
|---|---|
| KErrNotReady | The view is not ready for use. |
| IMPORT_C CContactConcatenatedView * | NewL | ( | MContactViewObserver & | aObserver, |
| const CContactDatabase & | aDb, | |||
| RPointerArray< CContactViewBase > & | aComponentViews | |||
| ) | [static] | |||
Allocates and constructs a new CContactConcatenatedView object,
| Parameters | |
|---|---|
| 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. |
| aDb | The database that contains the contact items. |
| 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. |
| const RContactViewSortOrder & | SortOrderL | ( | ) | const [virtual] |
Reimplemented from CContactViewBase::SortOrderL()const
Gets the sort order for the first component view.