CContactSubView Class Reference

#include <app/cntview.h>

Link against: cntview.lib

class CContactSubView : 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 CContactSubView *NewL(MContactViewObserver &, const CContactDatabase &, CContactViewBase &, const TDesC &)
IMPORT_C CContactSubView *NewL(MContactViewObserver &, const CContactDatabase &, CContactViewBase &, const TDesC &, const TDesC &)
IMPORT_C CContactSubView *NewL(CContactViewBase &, const CContactDatabase &, MContactViewObserver &, const TDesC &)
IMPORT_C CContactSubView *NewL(CContactViewBase &, const CContactDatabase &, MContactViewObserver &, const TDesC &, const TDesC &)
virtual const RContactViewSortOrder &SortOrderL()
Inherited Attributes
CContactViewBase::iDb
CContactViewBase::iExtension
CContactViewBase::iState
Inherited Enumerations
CContactViewBase:TFunction
CContactViewBase:TSearchType
CContactViewBase:TState
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::ContactsMatchingCriteriaL(const MDesC16Array &,RPointerArray< CViewContact > &)
CContactViewBase::ContactsMatchingCriteriaL(const MDesCArray &,RPointerArray< CViewContact > &)
CContactViewBase::ContactsMatchingPrefixL(const MDesC16Array &,RPointerArray< CViewContact > &)
CContactViewBase::ContactsMatchingPrefixL(const MDesCArray &,RPointerArray< CViewContact > &)
CContactViewBase::Error()const
CContactViewBase::FieldsWithSeparatorLC(const RPointerArray< CViewContact > &,TInt,const TDesC &)const
CContactViewBase::FindDefaultViewSortPluginImplL()const
CContactViewBase::FindSortPluginImplL(const TDesC8 &,TBool)const
CContactViewBase::GetContactIdsL(const CArrayFix< TInt > &,CContactIdArray &)
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 MDesC16Array &)
CContactViewBase::MatchesCriteriaL(const CViewContact &,const MDesC16Array &,TSearchType)
CContactViewBase::MatchesCriteriaL(const CViewContact &,const MDesC16Array &,TSearchType,CContactViewBase::CContactViewBaseExtension *)
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()

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

Member Function Documentation

AllFieldsLC ( TInt, const TDesC & )

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

Reimplemented from CContactViewBase::AllFieldsLC(TInt,const TDesC &)const

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
aIndexThe index into the sub view of the contact item.
aSeparatorThe string to use to separate the fields.
Return Value
Pointer to the contact item descriptor.

AtL ( TInt )

TContactItemId AtL(TIntaIndex)const [virtual]

Reimplemented from CContactViewBase::AtL(TInt)const

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
aIndexIndex into the sub view of a contact item ID.
Return Value
The contact item ID.
Leave Codes
KErrNotFoundaIndex is outside the bounds of the sub view's array.

CContactViewBase_Reserved_1 ( TFunction, TAny * )

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

Reimplemented from CContactViewBase::CContactViewBase_Reserved_1(TFunction,TAny *)

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

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

ContactAtL ( TInt )

const CViewContact &ContactAtL(TIntaIndex)const [virtual]

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
aIndexIndex into the sub view of the required item.
Return Value
The contact item.
Leave Codes
KErrNotFoundaIndex is outside the bounds of the sub view's array.

ContactViewPreferences ( )

TContactViewPreferences ContactViewPreferences()[virtual]

Gets the underlying view's view preferences.

Return Value
The view preferences.

CountL ( )

TInt CountL()const [virtual]

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
The number of contact item IDs in the sub view.

FindL ( TContactItemId )

TInt FindL(TContactItemIdaId)const [virtual]

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

Parameters
aIdThe contact item ID to search for.
Return Value
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.

NewL ( MContactViewObserver &, const CContactDatabase &, CContactViewBase &, const TDesC & )

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

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
aObserverAn 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.
aDbThe database containing the contact items.
aViewThe underlying view.
aBoundaryA string containing the sub view criteria. Possible values are: <, >, <=, or >=, followed by a character.
Return Value
The newly constructed sub view object.

NewL ( MContactViewObserver &, const CContactDatabase &, CContactViewBase &, const TDesC &, const TDesC & )

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

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
aObserverAn 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.
aDbThe database containing the contact items.
aViewThe underlying view.
aLowBoundaryA string containing the sub view's lower boundary criteria. Possible values are: > or >=, followed by a character.
aHighBoundaryA string containing the sub view's upper boundary criteria. Possible values are: < or <=, followed by a character.
Return Value
The newly constructed sub view object.

NewL ( CContactViewBase &, const CContactDatabase &, MContactViewObserver &, const TDesC & )

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

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
aViewThe underlying view.
aDbThe database containing the contact items.
aObserverAn 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.
aBoundaryA string containing the sub view criteria. Possible values are: <, >, <=, or >=, followed by a character.
Return Value
The newly constructed sub view object.

NewL ( CContactViewBase &, const CContactDatabase &, MContactViewObserver &, const TDesC &, const TDesC & )

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

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
aViewThe underlying view.
aDbThe database containing the contact items.
aObserverAn 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.
aLowBoundaryA string containing the sub view's lower boundary criteria. Possible values are: > or >=, followed by a character.
aHighBoundaryA string containing the sub view's upper boundary criteria. Possible values are: < or <=, followed by a character.
Return Value
The newly constructed sub view object.

SortOrderL ( )

const RContactViewSortOrder &SortOrderL()const [virtual]

Gets the underlying view's sort order.

Return Value
The sort order.