Collapse all Symbian^3 Product Developer Library

MVasBasePbkHandler Class Reference

class MVasBasePbkHandler

Abstract base class for phonebook data access

Since: 3.2

Public Member Functions
	~MVasBasePbkHandler()
void	ChangeVoiceTagFieldL(TBool)
void	CloseContactL(TBool)
void	CompressL()
CContactIdArray *	ContactIdArrayLC()
void	CreateContactObserverL(MVasContactObserver *)
TInt	FieldIdL()
TFieldType	FieldTypeL()
void	FindContactFieldL(MNssTag *)
void	FindContactL(MNssTag *)
void	FindContactL(TInt32, TBool)
void	FindDefaultContactFieldL(TInt)
void	FindFieldL(MNssTag *)
void	FindFieldL(TInt)
void	InitializeL()
TBool	IsFieldEmptyL()
TPtrC	LabelL()
TPtrC	TextL()

Constructor & Destructor Documentation

~MVasBasePbkHandler()

~MVasBasePbkHandler

(

)

[inline, virtual]

Destructor. Defined here so that client can use M-class pointer to destroy the concrete C-object

Since: 3.2

Member Functions Documentation

ChangeVoiceTagFieldL(TBool)

void

ChangeVoiceTagFieldL

(

TBool

aSet

)

[pure virtual]

Changes current field's voice tag field status

Since: 3.2

Parameters

TBool aSet

If ETrue field is set else field is removed

CloseContactL(TBool)

void

CloseContactL

(

TBool

aSaveChanges

)

[pure virtual]

Closes contact with or without saving changes

Since: 3.2

Parameters

TBool aSaveChanges

ETrue to save changes else EFalse

CompressL()

void

CompressL

(

)

[pure virtual]

Compresses database

Since: 3.2

ContactIdArrayLC()

CContactIdArray *

ContactIdArrayLC

(

)

[pure virtual]

Returns all contact ids from database

Since: 3.2

CreateContactObserverL(MVasContactObserver *)

void

CreateContactObserverL

(

MVasContactObserver *

aObserver

)

[pure virtual]

Creates the contact change notifier and sets observer as a listener

Since: 3.2

Parameters

MVasContactObserver * aObserver

Contact change listener

FieldIdL()

TInt

FieldIdL

(

)

[pure virtual]

Returns the field id

Since: 3.2

FieldTypeL()

TFieldType

FieldTypeL

(

)

[pure virtual]

Returns the field type

Since: 3.2

FindContactFieldL(MNssTag *)

void

FindContactFieldL

(

MNssTag *

aTag

)

[pure virtual]

Finds a field from contact

Since: 3.2

Parameters

MNssTag * aTag

Tag that is used as a search parameter

FindContactL(MNssTag *)

void

FindContactL

(

MNssTag *

aTag

)

[pure virtual]

Finds a contact from phonebook

Since: 3.2

Parameters

MNssTag * aTag

Tag that is used as a search parameter

FindContactL(TInt32, TBool)

void	FindContactL	(	TInt32	aContactId,
			TBool	aReadOnly
		)	[pure virtual]

Finds a contact from phonebook

Since: 3.2

Parameters

TInt32 aContactId	Id of the contact that should be found
TBool aReadOnly	ETrue if contact will not be edited else EFalse

FindDefaultContactFieldL(TInt)

void

FindDefaultContactFieldL

(

TInt

aCommandType

)

[pure virtual]

Searches for a default field of a given type

Parameters

TInt aCommandType

Command type that is used as a select parameter Must be one of TVasExtensionCommand types

FindFieldL(MNssTag *)

void

FindFieldL

(

MNssTag *

aTag

)

[pure virtual]

Finds a field from contact

Since: 3.2

Parameters

MNssTag * aTag

Tag that is used as a search parameter

FindFieldL(TInt)

void

FindFieldL

(

TInt

aFieldId

)

[pure virtual]

Finds a field from contact

Since: 3.2

Parameters

TInt aFieldId

Field id that is used as a search parameter

InitializeL()

void

InitializeL

(

)

[pure virtual]

Opens phonebook connection and contact stores

Since: 3.2

IsFieldEmptyL()

TBool

IsFieldEmptyL

(

)

[pure virtual]

Returns information if current field is empty

Since: 3.2

LabelL()

TPtrC

LabelL

(

)

[pure virtual]

Returns the field label

Since: 3.2

TextL()

TPtrC

TextL

(

)

[pure virtual]

Returns the field text

Since: 3.2