Collapse all Symbian^3 Product Developer Library

TPositionFieldIndex Class Reference

class TPositionFieldIndex

This is an internal class used for indexing entries in HPositionGenericInfo. Methods in this class are not intended to be called directly. Clients should use HPositionGenericInfo::GetValue() and HPositionGenericInfo::SetValue() methods.

Public Member Functions
	TPositionFieldIndex()
TPositionFieldId	FieldId()
TUint16	FieldStartPos()
PositionFieldManager::TFieldType	FieldType()
void	SetFieldId(TPositionFieldId)
void	SetFieldStartPos(TUint16)
void	SetFieldType(PositionFieldManager::TFieldType)

Private Attributes
TPositionFieldId	iFieldId
TUint16	iFieldStartPos
PositionFieldManager::TFieldType	iFieldType

Constructor & Destructor Documentation

TPositionFieldIndex()

TPositionFieldIndex

(

)

[inline]

Constructor

Default constructor. Sets the Id and start position to zero and the field type to PositionFieldManager::EUndefined.

Member Functions Documentation

FieldId()

TPositionFieldId

FieldId

(

)

const [inline]

Get the field ID referred to by this object.

FieldStartPos()

TUint16

FieldStartPos

(

)

const [inline]

Get the offset in buffer where this field is contained.

FieldType()

PositionFieldManager::TFieldType

FieldType

(

)

const [inline]

Get the data type of this field.

SetFieldId(TPositionFieldId)

void

SetFieldId

(

TPositionFieldId

aFieldId

)

[inline]

Set the field ID referred to by this object.

Parameters

TPositionFieldId aFieldId

Sets the field Id of the entry this index refers to.

SetFieldStartPos(TUint16)

void

SetFieldStartPos

(

TUint16

aFieldStartPos

)

[inline]

Set the offset in buffer where this field is contained.

Parameters

TUint16 aFieldStartPos

Sets the start position of the entry this index refers to.

SetFieldType(PositionFieldManager::TFieldType)

void

SetFieldType

(

PositionFieldManager::TFieldType

aFieldType

)

[inline]

Set the data type of this field.

Parameters

PositionFieldManager::TFieldType aFieldType

Sets the field data type of the entry this index refers to.

Member Data Documentation

TPositionFieldId iFieldId

TPositionFieldId

iFieldId

[private]

Id of the field that this index refers to.

TUint16 iFieldStartPos

TUint16

iFieldStartPos

[private]

Offset from HPositionGenericInfo::iBuffer that the object referred to by this index starts at.

PositionFieldManager::TFieldType iFieldType

PositionFieldManager::TFieldType

iFieldType

[private]

Type of the data that this index refers to.