MVPbkViewContact Class Reference

#include <app/MVPbkViewContact.h>

Link against: VPbkEng.lib

class MVPbkViewContact : public MVPbkBaseContact

Inherits from

Detailed Description

An interface for a view contact.

As the name already says the view contact is a contact in a view. It contains the fields that were defined in the sort order of the view. However, a store implementation possibly have limitations of field types that can be used in the sort order. If the store doesn't support the given field type in a view contact it sets the data of those fields to zero length. The order of the fields are same as in a sort order.

See also: MVPbkContactViewBase

Constructor & Destructor Documentation

~MVPbkViewContact ( )

~MVPbkViewContact()[protected, inline, virtual]

Destructor.

Member Function Documentation

Expandable ( )

MVPbkExpandable *Expandable()const [pure virtual]

Returns expandable interface for this object or NULL if expanding is not supported.

Examples are a contact group that can be expanded to its members view or a folding view that can be extended to its internals. Client can get the type of the view from MVPbkContactViewBase::Type which is useful for knowing the type of expansion.

Returns: An expansion or NULL.

IsSame ( const MVPbkViewContact &, const MVPbkContactStore * )

TBool IsSame(const MVPbkViewContact &aOtherContact,
const MVPbkContactStore *aContactStore
)const [pure virtual]

Returns ETrue if two contacts are same.

ParameterDescription
aOtherContactA contact to be compared.
aContactStoreThe store of the aOtherContact.

Returns: ETrue if two contacts are same.

IsSame ( const MVPbkStoreContact &, const MVPbkContactStore * )

TBool IsSame(const MVPbkStoreContact &aOtherContact,
const MVPbkContactStore *aContactStore
)const [pure virtual]

Returns ETrue if two contacts are same.

ParameterDescription
aOtherContactA contact to be compared.
aContactStoreThe store of the aOtherContact.

Returns: ETrue if two contacts are same.

IsSame ( const MVPbkBaseContact & )

TBool IsSame(const MVPbkBaseContact &aOtherContact)const [inline, virtual]

Reimplemented from MVPbkBaseContact::IsSame(const MVPbkBaseContact &)const

Do not override.

ParentView ( )

MVPbkContactViewBase &ParentView()const [pure virtual]

Returns the parent view of the contact.

Returns: The parent view of the contact.

ReadAndLockL ( MVPbkContactObserver & )

voidReadAndLockL(MVPbkContactObserver &aObserver)const [pure virtual]

Reads the whole contact and locks it for modification asynchronously.

A client can use this if it has a reference of the view contact and it needs to modify the contact.

The contact is returned in a call back.

Exceptions
KErrInUse

If another asynchronous operation is already in progress.

KErrAccessDenied

if contact is read-only

ParameterDescription
aObserverAn observer to call back when this operation completes. The observer will not be called if this function leaves.

ReadL ( MVPbkContactObserver & )

voidReadL(MVPbkContactObserver &aObserver)const [pure virtual]

Reads the whole contact from the store asynchronously.

A client can use this if it has a reference of the view contact but it needs all the data fields instead of only those that are included in the view contact.

The contact is returned in a call back.

Exceptions
KErrInUse

If another asynchronous operation is already in progress.

ParameterDescription
aObserverAn observer to call back when this operation completes. The observer will not be called if this function leaves.

ViewContactExtension ( TUid )

TAny *ViewContactExtension(TUid)[inline, virtual]

Returns an extension point for this interface or NULL.

Returns: An extension point for this interface or NULL.