CTextFieldSet Class Reference

class CTextFieldSet : public CBase

The engine that keeps the field table up to date

Inherits from

Public Member Functions
~CTextFieldSet ()
IMPORT_C TInt CharCount ()
IMPORT_C void CopyComponentsL ( CStreamStore &, CStoreMap &, TInt , TInt )
IMPORT_C TStreamId CopyToStoreL ( CStreamStore &, TInt , TInt )
IMPORT_C void CopyToStreamL ( RWriteStream &, TInt , TInt )
IMPORT_C void ExternalizeL ( RWriteStream &)
IMPORT_C TInt FieldCount ()
IMPORT_C MTextFieldFactory * FieldFactory ()
IMPORT_C TBool FindFields ( TInt )
IMPORT_C TBool FindFields ( TFindFieldInfo &, TInt , TInt )
IMPORT_C TInt InsertFieldL ( TInt , CTextField *, TUid )
IMPORT_C void InternalizeL ( RReadStream &)
IMPORT_C CTextField * NewFieldL ( TUid )
IMPORT_C TInt NewFieldValueL ( HBufC *&, TInt )
IMPORT_C CTextFieldSet * NewL ( TInt )
IMPORT_C CTextFieldSet * NewL (const MTextFieldFactory *, const CStreamStore &, TStreamId )
IMPORT_C void NotifyDeletion ( TInt , TInt )
IMPORT_C void NotifyFieldUpdate ( TInt , TInt )
IMPORT_C void NotifyInsertion ( TInt , TInt )
IMPORT_C void PasteComponentsL (const CStreamStore &, TInt )
IMPORT_C void PasteFromStoreL (const CStreamStore &, TStreamId , TInt , TInt )
IMPORT_C void PasteFromStreamL ( RReadStream &, TInt , TInt )
IMPORT_C TInt RemoveField ( TInt )
IMPORT_C void Reset ()
IMPORT_C void RestoreFieldsL (const CStreamStore &)
IMPORT_C void RestoreL (const CStreamStore &, TStreamId )
IMPORT_C void RollbackPaste ()
IMPORT_C void SetFieldFactory ( MTextFieldFactory *)
IMPORT_C void StoreFieldsL ( CStreamStore &, CStoreMap &)
IMPORT_C TStreamId StoreL ( CStreamStore &)
IMPORT_C const CTextField * TextField ( TInt )
Protected Member Functions
CTextFieldSet ()
void ConstructL ( TInt )
void ConstructL (const CStreamStore &, TStreamId )
Private Member Functions
void AddInitialFieldEntryL ( CArrayFixSeg < TTextFieldEntry > *, TInt )
void AppendEntryL ( TTextFieldEntry &)
void AppendEntryL ( TTextFieldEntry &, CArrayFixSeg < TTextFieldEntry > *)
void CopyToArrayL ( CArrayFixSeg < TTextFieldEntry > *, TInt , TInt )
void DeleteFieldEntry ( TInt )
void DeleteFieldEntry ( CArrayFixSeg < TTextFieldEntry > *, TInt )
void DoPasteL ( CArrayFixSeg < TTextFieldEntry > *, TInt )
void DoRestoreFieldsL ( CArrayFixSeg < TTextFieldEntry > *, const CStreamStore &, TInt )
void DoRestoreL (const CStreamStore &, TStreamId )
TInt EntryLen (const TTextFieldEntry &)
TInt EntryLen ( TInt )
void ExternalizeL ( RWriteStream &, CArrayFixSeg < TTextFieldEntry > *)
TBool InField (const TInt , TInt &, TInt &)
void InsertEntryL ( TInt , TTextFieldEntry &)
void InsertEntryL ( TInt , TTextFieldEntry &, CArrayFixSeg < TTextFieldEntry > *)
void InternalizeL ( CArrayFixSeg < TTextFieldEntry > *, RReadStream &)
void RecordRollbackInfoL ( TInt )
TTextFieldEntry SplitEntry ( TInt , TInt , TInt )
void StoreFieldsL ( CStreamStore &, CStoreMap &, CArrayFixSeg < TTextFieldEntry > *)
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
__DECLARE_TEST
CArrayFixSeg < TTextFieldEntry > * iFieldArray
MTextFieldFactory * iFieldFactory
TRollbackInfo * iRollbackInfo

Constructor & Destructor Documentation

CTextFieldSet()

CTextFieldSet ( ) [protected]

~CTextFieldSet()

IMPORT_C ~CTextFieldSet ( )

Member Functions Documentation

AddInitialFieldEntryL(CArrayFixSeg< TTextFieldEntry > *, TInt)

void AddInitialFieldEntryL ( CArrayFixSeg < TTextFieldEntry > * aArray,
TInt aDocumentLength
) [private]

Parameters

CArrayFixSeg < TTextFieldEntry > * aArray
TInt aDocumentLength

AppendEntryL(TTextFieldEntry &)

void AppendEntryL ( TTextFieldEntry & aEntry ) [private]

Parameters

TTextFieldEntry & aEntry

AppendEntryL(TTextFieldEntry &, CArrayFixSeg< TTextFieldEntry > *)

void AppendEntryL ( TTextFieldEntry & aEntry,
CArrayFixSeg < TTextFieldEntry > * aArray
) [private]

CharCount()

IMPORT_C TInt CharCount ( ) const

ConstructL(TInt)

void ConstructL ( TInt aDocumentLength ) [protected]

Parameters

TInt aDocumentLength

ConstructL(const CStreamStore &, TStreamId)

void ConstructL ( const CStreamStore & aFieldStore,
TStreamId aStreamId
) [protected]

Parameters

const CStreamStore & aFieldStore
TStreamId aStreamId

CopyComponentsL(CStreamStore &, CStoreMap &, TInt, TInt)

IMPORT_C void CopyComponentsL ( CStreamStore & aStore,
CStoreMap & aMap,
TInt aPos,
TInt aLength
) const

Parameters

CStreamStore & aStore
CStoreMap & aMap
TInt aPos
TInt aLength

CopyToArrayL(CArrayFixSeg< TTextFieldEntry > *, TInt, TInt)

void CopyToArrayL ( CArrayFixSeg < TTextFieldEntry > * aArray,
TInt aPos,
TInt aLength
) const [private]

Parameters

CArrayFixSeg < TTextFieldEntry > * aArray
TInt aPos
TInt aLength

CopyToStoreL(CStreamStore &, TInt, TInt)

IMPORT_C TStreamId CopyToStoreL ( CStreamStore & aStore,
TInt aPos,
TInt aLength
) const

Parameters

CStreamStore & aStore
TInt aPos
TInt aLength

CopyToStreamL(RWriteStream &, TInt, TInt)

IMPORT_C void CopyToStreamL ( RWriteStream & aStream,
TInt aPos,
TInt aLength
) const

Parameters

RWriteStream & aStream
TInt aPos
TInt aLength

DeleteFieldEntry(TInt)

void DeleteFieldEntry ( TInt anIndex ) [private]

Parameters

TInt anIndex

DeleteFieldEntry(CArrayFixSeg< TTextFieldEntry > *, TInt)

void DeleteFieldEntry ( CArrayFixSeg < TTextFieldEntry > * aArray,
TInt anIndex
) [private]

Parameters

CArrayFixSeg < TTextFieldEntry > * aArray
TInt anIndex

DoPasteL(CArrayFixSeg< TTextFieldEntry > *, TInt)

void DoPasteL ( CArrayFixSeg < TTextFieldEntry > * aSourceArray,
TInt aPos
) [private]

Parameters

CArrayFixSeg < TTextFieldEntry > * aSourceArray
TInt aPos

DoRestoreFieldsL(CArrayFixSeg< TTextFieldEntry > *, const CStreamStore &, TInt)

void DoRestoreFieldsL ( CArrayFixSeg < TTextFieldEntry > * aArray,
const CStreamStore & aFieldStore,
TInt aStartIndex = 0
) [private]

Parameters

CArrayFixSeg < TTextFieldEntry > * aArray
const CStreamStore & aFieldStore
TInt aStartIndex = 0

DoRestoreL(const CStreamStore &, TStreamId)

void DoRestoreL ( const CStreamStore & aFieldStore,
TStreamId aStreamId
) [private]

Parameters

const CStreamStore & aFieldStore
TStreamId aStreamId

EntryLen(const TTextFieldEntry &)

TInt EntryLen ( const TTextFieldEntry & aEntry ) const [private]

Parameters

const TTextFieldEntry & aEntry

EntryLen(TInt)

TInt EntryLen ( TInt aIndex ) const [private]

Parameters

TInt aIndex

ExternalizeL(RWriteStream &)

IMPORT_C void ExternalizeL ( RWriteStream & aStream ) const

Parameters

RWriteStream & aStream

ExternalizeL(RWriteStream &, CArrayFixSeg< TTextFieldEntry > *)

void ExternalizeL ( RWriteStream & aStream,
CArrayFixSeg < TTextFieldEntry > * aArray
) const [private]

Parameters

RWriteStream & aStream
CArrayFixSeg < TTextFieldEntry > * aArray

FieldCount()

IMPORT_C TInt FieldCount ( ) const

FieldFactory()

IMPORT_C MTextFieldFactory * FieldFactory ( ) const

FindFields(TInt)

IMPORT_C TBool FindFields ( TInt aPos ) const

Parameters

TInt aPos

FindFields(TFindFieldInfo &, TInt, TInt)

IMPORT_C TBool FindFields ( TFindFieldInfo & aInfo,
TInt aPos,
TInt aRange = 0
) const

Parameters

TFindFieldInfo & aInfo
TInt aPos
TInt aRange = 0

InField(const TInt, TInt &, TInt &)

TBool InField ( const TInt aPos,
TInt & anIndex,
TInt & anOffset
) const [private]

Parameters

const TInt aPos
TInt & anIndex
TInt & anOffset

InsertEntryL(TInt, TTextFieldEntry &)

void InsertEntryL ( TInt aIndex,
TTextFieldEntry & aEntry
) [private]

Parameters

TInt aIndex
TTextFieldEntry & aEntry

InsertEntryL(TInt, TTextFieldEntry &, CArrayFixSeg< TTextFieldEntry > *)

void InsertEntryL ( TInt aIndex,
TTextFieldEntry & aEntry,
CArrayFixSeg < TTextFieldEntry > * aArray
) [private]

Parameters

TInt aIndex
TTextFieldEntry & aEntry
CArrayFixSeg < TTextFieldEntry > * aArray

InsertFieldL(TInt, CTextField *, TUid)

IMPORT_C TInt InsertFieldL ( TInt aPos,
CTextField * aField,
TUid aFieldType
)

Parameters

TInt aPos
CTextField * aField
TUid aFieldType

InternalizeL(RReadStream &)

IMPORT_C void InternalizeL ( RReadStream & aStream )

Parameters

RReadStream & aStream

InternalizeL(CArrayFixSeg< TTextFieldEntry > *, RReadStream &)

void InternalizeL ( CArrayFixSeg < TTextFieldEntry > * aArray,
RReadStream & aStream
) [private]

Parameters

CArrayFixSeg < TTextFieldEntry > * aArray
RReadStream & aStream

NewFieldL(TUid)

IMPORT_C CTextField * NewFieldL ( TUid aFieldType )

Parameters

TUid aFieldType

NewFieldValueL(HBufC *&, TInt)

IMPORT_C TInt NewFieldValueL ( HBufC *& aBuf,
TInt aPos
)

Parameters

HBufC *& aBuf
TInt aPos

NewL(TInt)

IMPORT_C CTextFieldSet * NewL ( TInt aDocumentLength = 0 ) [static]

Parameters

TInt aDocumentLength = 0

NewL(const MTextFieldFactory *, const CStreamStore &, TStreamId)

IMPORT_C CTextFieldSet * NewL ( const MTextFieldFactory * aFactory,
const CStreamStore & aStore,
TStreamId aStreamId
) [static]

Parameters

const MTextFieldFactory * aFactory
const CStreamStore & aStore
TStreamId aStreamId

NotifyDeletion(TInt, TInt)

IMPORT_C void NotifyDeletion ( TInt aPos,
TInt aNumberRemoved
)

Parameters

TInt aPos
TInt aNumberRemoved

NotifyFieldUpdate(TInt, TInt)

IMPORT_C void NotifyFieldUpdate ( TInt aPos,
TInt aNewFieldValueLength
)

Parameters

TInt aPos
TInt aNewFieldValueLength

NotifyInsertion(TInt, TInt)

IMPORT_C void NotifyInsertion ( TInt aPos,
TInt aNumberAdded
)

Parameters

TInt aPos
TInt aNumberAdded

PasteComponentsL(const CStreamStore &, TInt)

IMPORT_C void PasteComponentsL ( const CStreamStore & aFieldStore,
TInt aPos
)

Parameters

const CStreamStore & aFieldStore
TInt aPos

PasteFromStoreL(const CStreamStore &, TStreamId, TInt, TInt)

IMPORT_C void PasteFromStoreL ( const CStreamStore & aFieldStore,
TStreamId aStreamId,
TInt aPos,
TInt aMaxLen = ENoPasteLimit
)

Parameters

const CStreamStore & aFieldStore
TStreamId aStreamId
TInt aPos
TInt aMaxLen = ENoPasteLimit

PasteFromStreamL(RReadStream &, TInt, TInt)

IMPORT_C void PasteFromStreamL ( RReadStream & aStream,
TInt aPos,
TInt aMaxLen = ENoPasteLimit
)

Parameters

RReadStream & aStream
TInt aPos
TInt aMaxLen = ENoPasteLimit

RecordRollbackInfoL(TInt)

void RecordRollbackInfoL ( TInt aPastePos ) [private]

Parameters

TInt aPastePos

RemoveField(TInt)

IMPORT_C TInt RemoveField ( TInt aPos )

Parameters

TInt aPos

Reset()

IMPORT_C void Reset ( )

RestoreFieldsL(const CStreamStore &)

IMPORT_C void RestoreFieldsL ( const CStreamStore & aFieldStore )

Parameters

const CStreamStore & aFieldStore

RestoreL(const CStreamStore &, TStreamId)

IMPORT_C void RestoreL ( const CStreamStore & aFieldStore,
TStreamId aStreamId
)

Parameters

const CStreamStore & aFieldStore
TStreamId aStreamId

RollbackPaste()

IMPORT_C void RollbackPaste ( )

SetFieldFactory(MTextFieldFactory *)

IMPORT_C void SetFieldFactory ( MTextFieldFactory * aFactory )

Parameters

MTextFieldFactory * aFactory

SplitEntry(TInt, TInt, TInt)

TTextFieldEntry SplitEntry ( TInt aIndex,
TInt aOffset,
TInt aRange
) const [private]

Parameters

TInt aIndex
TInt aOffset
TInt aRange

StoreFieldsL(CStreamStore &, CStoreMap &)

IMPORT_C void StoreFieldsL ( CStreamStore & aStore,
CStoreMap & aMap
) const

Parameters

CStreamStore & aStore
CStoreMap & aMap

StoreFieldsL(CStreamStore &, CStoreMap &, CArrayFixSeg< TTextFieldEntry > *)

void StoreFieldsL ( CStreamStore & aStore,
CStoreMap & aMap,
CArrayFixSeg < TTextFieldEntry > * aArray
) const [private]

StoreL(CStreamStore &)

IMPORT_C TStreamId StoreL ( CStreamStore & aStore ) const

Parameters

CStreamStore & aStore

TextField(TInt)

IMPORT_C const CTextField * TextField ( TInt aPos ) const

Parameters

TInt aPos

Member Data Documentation

__DECLARE_TEST

__DECLARE_TEST [private]

CArrayFixSeg< TTextFieldEntry > * iFieldArray

CArrayFixSeg < TTextFieldEntry > * iFieldArray [private]

MTextFieldFactory * iFieldFactory

MTextFieldFactory * iFieldFactory [private]

TRollbackInfo * iRollbackInfo

TRollbackInfo * iRollbackInfo [private]