Collapse all Symbian^3 Application Developer Library

CVPbkFieldTypeSelector Class Reference

class CVPbkFieldTypeSelector : public CBase

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.

Inherits from

CVPbkFieldTypeSelector
- CBase

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 )

Private Member Functions
	CVPbkFieldTypeSelector (const MVPbkFieldTypeList &)
TInt	CalculateBufferSize ()
void	CommonConstructL ()
void	ConstructL ( TResourceReader &)
void	ConstructL (const CVPbkFieldTypeSelector &)
void	DoAppendL ( TResourceReader &)
void	DoFillBufferL ( RWriteStream &)
TBool	DoIsFieldDataIncludedL (const MVPbkBaseContactField &)
TBool	IsFieldDataIncluded (const MVPbkBaseContactField &)
void	SelectionPropertyReset ()

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
TInt	iContactActionType
const MVPbkFieldTypeList &	iFieldTypeList
RArray < TSelectionProperty >	iSelectionProperties

Constructor & Destructor Documentation

CVPbkFieldTypeSelector(const MVPbkFieldTypeList &)

CVPbkFieldTypeSelector

(

const MVPbkFieldTypeList &

aFieldTypeList

)

[private]

Parameters

const MVPbkFieldTypeList & aFieldTypeList

~CVPbkFieldTypeSelector()

~CVPbkFieldTypeSelector

(

)

Destructor.

Member Functions Documentation

AddressFieldsIncluded(const MVPbkStoreContactFieldCollection &)

IMPORT_C TInt

AddressFieldsIncluded

(

const MVPbkStoreContactFieldCollection &

aFields

)

const

Calculates the number of addresses

Parameters

const MVPbkStoreContactFieldCollection & aFields

A field collection to test.

AppendL(TResourceReader &)

void

AppendL

(

TResourceReader &

aReader

)

Appends a VPBK_FIELD_TYPE_SELECTOR resource to this selector.

Parameters

TResourceReader & aReader

Resource reader initialized to the VPBK_FIELD_TYPE_SELECTOR resource structure.

CalculateBufferSize()

TInt

CalculateBufferSize

(

)

const [private]

CommonConstructL()

void

CommonConstructL

(

)

[private]

ConstructL(TResourceReader &)

void

ConstructL

(

TResourceReader &

aReader

)

[private, inline]

Parameters

TResourceReader & aReader

ConstructL(const CVPbkFieldTypeSelector &)

void

ConstructL

(

const CVPbkFieldTypeSelector &

aSelector

)

[private, inline]

Parameters

const CVPbkFieldTypeSelector & aSelector

DoAppendL(TResourceReader &)

void

DoAppendL

(

TResourceReader &

aReader

)

[private]

Parameters

TResourceReader & aReader

DoFillBufferL(RWriteStream &)

void

DoFillBufferL

(

RWriteStream &

aWriteStream

)

const [private]

Parameters

RWriteStream & aWriteStream

DoIsFieldDataIncludedL(const MVPbkBaseContactField &)

TBool

DoIsFieldDataIncludedL

(

const MVPbkBaseContactField &

aField

)

const [private]

Parameters

const MVPbkBaseContactField & aField

ExternalizeLC()

IMPORT_C HBufC8 *

ExternalizeLC

(

)

const

Outputs this objects state to a buffer.

FieldTypeList()

const MVPbkFieldTypeList &

FieldTypeList

(

)

const

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

InternalizeL(const TDesC8 &)

IMPORT_C void

InternalizeL

(

const TDesC8 &

aBuffer

)

Initializes the instance from the buffer.

Parameters

const TDesC8 & aBuffer

Buffer containing externalized object.

IsFieldDataIncluded(const MVPbkBaseContactField &)

TBool

IsFieldDataIncluded

(

const MVPbkBaseContactField &

aField

)

const [private]

Parameters

const MVPbkBaseContactField & aField

IsFieldIncluded(const MVPbkBaseContactField &)

TBool

IsFieldIncluded

(

const MVPbkBaseContactField &

aField

)

const

Parameters

const MVPbkBaseContactField & aField

IsFieldTypeIncluded(const MVPbkFieldType &)

TBool

IsFieldTypeIncluded

(

const MVPbkFieldType &

aFieldType

)

const

Parameters

const MVPbkFieldType & aFieldType

MatchingNonVersitType(const MVPbkFieldType &)

IMPORT_C TVPbkNonVersitFieldType

MatchingNonVersitType

(

const MVPbkFieldType &

aFieldType

)

const

Returns the matching non-Versit type or EVPbkNonVersitTypeNone.

Parameters

const MVPbkFieldType & 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.

Parameters

const MVPbkFieldType & 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.

Parameters

TResourceReader & aReader	Resource reader initialized to the VPBK_FIELD_TYPE_SELECTOR resource structure.
const MVPbkFieldTypeList & aFieldTypeList	Field type list used to search for the field.

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.

Parameters

const MVPbkFieldTypeList & aFieldTypeList

Field type list used to search for the field.

NewL(const CVPbkFieldTypeSelector &)

IMPORT_C CVPbkFieldTypeSelector *

NewL

(

const CVPbkFieldTypeSelector &

aSelector

)

[static]

Copy constructs this object.

Parameters

const CVPbkFieldTypeSelector & aSelector

The object to copy construct from.

SelectionPropertyReset()

void

SelectionPropertyReset

(

)

[private]

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.

Parameters

TInt aContactActionType

contact action type

Member Data Documentation

TInt iContactActionType

TInt

iContactActionType

[private]

const MVPbkFieldTypeList & iFieldTypeList

const MVPbkFieldTypeList &

iFieldTypeList

[private]

RArray< TSelectionProperty > iSelectionProperties

RArray < TSelectionProperty >

iSelectionProperties

[private]