1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/textandloc/textrendering/texthandling/inc/FLDSET.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,151 @@
1.4 +/*
1.5 +* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +#ifndef __FLDSET_H__
1.23 +#define __FLDSET_H__
1.24 +
1.25 +#include <e32std.h>
1.26 +#include <e32base.h>
1.27 +#include <fldinfo.h>
1.28 +#include <fldbase.h>
1.29 +#include <fldbltin.h>
1.30 +
1.31 +//
1.32 +// Classes declared in this file
1.33 +class CTextFieldSet;
1.34 +//
1.35 +// Classes referenced
1.36 +class RReadStream;
1.37 +class RWriteStream;
1.38 +class TTextFieldEntry;
1.39 +class CStreamStore;
1.40 +class CStoreMap;
1.41 +class TRollbackInfo;
1.42 +
1.43 +/**
1.44 +@internalComponent
1.45 +*/
1.46 +const TInt KFieldArrayGranularity=1;
1.47 +
1.48 +
1.49 +class CTextFieldSet : public CBase
1.50 +/**
1.51 +The engine that keeps the field table up to date
1.52 +@internalComponent
1.53 +*/
1.54 + {
1.55 +public:
1.56 + enum {ENoPasteLimit=-1};
1.57 +public:
1.58 + IMPORT_C static CTextFieldSet* NewL(TInt aDocumentLength=0);
1.59 + IMPORT_C static CTextFieldSet* NewL(const MTextFieldFactory* aFactory,const CStreamStore& aStore,TStreamId aStreamId);
1.60 + IMPORT_C ~CTextFieldSet();
1.61 + //
1.62 + // Factory functions
1.63 + IMPORT_C void SetFieldFactory(MTextFieldFactory* aFactory);
1.64 + IMPORT_C MTextFieldFactory* FieldFactory()const;
1.65 + //
1.66 + IMPORT_C void Reset(); // removes all fields from the array and reinitialises field array
1.67 + //
1.68 + // Persistence
1.69 + IMPORT_C TStreamId StoreL(CStreamStore& aStore)const;
1.70 + IMPORT_C void RestoreL(const CStreamStore& aFieldStore,TStreamId aStreamId);
1.71 + //
1.72 + // Component persistence
1.73 + IMPORT_C void StoreFieldsL(CStreamStore& aStore,CStoreMap& aMap)const;
1.74 + IMPORT_C void RestoreFieldsL(const CStreamStore& aFieldStore);
1.75 + //
1.76 + // Headstream persistence
1.77 + IMPORT_C void InternalizeL(RReadStream& aStream);
1.78 + IMPORT_C void ExternalizeL(RWriteStream& aStream)const;
1.79 + // Cut/Paste
1.80 + IMPORT_C TStreamId CopyToStoreL(CStreamStore& aStore,TInt aPos,TInt aLength)const;
1.81 + IMPORT_C void CopyComponentsL(CStreamStore& aStore,CStoreMap& aMap,TInt aPos,TInt aLength)const;
1.82 + IMPORT_C void CopyToStreamL(RWriteStream& aStream,TInt aPos,TInt aLength)const;
1.83 + IMPORT_C void PasteFromStoreL(const CStreamStore& aFieldStore,TStreamId aStreamId,TInt aPos,TInt aMaxLen=ENoPasteLimit);
1.84 + IMPORT_C void PasteComponentsL(const CStreamStore& aFieldStore,TInt aPos);
1.85 + IMPORT_C void PasteFromStreamL(RReadStream& aStream,TInt aPos,TInt aMaxLen=ENoPasteLimit);
1.86 + // Insert/Remove field
1.87 + IMPORT_C CTextField* NewFieldL(TUid aFieldType);
1.88 + IMPORT_C TInt InsertFieldL(TInt aPos,CTextField* aField,TUid aFieldType); // inserts a field (including text) into doc (returns error num if it fails)
1.89 + IMPORT_C TInt RemoveField(TInt aPos); // remove the field aPos is in
1.90 + IMPORT_C TInt NewFieldValueL(HBufC*& aBuf, TInt aPos); // returns new value of the field in aBuf (or returns false if aPos not in field)
1.91 + // Update field set
1.92 + IMPORT_C void NotifyInsertion(TInt aPos, TInt aNumberAdded);
1.93 + IMPORT_C void NotifyDeletion(TInt aPos, TInt aNumberRemoved);
1.94 + IMPORT_C void NotifyFieldUpdate(TInt aPos, TInt aNewFieldValueLength);
1.95 + // Utilities
1.96 + IMPORT_C TInt FieldCount() const; // returns total number of fields in document
1.97 + IMPORT_C TInt CharCount() const; // returns num characters in the document (according to fields)
1.98 + IMPORT_C TBool FindFields(TInt aPos) const; // Returns ETrue if aPos is in a field
1.99 + 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
1.100 + IMPORT_C const CTextField* TextField(TInt aPos)const;
1.101 + // Rollback
1.102 + IMPORT_C void RollbackPaste(); // call to carry out rollback if a paste goes wrong
1.103 +protected:
1.104 + CTextFieldSet();
1.105 + void ConstructL(TInt aDocumentLength);
1.106 + void ConstructL(const CStreamStore& aFieldStore,TStreamId aStreamId);
1.107 +private:
1.108 + // persistence
1.109 + void StoreFieldsL(CStreamStore& aStore,CStoreMap& aMap,CArrayFixSeg<TTextFieldEntry>* aArray)const;
1.110 + void DoRestoreL(const CStreamStore& aFieldStore,TStreamId aStreamId);
1.111 + void DoRestoreFieldsL(CArrayFixSeg<TTextFieldEntry>* aArray,const CStreamStore& aFieldStore,TInt aStartIndex=0);
1.112 + void InternalizeL(CArrayFixSeg<TTextFieldEntry>* aArray,RReadStream& aStream);
1.113 + void ExternalizeL(RWriteStream& aStream,CArrayFixSeg<TTextFieldEntry>* aArray)const;
1.114 + void DoPasteL(CArrayFixSeg<TTextFieldEntry>* aSourceArray,TInt aPos);
1.115 + // utility functions
1.116 + void AddInitialFieldEntryL(CArrayFixSeg<TTextFieldEntry>* aArray,TInt aDocumentLength); // used to initialise the array
1.117 + void InsertEntryL(TInt aIndex,TTextFieldEntry& aEntry); // inserts into iFieldArray
1.118 + void InsertEntryL(TInt aIndex,TTextFieldEntry& aEntry,CArrayFixSeg<TTextFieldEntry>* aArray);
1.119 + void AppendEntryL(TTextFieldEntry& aEntry); // appends into iFieldArray
1.120 + void AppendEntryL(TTextFieldEntry& aEntry,CArrayFixSeg<TTextFieldEntry>* aArray);
1.121 + void CopyToArrayL(CArrayFixSeg<TTextFieldEntry>* aArray,TInt aPos,TInt aLength)const;
1.122 + TBool InField(const TInt aPos, TInt& anIndex, TInt& anOffset) const; // anOffset set to distance into field or gap
1.123 + void DeleteFieldEntry(TInt anIndex);
1.124 + void DeleteFieldEntry(CArrayFixSeg<TTextFieldEntry>* aArray,TInt anIndex);
1.125 + TTextFieldEntry SplitEntry(TInt aIndex,TInt aOffset,TInt aRange)const;
1.126 + TInt EntryLen(const TTextFieldEntry& aEntry)const;
1.127 + TInt EntryLen(TInt aIndex)const;
1.128 + // rollback
1.129 + void RecordRollbackInfoL(TInt aPastePos);
1.130 +private:
1.131 + MTextFieldFactory* iFieldFactory;
1.132 + CArrayFixSeg<TTextFieldEntry>* iFieldArray; // Array of fields in the document
1.133 + TRollbackInfo* iRollbackInfo;
1.134 + __DECLARE_TEST;
1.135 + };
1.136 +
1.137 +class TFieldMapExternalizer : public MExternalizer<TStreamRef>
1.138 +/**
1.139 +Allows NULL streams id's to be written out
1.140 +when no reference is found in a store map.
1.141 +@internalComponent
1.142 +*/
1.143 + {
1.144 +private:
1.145 + friend class CPlainText;
1.146 + friend class CTextFieldSet;
1.147 +private:
1.148 + IMPORT_C TFieldMapExternalizer(const CStoreMap& aMap);
1.149 + IMPORT_C void ExternalizeL(const TStreamRef& anObject,RWriteStream& aStream) const;
1.150 +private:
1.151 + const CStoreMap* iMap;
1.152 + };
1.153 +
1.154 +#endif