Collapse all Symbian^3 Application Developer Library

MVPbkContactViewObserver Class Reference

class MVPbkContactViewObserver

An observer interface for contact views.

A client will receive events related to the view state and the view content via this interface. CVPbkContactManager::CreateContactViewLC

Public Member Functions
void	ContactAddedToView ( MVPbkContactViewBase &, TInt , const MVPbkContactLink &)
void	ContactRemovedFromView ( MVPbkContactViewBase &, TInt , const MVPbkContactLink &)
void	ContactViewError ( MVPbkContactViewBase &, TInt , TBool )
TAny *	ContactViewObserverExtension ( TUid )
void	ContactViewReady ( MVPbkContactViewBase &)
void	ContactViewUnavailable ( MVPbkContactViewBase &)

Protected Member Functions
	~MVPbkContactViewObserver ()

Constructor & Destructor Documentation

~MVPbkContactViewObserver()

~MVPbkContactViewObserver

(

)

[protected, inline, virtual]

Member Functions Documentation

ContactAddedToView(MVPbkContactViewBase &, TInt, const MVPbkContactLink &)

void	ContactAddedToView	(	MVPbkContactViewBase &	aView,
			TInt	aIndex,
			const MVPbkContactLink &	aContactLink
		)	[pure virtual]

Called when a contact has been added to the view.

Parameters

MVPbkContactViewBase & aView	A contact view sending the event.
TInt aIndex	An index of the contact in the view.
const MVPbkContactLink & aContactLink	A link to the added contact that is valid only during the functio call.

ContactRemovedFromView(MVPbkContactViewBase &, TInt, const MVPbkContactLink &)

void	ContactRemovedFromView	(	MVPbkContactViewBase &	aView,
			TInt	aIndex,
			const MVPbkContactLink &	aContactLink
		)	[pure virtual]

Called when a contact has been removed from a view.

Parameters

MVPbkContactViewBase & aView	A contact view sending the event.
TInt aIndex	An index of the removed contact.
const MVPbkContactLink & aContactLink	A link to the removed contact that is valid only during this function call.

ContactViewError(MVPbkContactViewBase &, TInt, TBool)

void	ContactViewError	(	MVPbkContactViewBase &	aView,
			TInt	aError,
			TBool	aErrorNotified
		)	[pure virtual]

Called when an error occurs in the view.

If client decides to destroy the view then it should do it asynchronously because the view can access member data after a call to this.

Parameters

MVPbkContactViewBase & aView	A contact view sending the event.
TInt aError	An error code of the failure.
TBool aErrorNotified	ETrue if the implementation has already notified user about the error using e.g an ECOM plug-in, EFalse otherwise.

ContactViewObserverExtension(TUid)

TAny *

ContactViewObserverExtension

(

TUid

)

[inline, virtual]

Returns an extension point for this interface or NULL.

Parameters

TUid

ContactViewReady(MVPbkContactViewBase &)

void

ContactViewReady

(

MVPbkContactViewBase &

aView

)

[pure virtual]

Called when a view is ready for use.

This function may also be called if view is already ready. Then it means that the view has been updated and the observer have to take this into account.

Parameters

MVPbkContactViewBase & aView

A contact view sending the event.

ContactViewUnavailable(MVPbkContactViewBase &)

void

ContactViewUnavailable

(

MVPbkContactViewBase &

aView

)

[pure virtual]

Called when a view is unavailable for a while.

When the view is again available ContactViewReady will be called. The contents of the view may change completely while it is unavailable.

Parameters

MVPbkContactViewBase & aView

A contact view sending the event.