Collapse all Symbian^3 Application Developer Library

CVPbkContactViewDefinition Class Reference

class CVPbkContactViewDefinition : public CBase

A contact view definition.

This class is needed when a client needs to create a contact view. A client can define a structure of VPBK_CONTACT_VIEW from VPbkContactView.rh and use this class to read the definition or construct an empty definition and then set the information to it.

A view definition enables complex view structures. A client can e.g. create a composite view that contains subviews from multiple contact stores. However, it's up to client to understand that there are certain limits for the structure. E.g. a contact view is a leaf view and can not have subviews. Another important thing to keep in mind is that complex view structures consumes more RAM that can be a problem if there are thousands of contacts in the view.

VPBK_CONTACT_VIEW in VPbkContactView.rh CVPbkContactManager::CreateContactViewLC VPbkEng.lib

Inherits from

CVPbkContactViewDefinition
- CBase

Public Member Functions
	~CVPbkContactViewDefinition ()
IMPORT_C void	AddSubViewL ( CVPbkContactViewDefinition *)
IMPORT_C MVPbkContactSelector *	ContactSelector ()
IMPORT_C CVPbkFieldTypeSelector *	FieldTypeFilter ()
IMPORT_C TBool	FlagIsOn ( TVPbkContactViewFlag )
IMPORT_C TInt	Id ()
IMPORT_C const TDesC &	Name ()
IMPORT_C CVPbkContactViewDefinition *	NewL ( TResourceReader &)
IMPORT_C CVPbkContactViewDefinition *	NewL ()
IMPORT_C CVPbkContactViewDefinition *	NewL (const CVPbkContactViewDefinition &)
IMPORT_C CVPbkContactViewDefinition *	NewLC ( TResourceReader &)
IMPORT_C CVPbkContactViewDefinition *	NewLC ()
IMPORT_C CVPbkContactViewDefinition *	NewLC (const CVPbkContactViewDefinition &)
IMPORT_C void	SetContactSelector ( MVPbkContactSelector *)
IMPORT_C void	SetFieldTypeFilterL ( CVPbkFieldTypeSelector *)
IMPORT_C void	SetFlag ( TVPbkContactViewFlag , TBool )
IMPORT_C void	SetId ( TInt )
IMPORT_C void	SetNameL (const TDesC &)
IMPORT_C void	SetSharing ( TVPbkContactViewSharing )
IMPORT_C void	SetSortPolicy ( TVPbkContactViewSortPolicy )
IMPORT_C void	SetType ( TVPbkContactViewType )
IMPORT_C void	SetUriL (const TDesC &)
IMPORT_C TVPbkContactViewSharing	Sharing ()
IMPORT_C TVPbkContactViewSortPolicy	SortPolicy ()
IMPORT_C const CVPbkContactViewDefinition &	SubViewAt ( TInt )
IMPORT_C CVPbkContactViewDefinition &	SubViewAt ( TInt )
IMPORT_C TInt	SubViewCount ()
IMPORT_C TVPbkContactViewType	Type ()
IMPORT_C const TDesC &	Uri ()

Private Member Functions
	CVPbkContactViewDefinition ()
void	ConstructFromResourceL ( TResourceReader &)
void	ConstructL ()
void	ConstructL (const CVPbkContactViewDefinition &)
void	InitializeSharing ()

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()

Private Attributes
MVPbkContactSelector *	iContactSelector
CVPbkFieldTypeSelector *	iFilter
TUint32	iFlags
TInt	iId
HBufC *	iName
TVPbkContactViewSharing	iSharing
TVPbkContactViewSortPolicy	iSortPolicy
RPointerArray < CVPbkContactViewDefinition >	iSubViews
TVPbkContactViewType	iType
HBufC *	iUri

Constructor & Destructor Documentation

CVPbkContactViewDefinition()

CVPbkContactViewDefinition

(

)

[private]

~CVPbkContactViewDefinition()

~CVPbkContactViewDefinition

(

)

Destructor.

Member Functions Documentation

AddSubViewL(CVPbkContactViewDefinition *)

IMPORT_C void

AddSubViewL

(

CVPbkContactViewDefinition *

aSubView

)

Adds new view as a subview. This object takes ownership of the subview. If this function leaves ownership is not taken.

Parameters

CVPbkContactViewDefinition * aSubView

The new subview to add.

ConstructFromResourceL(TResourceReader &)

void

ConstructFromResourceL

(

TResourceReader &

aReader

)

[private]

Parameters

TResourceReader & aReader

ConstructL()

void

ConstructL

(

)

[private]

ConstructL(const CVPbkContactViewDefinition &)

void

ConstructL

(

const CVPbkContactViewDefinition &

aViewDef

)

[private]

Parameters

const CVPbkContactViewDefinition & aViewDef

ContactSelector()

IMPORT_C MVPbkContactSelector *

ContactSelector

(

)

const

Gives either the contact selector or NULL. Ownership is not transferred.

FieldTypeFilter()

IMPORT_C CVPbkFieldTypeSelector *

FieldTypeFilter

(

)

const

Returns the field type selector used to filter the view or NULL.

The view contains only contacts having the fields defined by the field type filter.

FlagIsOn(TVPbkContactViewFlag)

IMPORT_C TBool

FlagIsOn

(

TVPbkContactViewFlag

aFlag

)

const

Returns ETrue if aFlag is on, otherwise EFalse.

Parameters

TVPbkContactViewFlag aFlag

The flag to check.

Id()

IMPORT_C TInt

(

)

const

Returns the id of this view.

InitializeSharing()

void

InitializeSharing

(

)

[private]

Name()

IMPORT_C const TDesC &

Name

(

)

const

Returns the name of the view. Default is KNullDesC.

In view types EVPbkContactsView and EVPbkGroupsView the name can be used as a shared view identifier by the store. Shared view creation is indicated by TVPbkContactViewSharing. If the name is empty for shared view then store implementation uses its default name. This is a preferred way to use shared views in the platform.

In view type EVPbkFoldingView the name is the label of the only contact in the view.

In view type EVPbkCompositeView the name has no meaning.

NewL(TResourceReader &)

IMPORT_C CVPbkContactViewDefinition *

NewL

(

TResourceReader &

aReader

)

[static]

Creates a new contact view definition and initializes it from resource. Takes a VPBK_CONTACT_VIEW resource structure as a parameter.

Parameters

TResourceReader & aReader

A resource reader to a VPBK_CONTACT_VIEW structure.

NewL()

IMPORT_C CVPbkContactViewDefinition *

NewL

(

)

[static]

Creates a new empty contact view definition. Client must then set the needed information.

NewL(const CVPbkContactViewDefinition &)

IMPORT_C CVPbkContactViewDefinition *

NewL

(

const CVPbkContactViewDefinition &

aViewDef

)

[static]

Constructs a new contact view definition from an existing one by copying the data.

Parameters

const CVPbkContactViewDefinition & aViewDef

A view definition to copy.

NewLC(TResourceReader &)

IMPORT_C CVPbkContactViewDefinition *

NewLC

(

TResourceReader &

aReader

)

[static]

Creates a new contact view definition and initializes it from resource. Takes a VPBK_CONTACT_VIEW resource structure as a parameter.

Parameters

TResourceReader & aReader

A resource reader to a VPBK_CONTACT_VIEW structure.

NewLC()

IMPORT_C CVPbkContactViewDefinition *

NewLC

(

)

[static]

Creates a new empty contact view definition. Client must then set the needed information.

NewLC(const CVPbkContactViewDefinition &)

IMPORT_C CVPbkContactViewDefinition *

NewLC

(

const CVPbkContactViewDefinition &

aViewDef

)

[static]

Constructs a new contact view definition from an existing one by copying the data.

Parameters

const CVPbkContactViewDefinition & aViewDef

A view definition to copy.

SetContactSelector(MVPbkContactSelector *)

IMPORT_C void

SetContactSelector

(

MVPbkContactSelector *

aContactSelector

)

Sets the contact selector used to filter the view.

The view contains only contacts accepted by the selector.

Parameters

MVPbkContactSelector * aContactSelector

The contact selector. Use NULL to filter nothing. Ownership not transferred.

SetFieldTypeFilterL(CVPbkFieldTypeSelector *)

IMPORT_C void

SetFieldTypeFilterL

(

CVPbkFieldTypeSelector *

aFilter

)

Sets the field type selector used to filter the view.

The view contains only contacts having the fields defined by the field type filter.

Parameters

CVPbkFieldTypeSelector * aFilter

The field type filter. Use NULL to filter nothing.

SetFlag(TVPbkContactViewFlag, TBool)

IMPORT_C void	SetFlag	(	TVPbkContactViewFlag	aFlag,
			TBool	aState
		)

Sets the saFlag's state as aState.

Parameters

TVPbkContactViewFlag aFlag	The flag to modify.
TBool aState	The state to set.

SetId(TInt)

IMPORT_C void

SetId

(

TInt

aId

)

Sets aId as this views id.

Parameters

TInt aId

the id to set.

SetNameL(const TDesC &)

IMPORT_C void

SetNameL

(

const TDesC &

aName

)

Sets aName as this views Name. This function takes a copy of aName.

Parameters

const TDesC & aName

The name to set.

SetSharing(TVPbkContactViewSharing)

IMPORT_C void

SetSharing

(

TVPbkContactViewSharing

aViewSharing

)

Sets the view sharing type.

Parameters

TVPbkContactViewSharing aViewSharing

One of the values defined in VPbkContactView.hrh.

SetSortPolicy(TVPbkContactViewSortPolicy)

IMPORT_C void

SetSortPolicy

(

TVPbkContactViewSortPolicy

aSortPolicy

)

Sets aSortPolicy as this views sorting policy.

Parameters

TVPbkContactViewSortPolicy aSortPolicy

The sort policy to set.

SetType(TVPbkContactViewType)

IMPORT_C void

SetType

(

TVPbkContactViewType

aType

)

Sets aType as this views type.

Parameters

TVPbkContactViewType aType

The type to set.

SetUriL(const TDesC &)

IMPORT_C void

SetUriL

(

const TDesC &

aUri

)

Sets aUri as this views URI. This function takes a copy of aUri.

Parameters

const TDesC & aUri

The URI to set.

Sharing()

IMPORT_C TVPbkContactViewSharing

Sharing

(

)

const

Returns the view sharing type. The store can support a shared view creation for saving RAM.

Default value for types EVPbkContactsView and EVPbkGroupsView is EVPbkSharedView. Store implementation creates then a shared view if it's possible for the store. Prefer using the default values for saving resources.

For view types EVPbkFoldingView and EVPbkCompositeView the sharing has no effect.

SortPolicy()

IMPORT_C TVPbkContactViewSortPolicy

SortPolicy

(

)

const

Returns the sorting policy of this view.

SubViewAt(TInt)

IMPORT_C const CVPbkContactViewDefinition &

SubViewAt

(

TInt

aIndex

)

const

Returns the sub view definition at aIndex.

Parameters

TInt aIndex

The index of the sub view definition.

SubViewAt(TInt)

IMPORT_C CVPbkContactViewDefinition &

SubViewAt

(

TInt

aIndex

)

Returns the sub view definition at aIndex.

Parameters

TInt aIndex

The index to query.

SubViewCount()

IMPORT_C TInt

SubViewCount

(

)

const

Returns the number of sub views owned by this view.

Type()

IMPORT_C TVPbkContactViewType

Type

(

)

const

Returns the type of this view.

Uri()

IMPORT_C const TDesC &

Uri

(

)

const

Returns the URI of this view. KNullDesC if this is not a leaf node.

Member Data Documentation

MVPbkContactSelector * iContactSelector

MVPbkContactSelector *

iContactSelector

[private]

CVPbkFieldTypeSelector * iFilter

CVPbkFieldTypeSelector *

iFilter

[private]

TUint32 iFlags

TUint32

iFlags

[private]

TInt iId

TInt

iId

[private]

HBufC * iName

HBufC *

iName

[private]

TVPbkContactViewSharing iSharing

TVPbkContactViewSharing

iSharing

[private]

TVPbkContactViewSortPolicy iSortPolicy

TVPbkContactViewSortPolicy

iSortPolicy

[private]

RPointerArray< CVPbkContactViewDefinition > iSubViews

RPointerArray < CVPbkContactViewDefinition >

iSubViews

[private]

TVPbkContactViewType iType

TVPbkContactViewType

iType

[private]

HBufC * iUri

HBufC *

iUri

[private]