CVPbkFieldTypeSelector Class Reference

#include <app/CVPbkFieldTypeSelector.h>

class CVPbkFieldTypeSelector : public CBase

Inherits from

CVPbkFieldTypeSelector

Nested Classes and Structures

CVPbkFieldTypeSelector::TSelectionProperty

Public Member Functions
	~CVPbkFieldTypeSelector()
IMPORT_C TInt	AddressFieldsIncluded(const MVPbkStoreContactFieldCollection &)
void	AppendL(TResourceReader &)
IMPORT_C HBufC8 *	ExternalizeLC()
const MVPbkFieldTypeList &	FieldTypeList()
IMPORT_C void	InternalizeL(const TDesC8 &)
TBool	IsFieldIncluded(const MVPbkBaseContactField &)
TBool	IsFieldTypeIncluded(const MVPbkFieldType &)
IMPORT_C TVPbkNonVersitFieldType	MatchingNonVersitType(const MVPbkFieldType &)
IMPORT_C const TVPbkFieldVersitProperty *	MatchingVersitProperty(const MVPbkFieldType &)
IMPORT_C CVPbkFieldTypeSelector *	NewL(TResourceReader &, const MVPbkFieldTypeList &)
IMPORT_C CVPbkFieldTypeSelector *	NewL(const MVPbkFieldTypeList &)
IMPORT_C CVPbkFieldTypeSelector *	NewL(const CVPbkFieldTypeSelector &)
void	SetContactActionType(TInt)

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

Detailed Description

Virtual Phonebook field type selector. Responsible for creating a field or field type selection object. Clients can create a selector and then use e.g. IsFieldIncluded to detect whether the field matches the set criteria.

Constructor & Destructor Documentation

~CVPbkFieldTypeSelector ( )

~CVPbkFieldTypeSelector

(

)

Destructor.

Member Function Documentation

AddressFieldsIncluded ( const MVPbkStoreContactFieldCollection & )

IMPORT_C TInt

AddressFieldsIncluded

(

const MVPbkStoreContactFieldCollection &

aFields

)

const

Calculates the number of addresses

Parameter	Description
aFields	A field collection to test.

Returns: Calculated number of addresses.

AppendL ( TResourceReader & )

void

AppendL

(

TResourceReader &

aReader

)

Appends a VPBK_FIELD_TYPE_SELECTOR resource to this selector.

Parameter	Description
aReader	Resource reader initialized to the VPBK_FIELD_TYPE_SELECTOR resource structure.

ExternalizeLC ( )

IMPORT_C HBufC8 *

ExternalizeLC

(

)

const

Outputs this objects state to a buffer.

Returns: Buffer containg this object.

FieldTypeList ( )

const MVPbkFieldTypeList &

FieldTypeList

(

)

const

Returns the field type list with which this object was initialized with.

Returns: Field type list.

InternalizeL ( const TDesC8 & )

IMPORT_C void

InternalizeL

(

const TDesC8 &

aBuffer

)

Initializes the instance from the buffer.

Parameter	Description
aBuffer	Buffer containing externalized object.

IsFieldIncluded ( const MVPbkBaseContactField & )

TBool

IsFieldIncluded

(

const MVPbkBaseContactField &

aField

)

const

IsFieldTypeIncluded ( const MVPbkFieldType & )

TBool

IsFieldTypeIncluded

(

const MVPbkFieldType &

aFieldType

)

const

MatchingNonVersitType ( const MVPbkFieldType & )

IMPORT_C TVPbkNonVersitFieldType

MatchingNonVersitType

(

const MVPbkFieldType &

aFieldType

)

const

Returns the matching non-Versit type or EVPbkNonVersitTypeNone.

Parameter	Description
aFieldType	The field type to test.

MatchingVersitProperty ( const MVPbkFieldType & )

IMPORT_C const TVPbkFieldVersitProperty *

MatchingVersitProperty

(

const MVPbkFieldType &

aFieldType

)

const

Returns the matching Versit property or NULL.

Parameter	Description
aFieldType	The field type to test.

NewL ( TResourceReader &, const MVPbkFieldTypeList & )

IMPORT_C CVPbkFieldTypeSelector *	NewL	(	TResourceReader &	aReader,
			const MVPbkFieldTypeList &	aFieldTypeList
		)	[static]

Constructs this object from a VPBK_FIELD_TYPE_SELECTOR ( VPbkFieldType.rh ) resource.

Parameter	Description
aReader	Resource reader initialized to the VPBK_FIELD_TYPE_SELECTOR resource structure.
aFieldTypeList	Field type list used to search for the field.

Returns: A new instance of this class.

NewL ( const MVPbkFieldTypeList & )

IMPORT_C CVPbkFieldTypeSelector *

NewL

(

const MVPbkFieldTypeList &

aFieldTypeList

)

[static]

Constructs an empty selector. Can be used in combination with InternalizeL or AppendL to create a selector.

Parameter	Description
aFieldTypeList	Field type list used to search for the field.

Returns: A new instance of this class.

NewL ( const CVPbkFieldTypeSelector & )

IMPORT_C CVPbkFieldTypeSelector *

NewL

(

const CVPbkFieldTypeSelector &

aSelector

)

[static]

Copy constructs this object.

Parameter	Description
aSelector	The object to copy construct from.

Returns: A new instance of this class.

SetContactActionType ( TInt )

void

SetContactActionType

(

TInt

aContactActionType

)

Sets contact action type. Contact action type is used to filter xsp id fields according to data and service type.

Parameter	Description
aContactActionType	contact action type