williamr@2: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). williamr@2: // All rights reserved. williamr@2: // This component and the accompanying materials are made available williamr@2: // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members williamr@2: // which accompanies this distribution, and is available williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". williamr@2: // williamr@2: // Initial Contributors: williamr@2: // Nokia Corporation - initial contribution. williamr@2: // williamr@2: // Contributors: williamr@2: // williamr@2: // Description: williamr@2: // williamr@2: williamr@2: #ifndef __FLDSET_H__ williamr@2: #define __FLDSET_H__ williamr@2: williamr@2: #include williamr@2: #include williamr@2: #include williamr@2: #include williamr@2: #include williamr@2: williamr@2: // williamr@2: // Classes declared in this file williamr@2: class CTextFieldSet; williamr@2: // williamr@2: // Classes referenced williamr@2: class RReadStream; williamr@2: class RWriteStream; williamr@2: class TTextFieldEntry; williamr@2: class CStreamStore; williamr@2: class CStoreMap; williamr@2: class TRollbackInfo; williamr@2: williamr@2: /** williamr@2: @internalComponent williamr@2: */ williamr@2: const TInt KFieldArrayGranularity=1; williamr@2: williamr@2: williamr@2: class CTextFieldSet : public CBase williamr@2: /** williamr@2: The engine that keeps the field table up to date williamr@2: @internalComponent williamr@2: */ williamr@2: { williamr@2: public: williamr@2: enum {ENoPasteLimit=-1}; williamr@2: public: williamr@2: IMPORT_C static CTextFieldSet* NewL(TInt aDocumentLength=0); williamr@2: IMPORT_C static CTextFieldSet* NewL(const MTextFieldFactory* aFactory,const CStreamStore& aStore,TStreamId aStreamId); williamr@2: IMPORT_C ~CTextFieldSet(); williamr@2: // williamr@2: // Factory functions williamr@2: IMPORT_C void SetFieldFactory(MTextFieldFactory* aFactory); williamr@2: IMPORT_C MTextFieldFactory* FieldFactory()const; williamr@2: // williamr@2: IMPORT_C void Reset(); // removes all fields from the array and reinitialises field array williamr@2: // williamr@2: // Persistence williamr@2: IMPORT_C TStreamId StoreL(CStreamStore& aStore)const; williamr@2: IMPORT_C void RestoreL(const CStreamStore& aFieldStore,TStreamId aStreamId); williamr@2: // williamr@2: // Component persistence williamr@2: IMPORT_C void StoreFieldsL(CStreamStore& aStore,CStoreMap& aMap)const; williamr@2: IMPORT_C void RestoreFieldsL(const CStreamStore& aFieldStore); williamr@2: // williamr@2: // Headstream persistence williamr@2: IMPORT_C void InternalizeL(RReadStream& aStream); williamr@2: IMPORT_C void ExternalizeL(RWriteStream& aStream)const; williamr@2: // Cut/Paste williamr@2: IMPORT_C TStreamId CopyToStoreL(CStreamStore& aStore,TInt aPos,TInt aLength)const; williamr@2: IMPORT_C void CopyComponentsL(CStreamStore& aStore,CStoreMap& aMap,TInt aPos,TInt aLength)const; williamr@2: IMPORT_C void CopyToStreamL(RWriteStream& aStream,TInt aPos,TInt aLength)const; williamr@2: IMPORT_C void PasteFromStoreL(const CStreamStore& aFieldStore,TStreamId aStreamId,TInt aPos,TInt aMaxLen=ENoPasteLimit); williamr@2: IMPORT_C void PasteComponentsL(const CStreamStore& aFieldStore,TInt aPos); williamr@2: IMPORT_C void PasteFromStreamL(RReadStream& aStream,TInt aPos,TInt aMaxLen=ENoPasteLimit); williamr@2: // Insert/Remove field williamr@2: IMPORT_C CTextField* NewFieldL(TUid aFieldType); williamr@2: IMPORT_C TInt InsertFieldL(TInt aPos,CTextField* aField,TUid aFieldType); // inserts a field (including text) into doc (returns error num if it fails) williamr@2: IMPORT_C TInt RemoveField(TInt aPos); // remove the field aPos is in williamr@2: IMPORT_C TInt NewFieldValueL(HBufC*& aBuf, TInt aPos); // returns new value of the field in aBuf (or returns false if aPos not in field) williamr@2: // Update field set williamr@2: IMPORT_C void NotifyInsertion(TInt aPos, TInt aNumberAdded); williamr@2: IMPORT_C void NotifyDeletion(TInt aPos, TInt aNumberRemoved); williamr@2: IMPORT_C void NotifyFieldUpdate(TInt aPos, TInt aNewFieldValueLength); williamr@2: // Utilities williamr@2: IMPORT_C TInt FieldCount() const; // returns total number of fields in document williamr@2: IMPORT_C TInt CharCount() const; // returns num characters in the document (according to fields) williamr@2: IMPORT_C TBool FindFields(TInt aPos) const; // Returns ETrue if aPos is in a field williamr@2: IMPORT_C TBool FindFields(TFindFieldInfo& aInfo,TInt aPos,TInt aRange=0) const; // finds num fields at least partly in range. Returns true if aPos is in field, and returns info on the first field in aRange williamr@2: IMPORT_C const CTextField* TextField(TInt aPos)const; williamr@2: // Rollback williamr@2: IMPORT_C void RollbackPaste(); // call to carry out rollback if a paste goes wrong williamr@2: protected: williamr@2: CTextFieldSet(); williamr@2: void ConstructL(TInt aDocumentLength); williamr@2: void ConstructL(const CStreamStore& aFieldStore,TStreamId aStreamId); williamr@2: private: williamr@2: // persistence williamr@2: void StoreFieldsL(CStreamStore& aStore,CStoreMap& aMap,CArrayFixSeg* aArray)const; williamr@2: void DoRestoreL(const CStreamStore& aFieldStore,TStreamId aStreamId); williamr@2: void DoRestoreFieldsL(CArrayFixSeg* aArray,const CStreamStore& aFieldStore,TInt aStartIndex=0); williamr@2: void InternalizeL(CArrayFixSeg* aArray,RReadStream& aStream); williamr@2: void ExternalizeL(RWriteStream& aStream,CArrayFixSeg* aArray)const; williamr@2: void DoPasteL(CArrayFixSeg* aSourceArray,TInt aPos); williamr@2: // utility functions williamr@2: void AddInitialFieldEntryL(CArrayFixSeg* aArray,TInt aDocumentLength); // used to initialise the array williamr@2: void InsertEntryL(TInt aIndex,TTextFieldEntry& aEntry); // inserts into iFieldArray williamr@2: void InsertEntryL(TInt aIndex,TTextFieldEntry& aEntry,CArrayFixSeg* aArray); williamr@2: void AppendEntryL(TTextFieldEntry& aEntry); // appends into iFieldArray williamr@2: void AppendEntryL(TTextFieldEntry& aEntry,CArrayFixSeg* aArray); williamr@2: void CopyToArrayL(CArrayFixSeg* aArray,TInt aPos,TInt aLength)const; williamr@2: TBool InField(const TInt aPos, TInt& anIndex, TInt& anOffset) const; // anOffset set to distance into field or gap williamr@2: void DeleteFieldEntry(TInt anIndex); williamr@2: void DeleteFieldEntry(CArrayFixSeg* aArray,TInt anIndex); williamr@2: TTextFieldEntry SplitEntry(TInt aIndex,TInt aOffset,TInt aRange)const; williamr@2: TInt EntryLen(const TTextFieldEntry& aEntry)const; williamr@2: TInt EntryLen(TInt aIndex)const; williamr@2: // rollback williamr@2: void RecordRollbackInfoL(TInt aPastePos); williamr@2: private: williamr@2: MTextFieldFactory* iFieldFactory; williamr@2: CArrayFixSeg* iFieldArray; // Array of fields in the document williamr@2: TRollbackInfo* iRollbackInfo; williamr@2: __DECLARE_TEST; williamr@2: }; williamr@2: williamr@2: class TFieldMapExternalizer : public MExternalizer williamr@2: /** williamr@2: Allows NULL streams id's to be written out williamr@2: when no reference is found in a store map. williamr@2: @internalComponent williamr@2: */ williamr@2: { williamr@2: private: williamr@2: friend class CPlainText; williamr@2: friend class CTextFieldSet; williamr@2: private: williamr@2: IMPORT_C TFieldMapExternalizer(const CStoreMap& aMap); williamr@2: IMPORT_C void ExternalizeL(const TStreamRef& anObject,RWriteStream& aStream) const; williamr@2: private: williamr@2: const CStoreMap* iMap; williamr@2: }; williamr@2: williamr@2: #endif