TContactViewEvent Class Reference

#include <app/cntviewbase.h>

class TContactViewEvent

Detailed Description

Identifies a contact view event.

Sent by contact views when notifying their observers of an event.

See also: MContactViewObserver::HandleContactViewEvent()

Member Attribute Documentation

iContactId

TContactItemId iContactId

The ID of the contact item that has been added or removed or the group ID, where relevant.

iEventType

TEventType iEventType

The type of event.

iInt

TInt iInt

The error code (where relevant) or the index of the contact item added to/removed from the underlying view.

Member Enumeration Documentation

Enum TEventType

Identifies the event's type.

EnumeratorValueDescription
EUnavailable

The observed view's state has changed from EReady to either ENotReady or EInitializing, so is not available for use.

EReady

The observed view's state has changed from ENotReady or EInitializing to EReady so is available for use.

ESortOrderChanged

The observed view's sort order has changed, so observer views need to update themselves.

ESortError

An error occurred when sorting the observed view or when appending an observer to its observer array.

The error code is provided in iInt.

EServerError

An error occurred in the contacts server.

The error code is provided in iInt.

EIndexingError

An error occurred when setting the range for a CContactSubView.

The error code is provided in iInt.

EItemAdded

An item has been added to the observed view.

The ID of the added item is provided in iContactId and the index into the observed view of the added item is provided in iInt. Exception from this are the first version of CContactFindView, CContactSubView and CContactGroupView classes. For these classes, iInt has KErrNone value

EItemRemoved

An item has been removed from the observed view.

The ID of the removed item is provided in iContactId and the index into the observed view of the item is provided in iInt. Exception from this are the first version of CContactFindView and CContactSubView classes. For these classes, iInt has KErrNone value

EGroupChanged

A change has occurred in a contact group, for instance a contact item has been moved into or out of the group.

The ID of the group affected is provided in iContactId.

Constructor & Destructor Documentation

TContactViewEvent ( )

TContactViewEvent()[inline]

Empty default constructor.

TContactViewEvent ( TEventType, TInt, TContactItemId )

TContactViewEvent(TEventTypeaEventType,
TIntaInt =  KErrUnknown ,
TContactItemIdaContactId =  KErrUnknown
)[inline]

Constructor with an event type and an optional error code and contact item ID.

Parameters
aEventTypeThe event type.
aIntOptional standard error code.
aContactIdOptional contact item ID.