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