2 * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
4 * This component and the accompanying materials are made available
5 * under the terms of "Eclipse Public License v1.0"
6 * which accompanies this distribution, and is available
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
29 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
30 #include <txtrich_internal.h>
31 #include <txtclipboard.h>
38 class MPictureFactory;
39 class MRichTextStoreResolver;
41 class TCharFormatXMask;
45 class CRichText : public CGlobalText
47 Text with rich formatting.
49 In rich text, each paragraph can have a different paragraph format, and each
50 character can have a different character format.
52 All formatting in a rich text object is based on a global character and
53 paragraph format layer, and a chain of layers on which they may be based. In
54 case of conflict, upper layers override lower layers. These two format layers
55 are specified on construction, and are not owned by the text object. Additional
56 formatting may then be added to any portion of the text. This is called specific
57 formatting and in case of conflict, it overrides the formatting in the global
58 layers. Specific formatting is owned by the text object. So, the effective
59 formatting of a rich text object may be composed of specific formatting and
60 formatting specified in a chain of format layers.
62 Rich text supports styles. A style is a named set of paragraph and character
63 format attributes. Styles are stored in a list which is passed to the rich
64 text object on construction, or which is assigned to the object after
65 construction. Styles can be appended to and removed from the list and existing
66 styles can be modified. Only paragraph styles are supported. This means that
67 styles are applied to entire paragraphs, although both character and paragraph
68 format attributes may be set in the style.
70 Rich text also supports object embedding. Embedded objects are represented
71 in rich text by CPicture-derived objects. A rich text object which supports
72 the display of pictures needs to be supplied with a picture factory.
81 /** Number of paragraphs in the object. */
84 /** The text object will contain a single paragraph. */
86 /** The text object will contain multiple paragraphs. */
90 // Create new rich text component whose sole content is an end-of-document character.
91 IMPORT_C static CRichText* NewL(const CParaFormatLayer* aGlobalParaLayer, const CCharFormatLayer* aGlobalCharLayer,
92 TDocumentStorage aStorage = ESegmentedStorage,
93 TInt aDefaultTextGranularity = EDefaultTextGranularity,
94 TParaType aParaType = EMultiPara);
95 // Create new rich text component, supporting STYLES, whose sole content is an end-of-document character.
96 IMPORT_C static CRichText* NewL(const CParaFormatLayer* aGlobalParaLayer, const CCharFormatLayer* aGlobalCharLayer,
97 const CStyleList& aStyleList,
98 TDocumentStorage aStorage = ESegmentedStorage,
99 TInt aDefaultTextGranularity = EDefaultTextGranularity,
100 TParaType aParaType = EMultiPara);
101 // Restore into new rich text, using the specified global layers.
102 IMPORT_C static CRichText* NewL(const CStreamStore& aStore, TStreamId aStreamId,
103 const CParaFormatLayer* aGlobalParaLayer, const CCharFormatLayer* aGlobalCharLayer,
104 MTextFieldFactory* aFieldFactory = NULL,
105 TDocumentStorage aStorage = ESegmentedStorage);
106 // Restore into new rich text, using the specified layers, store & picture factory.
107 IMPORT_C static CRichText* NewL(const CStreamStore& aStore, TStreamId aStreamId,
108 const CParaFormatLayer* aGlobalParaLayer, const CCharFormatLayer * aGlobalCharLayer,
109 MPictureFactory* aPictureFactory, MRichTextStoreResolver* aStoreResolver,
110 MTextFieldFactory* aFieldFactory = NULL,
111 TDocumentStorage aStorage = ESegmentedStorage);
112 IMPORT_C virtual ~CRichText();
114 // Default persist functions - Deferred loading of pictures
115 IMPORT_C void RestoreWithStyleListL(const CStreamStore& aStore, TStreamId aStreamId, const CStyleList& aExternalStyleList);
117 IMPORT_C virtual void StoreComponentsL(CStreamStore& aStore, CStoreMap& aMap) const;
118 IMPORT_C virtual void RestoreComponentsL(const CStreamStore& aStore);
119 IMPORT_C virtual void ExternalizeL(RWriteStream& aStream) const;
120 IMPORT_C virtual void InternalizeL(RReadStream& aStream);
122 // Custom persist functions
123 IMPORT_C void ExternalizeStyleDataL(RWriteStream& aStream) const;
124 IMPORT_C void InternalizeStyleDataL(RReadStream& aStream);
126 IMPORT_C void StoreMarkupComponentsL(CStreamStore& aStore, CStoreMap& aMap) const;
127 IMPORT_C void ExternalizeMarkupDataL(RWriteStream& aStream) const;
128 IMPORT_C void InternalizeMarkupDataL(RReadStream& aStream);
130 // Utility persist functions
131 IMPORT_C void SetPictureFactory(MPictureFactory* aPictureFactory, MRichTextStoreResolver* aStoreResolver);
132 inline MPictureFactory* PictureFactory() const;
133 inline MRichTextStoreResolver* StoreResolver() const;
134 IMPORT_C TPictureHeader PictureHeader(TInt aPos) const;
135 IMPORT_C void DropPictureOwnership(TInt aPos); // delete picture character. Forget but don't delete picture.
136 IMPORT_C void DetachFromStoreL(CPicture::TDetach aDegree);
137 IMPORT_C void DetachFromStoreL(CPicture::TDetach aDegree, TInt aPos, TInt aLength);
138 IMPORT_C TBool HasMarkupData() const;
141 IMPORT_C virtual void CopyToStoreL(CStreamStore& aStore, CStreamDictionary& aDictionary, TInt aPos, TInt aLength) const;
142 IMPORT_C virtual TInt PasteFromStoreL(const CStreamStore& aStore, const CStreamDictionary& aDictionary, TInt aPos);
143 IMPORT_C TInt PasteFromStoreL(const CStreamStore& aStore, const CStreamDictionary& aDictionary, TInt aPos, CParagraphStyle::TStylePasteMode aStylePasteMode);
145 // Content modifier functions
146 IMPORT_C virtual void Reset();
147 IMPORT_C virtual void InsertL(TInt aPos, const TChar& aChar); // Insert a single character.
148 IMPORT_C virtual void InsertL(TInt aPos, const TDesC& aBuf);
149 IMPORT_C void InsertL(TInt aPos, const TPictureHeader& aHeader); // Insert a picture header.
151 // aPos is the position of the character being deleted, *not* the current cursor position!
152 IMPORT_C virtual TBool DeleteL(TInt aPos, TInt aLength); // Call this for a delete-forward.
154 // Leave-safe delete for removing content from *within* a single paragraph only
155 IMPORT_C void DeleteFromParagraph(TInt aPos, TInt aLength);
157 // Leave-safe delete for removing *entire* paragraphs
158 IMPORT_C void DeleteParagraph(TInt aPos, TInt aLength);
160 // Special behaviour format modifier functions.
161 // Call this when applying a character format to a zero length selection, eg, turning bold on.
162 IMPORT_C void SetInsertCharFormatL(const TCharFormat& aFormat, const TCharFormatMask& aMask, TInt aPos);
164 // Call this on every cursor movement, page up/down etc...
165 IMPORT_C void CancelInsertCharFormat();
167 // Delete content, but preserve phrase format if aPos is at a phrase boundary.
168 // aPos is the position of the character being deleted, *not* the current cursor position!
169 IMPORT_C TBool DelSetInsertCharFormatL(TInt aPos, TInt aLength);
171 // MLaydoc implementation
172 IMPORT_C virtual void GetParagraphFormatL(CParaFormat* aFormat, TInt aPos) const;
173 IMPORT_C virtual void GetChars(TPtrC& aView, TCharFormat& aFormat, TInt aPos) const;
174 IMPORT_C virtual TInt GetPictureSizeInTwips(TSize& aSize, TInt aPos) const;
175 IMPORT_C virtual CPicture* PictureHandleL(TInt aPos, MLayDoc::TForcePictureLoad aForceLoad = MLayDoc::EForceLoadTrue) const;
177 // MFormatText implementation
178 // Used only by dialog writers, since they are not interested in the text, but require knowledge
179 // of attributes whose values change across the specified range.
180 IMPORT_C virtual void GetParaFormatL(CParaFormat* aFormat, TParaFormatMask& aVaries, TInt aPos, TInt aLength,
181 CParaFormat::TParaFormatGetMode aMode = CParaFormat::EAllAttributes) const;
182 IMPORT_C virtual void ApplyParaFormatL(const CParaFormat* aFormat, const TParaFormatMask& aMask, TInt aPos, TInt aLength);
183 IMPORT_C virtual void GetCharFormat(TCharFormat& aFormat, TCharFormatMask& aVaries, TInt aPos, TInt aLength) const;
184 IMPORT_C virtual void ApplyCharFormatL(const TCharFormat& aFormat, const TCharFormatMask& aMask, TInt aPos, TInt aLength);
187 IMPORT_C void GetSpecificCharFormat(TCharFormat& aFormat, TCharFormatMask& aMask, TInt aPos) const;
188 IMPORT_C void GetSpecificCharFormatRight(TCharFormat& aFormat, TCharFormatMask& aMask, TInt aPos) const;
189 IMPORT_C void GetSpecificParagraphFormatL(CParaFormat* aFormat, TParaFormatMask& aMask, TInt aPos) const;
191 // Paragraph style implementation
192 IMPORT_C void ApplyParagraphStyleL(const CParagraphStyle& aStyle, TInt aPos, TInt aLength, CParagraphStyle::TApplyParaStyleMode aMode);
193 inline void NotifyStyleDeletedL(const CParagraphStyle* aStyle);
194 IMPORT_C void NotifyStyleChangedL(const CParagraphStyle* aTo, const CParagraphStyle* aFrom);
195 IMPORT_C const CParaFormatLayer* ParagraphStyle(TBool& aStyleChangesOverRange, TInt aPos, TInt aLength) const;
197 // StyleList implementation
198 inline TBool StyleListPresent() const;
199 inline CStyleList* StyleList() const;
200 inline TInt StyleCount() const;
202 inline void SetStyleListExternallyOwned(TBool aExternallyOwned);
203 IMPORT_C void SetStyleListExternallyOwned(const CStyleList& aStyleList);
204 inline TBool StyleListExternallyOwned() const;
207 IMPORT_C void RemoveSpecificParaFormatL(TInt aPos, TInt aLength);
208 IMPORT_C void RemoveSpecificCharFormatL(TInt aPos, TInt aLength);
209 IMPORT_C TInt PictureCount() const;
210 IMPORT_C virtual TInt ParagraphCount() const;
211 IMPORT_C virtual TInt CharPosOfParagraph(TInt& aLength, TInt aParaOffset) const;
212 IMPORT_C virtual TInt ParagraphNumberForPos(TInt& aPos) const;
213 IMPORT_C virtual TEtextComponentInfo ComponentInfo() const;
215 // Text field implementation
216 IMPORT_C virtual void UpdateFieldL(TInt aPos); // updates the field at aPos
217 // finds number of fields in range. Includes the field containing aPos, if applicable
218 // aInfo is set to the first field in the range (if any are found)
220 // Speciality functions
221 IMPORT_C void AppendTakingSolePictureOwnershipL(const CRichText& aSource);
222 IMPORT_C void AppendParagraphL(TInt aReplicas = 1);
223 IMPORT_C virtual void SetHasChanged(TBool aHasChanged);
225 IMPORT_C void ExtendedInterface(TAny*& aInterface, TUid aInterfaceId); // from CEditableText
227 // non-exported public functions
228 void ApplyExtendedCharFormatL(const TCharFormatX& aFormat, const TCharFormatXMask& aMask, TInt aPos, TInt aLength);
229 void GetExtendedCharFormat(TCharFormatX& aFormat, TCharFormatXMask& aVaries, TInt aPos, TInt aLength) const;
230 void GetTextAndExtendedFormat(TPtrC& aText, TCharFormatX& aFormat, TInt aPos) const;
233 CRichText(const CRichText& aRichText);
234 CRichText& operator=(const CRichText& aRichText);
235 void KillStyleList();
237 TBool CreateEmptyMarkupComponentL();
238 void CreateAndGenerateMarkupComponentL();
239 void GenerateMarkupL();
240 void CompletePastePlainTextL(TInt aPos,TInt aCharacterCount);
241 TInt DoPasteRtFromStoreL(const CStreamStore& aStore, const CStreamDictionary& aDictionary, TInt aPos, CParagraphStyle::TStylePasteMode aStylePasteMode);
242 TBool IndexPresent() const;
243 inline void SetParaTypeIsSingle(TBool aBool);
244 inline TBool ParaTypeIsSingle() const;
245 void SetExtendedInsertCharFormatL(const TCharFormatX& aFormat, const TCharFormatXMask& aMask, TInt aPos);
246 void GetSpecificCharFormatLeftRight(TCharFormat& aFormat,
247 TCharFormatMask& aMask, TInt aPos, TBool aLeft) const;
248 void DoApplyExtendedCharFormatL(const TCharFormatX& aFormat,const TCharFormatXMask& aMask,TInt aPos,TInt aLength);
251 IMPORT_C CRichText(const CParaFormatLayer* aGlobalParaLayer, const CCharFormatLayer* aGlobalCharLayer,
252 CStyleList* aStyleList = NULL);
253 // New constructL's - to be merged post 057
254 IMPORT_C void ConstructL(TDocumentStorage aStorage, TInt aDefaultTextGranularity, TParaType aParaType);
255 IMPORT_C void ConstructL(const CStreamStore& aStore, TStreamId aStreamId, MPictureFactory* aFactory, MRichTextStoreResolver* aStoreResolver,
256 MTextFieldFactory* aFieldFactory=NULL,
257 TDocumentStorage aStorage = ESegmentedStorage);
259 void InternalizeL(RReadStream& aStream, const CStyleList* aExternalStyleList);
260 IMPORT_C void DoExternalizeStyleDataL(RWriteStream& aStream) const;
261 IMPORT_C void DoInternalizeStyleDataL(RReadStream& aStream);
262 void DoInternalizeStyleDataL(RReadStream& aStream, const CStyleList* aExternalStyleList);
263 IMPORT_C void DoExternalizeMarkupDataL(RWriteStream& aStream) const;
264 IMPORT_C void DoInternalizeMarkupDataL(RReadStream& aStream);
265 void StoreStylesL(CStreamStore& aStore,CStoreMap& aMap) const;
266 void RestoreStylesL(const CStreamStore& aStore, TStreamId aId, const CParaFormatLayer* aParaFormatLayer, const CCharFormatLayer* aCharFormatLayer);
267 void StoreMarkupL(CStreamStore& aStore,CStoreMap& aMap)const;
269 IMPORT_C void RtInsertL(TInt aPos,const TDesC& aBuf);
271 TStreamId DoCopyToStoreL(CStreamStore& aStore, TInt aPos, TInt aLength, TStreamId aGlobalTextId, TBool aCopyStyles) const;
272 IMPORT_C void CopyComponentsL(CStreamStore& aStore, CStoreMap& aMap, TInt aPos,TInt aLength, TStreamId aGlobalTextId) const;
273 IMPORT_C void CopyToStreamL(RWriteStream& aStream, TInt aPos, TInt aLength, TStreamId aGlobalTextId) const;
274 IMPORT_C void CopyToStreamL(RWriteStream& aStream, TInt aPos, TInt aLength) const;
275 void CopyToStreamL(RWriteStream& aStream, TInt aPos, TInt aLength, TStreamId aGlobalTextId, TBool aCopyStyles) const;
276 TInt PasteRichTextFromStoreL(const CStreamStore& aStore, const CStreamDictionary& aDictionary, TStreamId& anId, TInt aPos, CParagraphStyle::TStylePasteMode aStylePasteMode);
277 void CompletePasteRichTextFromStoreL(const CStreamStore& aStore, TStreamId& aRichTextStreamId, TInt aPos, CParagraphStyle::TStylePasteMode aStylePasteMode);
278 TInt PastePlainTextFromStoreL(const CStreamStore& aStore, TStreamId& anId, TInt aPos);
281 void PrepareAppendMarkupL(const CRichText& aSource);
282 void DoAppendTakingSolePictureOwnershipL(const CRichText& aSource);
284 IMPORT_C static void ActivateParserL(MParser* aParser); // Switch on a particular parser
285 IMPORT_C static void DeactivateParser(MParser* aParser); // Switch off a particular parser
286 IMPORT_C static void ActivateDefaultParserL(MParser* aParser); // Switch on a default parser
287 IMPORT_C static void DeactivateParserDefaults(); // Switch off default set (if any)
288 // and delete EText TLS
290 IMPORT_C void SetEditObserver(MEditObserver* aEditObserver);
291 IMPORT_C TBool ParseText(TInt& aStartOfTags, TInt& aLength, TBool aForceScanAllText);
292 IMPORT_C TBool CursorOverTag(TInt aPos, MParser*& aParser, TInt& aTagStart, TInt& aLength) const;
293 // Next tag (forwards), any or specific parser
294 IMPORT_C TInt PositionOfNextTag(TInt aPos) const;
295 IMPORT_C TInt PositionOfNextTag(TInt aPos, const MParser* aParser) const;
296 // Prev tag (backwards), any or specific parser
297 IMPORT_C TInt PositionOfPrevTag(TInt aPos) const;
298 IMPORT_C TInt PositionOfPrevTag(TInt aPos, const MParser* aParser) const;
301 static void CreateParserETextTLSL();
302 TBool DoCursorOverTag(TInt aPos, MParser*& aParser, TInt& aTagStart, TInt& aLength) const;
303 void OverrideFormatForParsersIfApplicable(TPtrC& aText, TCharFormatX& aFormat, TInt aStartPos) const;
304 void CallEditObserver(TInt aStart, TInt aExtent) const;
307 enum {EDelimiterCharacterLength = 1};
309 TSwizzle<CStyleList> iStyleList;
310 TSwizzle<CRichTextIndex> iIndex;
312 MPictureFactory* iPictureFactory;
313 MRichTextStoreResolver* iStoreResolver;
315 CParserData* iParserData;
319 __DECLARE_TEST; // Index consistency check with document length.
323 #include <txtrich.inl>