1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/textandloc/textrendering/texthandling/stext/TXTRICH.CPP Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,2140 @@
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 +#include <e32std.h>
1.23 +#include <e32base.h>
1.24 +
1.25 +#include "TXTRICH.H"
1.26 +#include "TXTINDEX.H"
1.27 +#include "TXTSTD.H"
1.28 +#include "TXTRTPFL.H"
1.29 +#include "ParseLst.h"
1.30 +#include "TXTCLIPBOARD.H"
1.31 +
1.32 +#include "OstTraceDefinitions.h"
1.33 +#ifdef OST_TRACE_COMPILER_IN_USE
1.34 +#include "TXTRICHTraces.h"
1.35 +#endif
1.36 +
1.37 +#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
1.38 +#include "TXTETEXT_INTERNAL.H"
1.39 +#include "TXTRICH_INTERNAL.H"
1.40 +#endif
1.41 +
1.42 +EXPORT_C void CRichText::__DbgTestInvariant()const
1.43 +// Provides class invariants. Explanations below:
1.44 +//
1.45 + {
1.46 +#ifdef _DEBUG
1.47 +// ASSERT: The global format layers are never null.
1.48 + if (iGlobalParaFormatLayer == NULL)
1.49 + {
1.50 + OstTrace0( TRACE_DUMP, CRICHTEXT_DBGTESTINVARIANT, "Invariant" );
1.51 + }
1.52 + __ASSERT_DEBUG(iGlobalParaFormatLayer != NULL, User::Invariant());
1.53 + if (iGlobalCharFormatLayer == NULL)
1.54 + {
1.55 + OstTrace0( TRACE_DUMP, DUP1_CRICHTEXT_DBGTESTINVARIANT, "Invariant" );
1.56 + }
1.57 + __ASSERT_DEBUG(iGlobalCharFormatLayer != NULL, User::Invariant());
1.58 + if (IndexPresent())
1.59 + {
1.60 +// ASSERT: The sum of para lengths == the length as described by the document storage.
1.61 + TInt cumulativeParaLength = 0;
1.62 + TInt maxPara = iIndex->iParaIx->Count();
1.63 + for (TInt offset = 0; offset < maxPara; offset++)
1.64 + {
1.65 + TParaAttribsEntry entry = (*iIndex->iParaIx)[offset];
1.66 + cumulativeParaLength += entry.iLength;
1.67 + }
1.68 + if (cumulativeParaLength != (DocumentLength() + 1))
1.69 + {
1.70 + OstTrace0( TRACE_DUMP, DUP2_CRICHTEXT_DBGTESTINVARIANT, "Invariant" );
1.71 + }
1.72 + __ASSERT_DEBUG(cumulativeParaLength == (DocumentLength() + 1), User::Invariant());
1.73 + }
1.74 + // Change here for defect INC005336.
1.75 + // This defect is present when the assertion below fails.
1.76 + if ((iParserData != NULL) &&
1.77 + (iParserData->HaveRange()) &&
1.78 + (iParserData->EndParse() > DocumentLength()))
1.79 + {
1.80 + OstTrace0( TRACE_DUMP, DUP3_CRICHTEXT_DBGTESTINVARIANT, "Invariant" );
1.81 + }
1.82 + __ASSERT_DEBUG( (iParserData == NULL) || \
1.83 + (!iParserData->HaveRange()) || \
1.84 + (iParserData->EndParse() <= DocumentLength()), User::Invariant());
1.85 +#endif
1.86 + }
1.87 +
1.88 +EXPORT_C CRichText* CRichText::NewL(const CParaFormatLayer* aGlobalParaLayer,const CCharFormatLayer* aGlobalCharLayer,
1.89 + TDocumentStorage aStorage,TInt aDefaultTextGranularity,TParaType aParaType)
1.90 +/** Allocates and constructs an empty rich text object, with a global character
1.91 +and paragraph format layer. A single end-of-document delimiter is inserted.
1.92 +No style list is allocated.
1.93 +
1.94 +@param aGlobalParaLayer Pointer to the paragraph format layer referenced by
1.95 +the rich text object. Must not be NULL, or a panic occurs.
1.96 +@param aGlobalCharLayer Pointer to the character format layer referenced by
1.97 +the rich text object. Must not be NULL, or a panic occurs.
1.98 +@param aStorage The type of in-memory buffer to use. Defaults to ESegmentedStorage
1.99 +which should rarely need to be changed.
1.100 +@param aDefaultTextGranularity Specifies the granularity of the in-memory buffer.
1.101 +Default is EDefaultTextGranularity bytes (=256), and this should rarely need
1.102 +to be changed.
1.103 +@param aParaType This argument indicates whether you are using a single paragraph
1.104 +or multiple paragraphs, and thus affects the granularity of aggregate objects
1.105 +used internally for storing paragraph attributes. Default = EMultiPara.
1.106 +@return The rich text object. */
1.107 + {
1.108 + // Create new rich text containing just a single end-of-document character.
1.109 + if (aGlobalParaLayer == NULL)
1.110 + {
1.111 + OstTrace0( TRACE_FATAL, CRICHTEXT_NEWL, "ENullFormatLayerHandle" );
1.112 + }
1.113 + __ASSERT_ALWAYS(aGlobalParaLayer != NULL, Panic(ENullFormatLayerHandle));
1.114 + if (aGlobalCharLayer == NULL)
1.115 + {
1.116 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_NEWL, "ENullFormatLayerHandle" );
1.117 + }
1.118 + __ASSERT_ALWAYS(aGlobalCharLayer != NULL, Panic(ENullFormatLayerHandle));
1.119 +
1.120 + CRichText* self = new(ELeave) CRichText(aGlobalParaLayer, aGlobalCharLayer);
1.121 + CleanupStack::PushL(self);
1.122 + self->ConstructL(aStorage, aDefaultTextGranularity, aParaType);
1.123 + CleanupStack::Pop();
1.124 + return self;
1.125 + }
1.126 +
1.127 +
1.128 +// Create new rich text that supports Paragraph Styles, containing just a single end-of-document character.
1.129 +EXPORT_C CRichText* CRichText::NewL(const CParaFormatLayer* aGlobalParaLayer,const CCharFormatLayer* aGlobalCharLayer,
1.130 + const CStyleList& aStyleList,
1.131 + TDocumentStorage aStorage,TInt aDefaultTextGranularity,TParaType aParaType)
1.132 +/** Allocates and constructs an empty rich text object which supports styles. It
1.133 +is constructed with a global character and paragraph format layer and a style
1.134 +list. A single end-of-document delimiter is inserted. The rich text object
1.135 +takes ownership of the style list.
1.136 +
1.137 +Note:
1.138 +
1.139 +A rich text object not constructed with a style list may still use styles,
1.140 +by calling SetStyleListExternallyOwned() at any time after construction. In
1.141 +this case, the rich text object does not own the style list.
1.142 +
1.143 +@param aGlobalParaLayer Pointer to the paragraph format layer referenced by
1.144 +the rich text object. Must not be NULL, or a panic occurs.
1.145 +@param aGlobalCharLayer Pointer to the character format layer referenced by
1.146 +the rich text object. Must not be NULL, or a panic occurs.
1.147 +@param aStyleList Style list. Holds the set of paragraph styles which can be
1.148 +used in the rich text object.
1.149 +@param aStorage The type of in-memory buffer to use. Defaults to ESegmentedStorage
1.150 +which should rarely need to be changed.
1.151 +@param aDefaultTextGranularity Specifies the granularity of the in-memory buffer.
1.152 +Default is EDefaultTextGranularity bytes (=256), and this should rarely need
1.153 +to be changed.
1.154 +@param aParaType This argument indicates whether you are using a single paragraph
1.155 +or multiple paragraphs, and thus affects the granularity of aggregate objects
1.156 +used internally for storing paragraph attributes. Default = EMultiPara.
1.157 +@return The new rich text object. */
1.158 + {
1.159 + if (aGlobalParaLayer == NULL)
1.160 + {
1.161 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_NEWL, "ENullFormatLayerHandle" );
1.162 + }
1.163 + __ASSERT_ALWAYS(aGlobalParaLayer != NULL, Panic(ENullFormatLayerHandle));
1.164 + if (aGlobalCharLayer == NULL)
1.165 + {
1.166 + OstTrace0( TRACE_FATAL, DUP3_CRICHTEXT_NEWL, "ENullFormatLayerHandle" );
1.167 + }
1.168 + __ASSERT_ALWAYS(aGlobalCharLayer != NULL, Panic(ENullFormatLayerHandle));
1.169 +
1.170 + CRichText* self = new(ELeave) CRichText(aGlobalParaLayer, aGlobalCharLayer, CONST_CAST(CStyleList*, &aStyleList));
1.171 + CleanupStack::PushL(self);
1.172 + self->ConstructL(aStorage, aDefaultTextGranularity, aParaType);
1.173 + CleanupStack::Pop();
1.174 + return self;
1.175 + }
1.176 +
1.177 +
1.178 +// Restore into a new rich text object, using the specified global layers.
1.179 +EXPORT_C CRichText* CRichText::NewL(const CStreamStore& aStore,TStreamId aStreamId,
1.180 + const CParaFormatLayer* aGlobalParaLayer,const CCharFormatLayer* aGlobalCharLayer,
1.181 + MTextFieldFactory* aFieldFactory,
1.182 + TDocumentStorage aStorage)
1.183 +/** Allocates and constructs a rich text object with a field factory. Its text
1.184 +content is internalized from a stream store.
1.185 +
1.186 +Note:
1.187 +
1.188 +A rich text object not constructed with a field factory may still support
1.189 +the addition of fields, by calling SetFieldFactory(), defined in the base
1.190 +class CPlainText.
1.191 +
1.192 +@param aStore Stream store from which the object is restored.
1.193 +@param aStreamId ID of the stream store.
1.194 +@param aGlobalParaLayer Pointer to the paragraph format layer referenced by
1.195 +the rich text object. Must not be NULL, or a panic occurs.
1.196 +@param aGlobalCharLayer Pointer to the character format layer referenced by
1.197 +the rich text object. Must not be NULL, or a panic occurs.
1.198 +@param aFieldFactory Pointer to a field factory. A field factory must be provided
1.199 +if the text object supports fields.
1.200 +@param aStorage The type of in-memory buffer to use. Defaults to ESegmentedStorage
1.201 +which should rarely need to be changed.
1.202 +@return The new rich text object. */
1.203 + {
1.204 + if (aGlobalParaLayer == NULL)
1.205 + {
1.206 + OstTrace0( TRACE_FATAL, DUP4_CRICHTEXT_NEWL, "ENullFormatLayerHandle" );
1.207 + }
1.208 + __ASSERT_ALWAYS(aGlobalParaLayer != NULL, Panic(ENullFormatLayerHandle));
1.209 + if (aGlobalCharLayer == NULL)
1.210 + {
1.211 + OstTrace0( TRACE_FATAL, DUP5_CRICHTEXT_NEWL, "ENullFormatLayerHandle" );
1.212 + }
1.213 + __ASSERT_ALWAYS(aGlobalCharLayer != NULL, Panic(ENullFormatLayerHandle));
1.214 +
1.215 + CRichText* self = new(ELeave) CRichText(aGlobalParaLayer, aGlobalCharLayer);
1.216 + CleanupStack::PushL(self);
1.217 + self->ConstructL(aStore, aStreamId, NULL, NULL, aFieldFactory, aStorage);
1.218 + CleanupStack::Pop();
1.219 + return self;
1.220 + }
1.221 +
1.222 +
1.223 +EXPORT_C CRichText* CRichText::NewL(const CStreamStore& aStore, TStreamId aStreamId,
1.224 + const CParaFormatLayer* aGlobalParaLayer, const CCharFormatLayer* aGlobalCharLayer,
1.225 + MPictureFactory* aPictureFactory, MRichTextStoreResolver* aStoreResolver,
1.226 + MTextFieldFactory* aFieldFactory,
1.227 + TDocumentStorage aStorage)
1.228 +/** Allocates and constructs a rich text object with a field factory and a picture
1.229 +factory. Its text content is internalized from a stream store.
1.230 +
1.231 +Note:
1.232 +
1.233 +A rich text object not constructed with a field factory may still support
1.234 +the addition of fields, by calling SetFieldFactory(), defined in the base
1.235 +class CPlainText.
1.236 +
1.237 +@param aStore Stream store from which the object is restored.
1.238 +@param aStreamId ID of the stream store.
1.239 +@param aGlobalParaLayer Pointer to the paragraph format layer referenced by
1.240 +the rich text object. Must not be NULL, or a panic occurs.
1.241 +@param aGlobalCharLayer Pointer to the character format layer referenced by
1.242 +the rich text object. Must not be NULL, or a panic occurs.
1.243 +@param aPictureFactory The picture factory. This is needed to load pictures
1.244 +into memory, (see PictureHandleL()). If a store resolver is specified (not
1.245 +NULL), then a factory must also be specified, or a panic occurs.
1.246 +@param aStoreResolver A store resolver. This determines which file store the
1.247 +picture is stored in. It is used to get from a reference to an embedded picture
1.248 +within a CRichText object to the actual picture itself. Picture loading is
1.249 +done by the picture factory.
1.250 +@param aFieldFactory Pointer to a field factory. A field factory must be provided
1.251 +if the text object supports fields.
1.252 +@param aStorage The type of in-memory buffer to use. Defaults to ESegmentedStorage
1.253 +which should rarely need to be changed.
1.254 +@return The new rich text object. */
1.255 + {
1.256 + // Restore a new rich text from the specified stream, that uses the specified global layers, and the
1.257 + // specified picture header factory and store, if this rich text supports pictures.
1.258 + if (!aPictureFactory && aStoreResolver)
1.259 + {
1.260 + OstTrace0( TRACE_FATAL, DUP6_CRICHTEXT_NEWL, "EInvalidPictureFactorySettings" );
1.261 + }
1.262 + __ASSERT_ALWAYS(!(!aPictureFactory && aStoreResolver), Panic(EInvalidPictureFactorySettings));
1.263 + if (aGlobalParaLayer == NULL)
1.264 + {
1.265 + OstTrace0( TRACE_FATAL, DUP7_CRICHTEXT_NEWL, "ENullFormatLayerHandle" );
1.266 + }
1.267 + __ASSERT_ALWAYS(aGlobalParaLayer != NULL, Panic(ENullFormatLayerHandle));
1.268 + if (aGlobalCharLayer == NULL)
1.269 + {
1.270 + OstTrace0( TRACE_FATAL, DUP8_CRICHTEXT_NEWL, "ENullFormatLayerHandle" );
1.271 + }
1.272 + __ASSERT_ALWAYS(aGlobalCharLayer != NULL, Panic(ENullFormatLayerHandle));
1.273 +
1.274 + CRichText* self = new(ELeave) CRichText(aGlobalParaLayer, aGlobalCharLayer);
1.275 + CleanupStack::PushL(self);
1.276 + self->ConstructL(aStore, aStreamId, aPictureFactory, aStoreResolver, aFieldFactory, aStorage);
1.277 + CleanupStack::Pop();
1.278 + return self;
1.279 + }
1.280 +
1.281 +
1.282 +EXPORT_C CRichText::CRichText(const CParaFormatLayer* aGlobalParaLayer, const CCharFormatLayer* aGlobalCharLayer,
1.283 + CStyleList* aStyleList):
1.284 + CGlobalText(aGlobalParaLayer, aGlobalCharLayer),
1.285 + iStyleList(aStyleList)
1.286 + {
1.287 + }
1.288 +
1.289 +
1.290 +EXPORT_C void CRichText::ConstructL(TDocumentStorage aStorage, TInt aDefaultTextGranularity, TParaType aParaType)
1.291 +// Initialises and updates the index following the CPlainText::ConstructL
1.292 +// insertion of the end-of-document character.
1.293 +//
1.294 + {
1.295 + CPlainText::ConstructL(aStorage, aDefaultTextGranularity);
1.296 + SetParaTypeIsSingle(aParaType == ESinglePara);
1.297 + iParserData = new(ELeave) CParserData(DocumentLength());
1.298 + TInt a;
1.299 + TInt b;
1.300 + ParseText(a, b, ETrue);
1.301 +
1.302 + __TEST_INVARIANT;
1.303 + }
1.304 +
1.305 +
1.306 +EXPORT_C void CRichText::ConstructL(const CStreamStore& aStore,TStreamId aStreamId,
1.307 + MPictureFactory* aPictureFactory, MRichTextStoreResolver* aStoreResolver,
1.308 + MTextFieldFactory* aFieldFactory,
1.309 + TDocumentStorage aStorage)
1.310 +// Initialises and updates the index following the CPlainText::ConstructL
1.311 +// insertion of the end-of-document character.
1.312 +// Sets the picture header factory if provided.
1.313 +//
1.314 + {
1.315 + CPlainText::ConstructL(aStore, aStreamId, aFieldFactory, aStorage);
1.316 + SetPictureFactory(aPictureFactory, aStoreResolver);
1.317 + if (iParserData == NULL)
1.318 + iParserData = new(ELeave) CParserData(DocumentLength());
1.319 + TInt a;
1.320 + TInt b;
1.321 + ParseText(a, b, ETrue);
1.322 +
1.323 + __TEST_INVARIANT;
1.324 + }
1.325 +
1.326 +
1.327 +EXPORT_C CRichText::~CRichText()
1.328 +/** The destructor frees all resources owned by the rich text object, prior to
1.329 +its destruction. */
1.330 + {
1.331 + // We cannot call DestroyParserSystem() here because it applies to all instances in the thread
1.332 + delete iParserData;
1.333 + KillStyleList();
1.334 + KillIndex();
1.335 + }
1.336 +
1.337 +
1.338 +void CRichText::KillStyleList()
1.339 +// Free up the style table
1.340 +//
1.341 + {
1.342 + if (StyleListPresent() && !StyleListExternallyOwned())
1.343 + {
1.344 + delete iStyleList.AsPtr();
1.345 + iStyleList = NULL;
1.346 + }
1.347 + }
1.348 +
1.349 +
1.350 +void CRichText::KillIndex()
1.351 +// Delete the rich text index if it's resident in memory.
1.352 +//
1.353 + {
1.354 + if (IndexPresent())
1.355 + delete iIndex.AsPtr();
1.356 + iIndex=NULL;
1.357 + }
1.358 +
1.359 +
1.360 +TBool CRichText::CreateEmptyMarkupComponentL()
1.361 +// If necessary, creates an empty markup component.
1.362 +// Returns ETrue if the markup component was created as a result of this function,
1.363 +// otherwise returns EFalse.
1.364 +//
1.365 + {
1.366 + if (IndexPresent())
1.367 + return EFalse;
1.368 + TInt paraGran = (ParaTypeIsSingle()) ? KSingleParaGranularity : KMultiParaGranularity;
1.369 + TInt phrGran = (ParaTypeIsSingle()) ? KSmallPhraseGranularity : KLargePhraseGranularity;
1.370 + iIndex = CRichTextIndex::NewL(iGlobalParaFormatLayer, iGlobalCharFormatLayer, *this,paraGran,phrGran);
1.371 + return ETrue;
1.372 + }
1.373 +
1.374 +
1.375 +void CRichText::CreateAndGenerateMarkupComponentL()
1.376 +// Checks if the rich text index needs to be created and does so if necessary.
1.377 +// Called by all public rich text functions that manipulate specific formatting.
1.378 +//
1.379 + {
1.380 + if (CreateEmptyMarkupComponentL())
1.381 + {
1.382 + TRAPD(ret, GenerateMarkupL());
1.383 + if (ret != KErrNone)
1.384 + {// destroy this partially set markup component
1.385 + delete iIndex.AsPtr();
1.386 + iIndex = NULL;
1.387 + User::Leave(ret);
1.388 + }
1.389 + }
1.390 + }
1.391 +
1.392 +
1.393 +void CRichText::GenerateMarkupL()
1.394 +// Generate markup data corresponding to the current text content.
1.395 +//
1.396 + {
1.397 + TInt remainingLength = DocumentLength();
1.398 + TInt startPos = 0;
1.399 + while (remainingLength)
1.400 + {
1.401 + TPtrC buf = Read(startPos);
1.402 + TInt consumed = buf.Length();
1.403 + if (consumed > remainingLength)
1.404 + {
1.405 + consumed = remainingLength;
1.406 + buf.Set(buf.Ptr(), consumed);
1.407 + }
1.408 + iIndex->InsertL(startPos, buf, *iGlobalParaFormatLayer);
1.409 + remainingLength -= consumed;
1.410 + startPos += consumed;
1.411 + }
1.412 + }
1.413 +
1.414 +EXPORT_C void CRichText::CopyToStoreL(CStreamStore& aStore,CStreamDictionary& aDictionary,TInt aPos,TInt aLength) const
1.415 +/** Copies a portion of the rich text object, with components to the clipboard.
1.416 +
1.417 +A panic occurs in the following circumstances:
1.418 +
1.419 +aPos is an invalid document position
1.420 +
1.421 +aLength is invalid (zero or less)
1.422 +
1.423 +the sum of aPos and aLength is greater than or equal to the number of characters
1.424 +in the document
1.425 +
1.426 +@param aStore Stream store to which the rich text is written.
1.427 +@param aDictionary The stream dictionary.
1.428 +@param aPos The document position from which to begin copying.
1.429 +@param aLength The number of characters to copy. */
1.430 + {
1.431 + if (aLength > 0)
1.432 + {
1.433 + TStreamId plainTextId = CPlainText::DoCopyToStoreL(aStore,aDictionary,aPos,aLength);
1.434 + TStreamId id = DoCopyToStoreL(aStore,aPos,aLength,plainTextId,FALSE);
1.435 + aDictionary.AssignL(KClipboardUidTypeRichText,id);
1.436 + TStreamId idStyles = DoCopyToStoreL(aStore,aPos,aLength,plainTextId,TRUE);
1.437 + aDictionary.AssignL(KClipboardUidTypeRichTextWithStyles,idStyles);
1.438 + }
1.439 + }
1.440 +
1.441 +
1.442 +// Copy the selected region of rich text, with components, to the specified store.
1.443 +TStreamId CRichText::DoCopyToStoreL(CStreamStore& aStore,TInt aPos,TInt aLength,TStreamId aPlainTextId,TBool aCopyStyles) const
1.444 + {
1.445 + __TEST_INVARIANT;
1.446 +
1.447 + TInt documentLength = DocumentLength();
1.448 + if (aPos < 0 || aPos > documentLength)
1.449 + {
1.450 + OstTrace0( TRACE_FATAL, CRICHTEXT_DOCOPYTOSTOREL, "ECharPosBeyondDocument" );
1.451 + }
1.452 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= documentLength,Panic(ECharPosBeyondDocument));
1.453 + if (aLength < 0)
1.454 + {
1.455 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_DOCOPYTOSTOREL, "ECopyToClipboardNegativeLength" );
1.456 + }
1.457 + __ASSERT_ALWAYS(aLength >= 0,Panic(ECopyToClipboardNegativeLength));
1.458 + if (aPos + aLength > documentLength)
1.459 + {
1.460 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_DOCOPYTOSTOREL, "ECharPosBeyondDocument" );
1.461 + }
1.462 + __ASSERT_ALWAYS(aPos + aLength <= documentLength,Panic(ECharPosBeyondDocument));
1.463 +
1.464 + if (aLength == 0)
1.465 + return KNullStreamId;
1.466 +
1.467 + CStoreMap* map = CStoreMap::NewLC(aStore);
1.468 + CopyComponentsL(aStore,*map,aPos,aLength,aPlainTextId);
1.469 + RStoreWriteStream stream(*map);
1.470 + TStreamId id = stream.CreateLC(aStore);
1.471 + CopyToStreamL(stream,aPos,aLength,aPlainTextId,aCopyStyles);
1.472 + stream.CommitL();
1.473 + map->Reset();
1.474 + CleanupStack::PopAndDestroy(2);
1.475 +
1.476 + __TEST_INVARIANT;
1.477 + return id;
1.478 + }
1.479 +
1.480 +
1.481 +EXPORT_C void CRichText::CopyComponentsL(CStreamStore& aStore,CStoreMap& aMap,TInt aPos,TInt aLength,TStreamId aPlainTextId) const
1.482 + {
1.483 + if (aPlainTextId == KNullStreamId)
1.484 + CPlainText::CopyComponentsL(aStore,aMap,aPos,aLength);
1.485 + if (IndexPresent())
1.486 + iIndex->StorePicturesL(aStore,aMap,aPos,aLength);
1.487 + }
1.488 +
1.489 +
1.490 +// Copy the selected region of rich text and components to the specified stream.
1.491 +EXPORT_C void CRichText::CopyToStreamL(RWriteStream& aStream,TInt aPos,TInt aLength) const
1.492 + {
1.493 + __TEST_INVARIANT;
1.494 + CopyToStreamL(aStream, aPos, aLength, KNullStreamId);
1.495 + }
1.496 +
1.497 +
1.498 +/*
1.499 +Copy the selected region of rich text and components to the specified stream.
1.500 +If aPlainTextId is NULL the plain text component is stored in-line,
1.501 +otherwise the reference to the plain text stream component is stored.
1.502 +*/
1.503 +EXPORT_C void CRichText::CopyToStreamL(RWriteStream& aStream,TInt aPos,TInt aLength,TStreamId aPlainTextId) const
1.504 + {
1.505 + CopyToStreamL(aStream,aPos,aLength,aPlainTextId,TRUE);
1.506 + }
1.507 +
1.508 +
1.509 +void CRichText::CopyToStreamL(RWriteStream& aStream,TInt aPos,TInt aLength,TStreamId aPlainTextId,TBool aCopyStyles) const
1.510 + {
1.511 + if (aPlainTextId == KNullStreamId)
1.512 + {
1.513 + aStream.WriteUint8L(TRUE);
1.514 + CPlainText::CopyToStreamL(aStream,aPos,aLength);
1.515 + }
1.516 + else
1.517 + {
1.518 + aStream.WriteUint8L(FALSE);
1.519 + aStream << aPlainTextId;
1.520 + }
1.521 +
1.522 + if (!IndexPresent())
1.523 + CONST_CAST(CRichText*,this)->CreateAndGenerateMarkupComponentL();
1.524 + aStream.WriteUint8L(TRUE);
1.525 + iIndex->CopyToStreamL(aStream,aPos,aLength,aCopyStyles);
1.526 + }
1.527 +
1.528 +EXPORT_C TInt CRichText::PasteFromStoreL(const CStreamStore& aStore, const CStreamDictionary& aDictionary, TInt aPos, CParagraphStyle::TStylePasteMode aStylePasteMode)
1.529 +/** Pastes the contents of the clipboard into the rich text object at the
1.530 +specified document position. Returns the number of characters pasted.
1.531 +
1.532 +If the text in the clipboard has been formatted using styles, the
1.533 +aStylePasteMode argument indicates whether the styles should be preserved
1.534 +or discarded. If the argument is not specified, the pasted rich text
1.535 +retains all formatting specified in the styles, and any new style
1.536 +definitions are added to the style list of the rich text object into which
1.537 +it is pasted.
1.538 +
1.539 +@param aStore The stream store from which to paste the rich text.
1.540 +@param aDictionary The stream dictionary.
1.541 +@param aPos The document position at which to paste the rich text. Must be
1.542 +valid, or a panic occurs.
1.543 +@param aStylePasteMode Indicates whether styles in the pasted text should be
1.544 +preserved or discarded.
1.545 +@return The number of characters pasted. */
1.546 + {
1.547 + return DoPasteRtFromStoreL(aStore, aDictionary, aPos, aStylePasteMode);
1.548 + }
1.549 +
1.550 +
1.551 +EXPORT_C TInt CRichText::PasteFromStoreL(const CStreamStore& aStore, const CStreamDictionary& aDictionary, TInt aPos)
1.552 +// Paste the lesser of i) aMaxPasteLength ii) the entire clipboard contents.
1.553 +// Return a count of the number of characters pasted.
1.554 +//
1.555 + {
1.556 + return DoPasteRtFromStoreL(aStore, aDictionary, aPos, CParagraphStyle::EAddNewStyles);
1.557 + }
1.558 +
1.559 +
1.560 +TInt CRichText::DoPasteRtFromStoreL(const CStreamStore& aStore, const CStreamDictionary& aDictionary, TInt aPos, CParagraphStyle::TStylePasteMode aStylePasteMode)
1.561 +// Paste the rich text data from the specified clipboard, inserting it into this
1.562 +// instance at character position aPos. Returns the number of characters pasted.
1.563 +// May be 0.
1.564 +//
1.565 + {
1.566 + __TEST_INVARIANT;
1.567 + if (aPos > DocumentLength())
1.568 + {
1.569 + OstTrace0( TRACE_FATAL, CRICHTEXT_DOPASTERTFROMSTOREL, "ECharPosBeyondDocument" );
1.570 + }
1.571 + __ASSERT_ALWAYS(aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.572 +
1.573 + TUid type = KClipboardUidTypeRichTextWithStyles;
1.574 + TStreamId id = aDictionary.At(type);
1.575 + if (id == KNullStreamId)
1.576 + {
1.577 + type = KClipboardUidTypeRichText;
1.578 + id = aDictionary.At(type);
1.579 + }
1.580 + if (id == KNullStreamId)
1.581 + {
1.582 + type = KClipboardUidTypePlainText;
1.583 + id = aDictionary.At(type);
1.584 + }
1.585 + TInt consumed = 0;
1.586 + if (id == KNullStreamId)
1.587 + return consumed;
1.588 + if (type == KClipboardUidTypeRichText || type == KClipboardUidTypeRichTextWithStyles)
1.589 + consumed = PasteRichTextFromStoreL(aStore, aDictionary, id, aPos, aStylePasteMode);
1.590 + else if (type == KClipboardUidTypePlainText)
1.591 + consumed = PastePlainTextFromStoreL(aStore, id, aPos);
1.592 +
1.593 + if (consumed)
1.594 + {
1.595 + iParserData->MergeRange(aPos,0,consumed);
1.596 + CallEditObserver(aPos, consumed);
1.597 + }
1.598 +
1.599 + SetHasChanged(ETrue);
1.600 + __TEST_INVARIANT;
1.601 + return consumed;
1.602 + }
1.603 +
1.604 +
1.605 +TInt CRichText::PasteRichTextFromStoreL(const CStreamStore& aStore, const CStreamDictionary& aDictionary, TStreamId& aRichTextStreamId, TInt aPos,CParagraphStyle::TStylePasteMode aStylePasteMode)
1.606 +// Paste the plain text stream, then open and paste the rich text markup from the specified stream.
1.607 +//
1.608 + {
1.609 + if (!IndexPresent())
1.610 + CreateAndGenerateMarkupComponentL(); // create the index if it does not already exist
1.611 + TStreamId id = aDictionary.At(KClipboardUidTypePlainText);
1.612 +// ASSERT: We have rich text, so the plain text stream must exist.
1.613 + if (id == KNullStreamId)
1.614 + {
1.615 + OstTrace0( TRACE_FATAL, CRICHTEXT_PASTERICHTEXTFROMSTOREL, "EClipboardIntegrity" );
1.616 + }
1.617 + __ASSERT_ALWAYS(id != KNullStreamId,Panic(EClipboardIntegrity));
1.618 + TInt consumed = CPlainText::DoPasteFromStoreL(aStore, id, aPos);
1.619 + TRAPD(ret, CompletePasteRichTextFromStoreL(aStore, aRichTextStreamId, aPos, aStylePasteMode));
1.620 + if (ret != KErrNone)
1.621 + {
1.622 + CPlainText::Delete(aPos,consumed);
1.623 + OstTrace1( TRACE_FATAL, DUP1_CRICHTEXT_PASTERICHTEXTFROMSTOREL, "Leave code=%d", ret );
1.624 + User::Leave(ret);
1.625 + }
1.626 + return consumed;
1.627 + }
1.628 +
1.629 +
1.630 +void CRichText::CompletePasteRichTextFromStoreL(const CStreamStore& aStore, TStreamId& aRichTextStreamId, TInt aPos, CParagraphStyle::TStylePasteMode aStylePasteMode)
1.631 +//
1.632 + {
1.633 + RStoreReadStream stream;
1.634 + stream.OpenLC(aStore, aRichTextStreamId);
1.635 + TBool plainTextInline = (TBool)stream.ReadUint8L();
1.636 + if (!plainTextInline)
1.637 + {
1.638 + TStreamId dummy;
1.639 + stream >> dummy;
1.640 + }
1.641 + TBool markupPresentInClipboard = (TBool)stream.ReadUint8L();
1.642 + if (markupPresentInClipboard)
1.643 + iIndex->PasteFromStreamL(aStore, stream, aPos,aStylePasteMode, iGlobalParaFormatLayer, iGlobalCharFormatLayer);
1.644 + CleanupStack::PopAndDestroy(); // stream
1.645 + }
1.646 +
1.647 +
1.648 +TInt CRichText::PastePlainTextFromStoreL(const CStreamStore& aStore, TStreamId& anId, TInt aPos)
1.649 +// Paste the plain text stream, then update the rich text index to show any paragraph delimiters pasted.
1.650 +//
1.651 + {
1.652 + TInt consumed = CPlainText::DoPasteFromStoreL(aStore, anId, aPos);
1.653 + //
1.654 + if (IndexPresent())
1.655 + {
1.656 + TRAPD(ret, CompletePastePlainTextL(aPos, consumed));
1.657 + if (ret != KErrNone)
1.658 + {
1.659 + CPlainText::Delete(aPos,consumed);
1.660 + User::Leave(ret);
1.661 + }
1.662 + }
1.663 + return consumed;
1.664 + }
1.665 +
1.666 +void CRichText::CompletePastePlainTextL(TInt aPos, TInt aCharacterCount)
1.667 +// Updates the rich text index following the pasting of global text.
1.668 +//
1.669 + {
1.670 + HBufC* buf = HBufC::NewLC(aCharacterCount);
1.671 + TPtr bf = buf->Des();
1.672 + Extract(bf, aPos, aCharacterCount);
1.673 + iIndex->InsertL(aPos, bf, *iGlobalParaFormatLayer);
1.674 + CleanupStack::PopAndDestroy(); // buf
1.675 + }
1.676 +
1.677 +EXPORT_C void CRichText::Reset()
1.678 +/** Resets the document's contents to a single end-of-document delimiter. Also
1.679 +deletes the style list if owned by the object. */
1.680 + {
1.681 + // Resets document contents to single end-of-document charcter,
1.682 + // and resets the index to match document content.
1.683 + TInt length = DocumentLength();
1.684 + CPlainText::Reset(); // remove all content bar eod character
1.685 + KillStyleList(); // does not get destroyed if externally owned
1.686 + KillIndex();
1.687 + SetHasChanged(ETrue);
1.688 + iParserData->KillRange();
1.689 + iParserData->iLastKnownCursor = -1;
1.690 + CallEditObserver(0, -length);
1.691 +
1.692 + __TEST_INVARIANT;
1.693 + }
1.694 +
1.695 +EXPORT_C void CRichText::InsertL(TInt aPos, const TChar& aChar)
1.696 +/** Inserts either a single character or a descriptor into the text object
1.697 +at a specified document position.
1.698 +
1.699 +The insertion position must be valid or a panic occurs.Note:A panic
1.700 +occurs if the text object is in an "insert pending" state (i.e.
1.701 +SetInsertCharFormatL() has been called and has not been
1.702 +cancelled using CancelInsertCharFormat()) and aPos is not
1.703 +the same as the insertion point.
1.704 +
1.705 +@param aPos The document position at which to insert the character/descriptor.
1.706 +@param aChar The character to insert. Must not be a picture character or a
1.707 +panic occurs.
1.708 +@param aBuf The descriptor to insert. */
1.709 + {
1.710 + __TEST_INVARIANT;
1.711 + if (aPos < 0 || aPos > DocumentLength())
1.712 + {
1.713 + OstTrace0( TRACE_FATAL, CRICHTEXT_INSERTL, "ECharPosBeyondDocument" );
1.714 + }
1.715 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.716 + if (aChar == EPictureCharacter)
1.717 + {
1.718 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_INSERTL, "ENonOverloadedInsertCalledWithPictureCharacter" );
1.719 + }
1.720 + __ASSERT_ALWAYS(aChar!= EPictureCharacter, Panic(ENonOverloadedInsertCalledWithPictureCharacter));
1.721 +
1.722 + if (aChar < 0x10000)
1.723 + {
1.724 + TBuf<1> content;
1.725 + content.Append(aChar);
1.726 + RtInsertL(aPos, content);
1.727 + }
1.728 + else
1.729 + {
1.730 + TText16 high = TChar::GetHighSurrogate(aChar);
1.731 + TText16 low = TChar::GetLowSurrogate(aChar);
1.732 + RDebug::Print(_L("CRichText::InsertL(), %X expand to %X %X."), TUint(aChar), high, low);
1.733 +
1.734 + TBuf<2> content;
1.735 + content.Append(high);
1.736 + content.Append(low);
1.737 + RtInsertL(aPos, content);
1.738 + }
1.739 +
1.740 + __TEST_INVARIANT;
1.741 + }
1.742 +
1.743 +
1.744 +EXPORT_C void CRichText::InsertL(TInt aPos, const TDesC& aBuf)
1.745 +// Inserts the contents of aBuf into the text component at character position aPos.
1.746 +//
1.747 + {
1.748 + __ETEXT_WATCH(INSERT_DESC);
1.749 +
1.750 + RtInsertL(aPos, aBuf);
1.751 +
1.752 + __ETEXT_WATCH_END(INSERT_DESC);
1.753 + }
1.754 +
1.755 +
1.756 +EXPORT_C void CRichText::RtInsertL(TInt aPos, const TDesC& aBuf)
1.757 +// Inserts the contents a aBuf into the text component at position aPos.
1.758 +// Updates the index accordingly, and accounts for all embedded paragraph delimiters
1.759 +// in the passed buffer aBuf.
1.760 +//
1.761 + {
1.762 + __TEST_INVARIANT;
1.763 + if (aPos < 0 || aPos > DocumentLength())
1.764 + {
1.765 + OstTrace0( TRACE_FATAL, CRICHTEXT_RTINSERTL, "ECharPosBeyondDocument" );
1.766 + }
1.767 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.768 +
1.769 + int length = aBuf.Length();
1.770 + CPlainText::InsertL(aPos, aBuf);
1.771 + if (IndexPresent())
1.772 + {
1.773 + TRAPD(ret, iIndex->InsertL(aPos, aBuf, *iGlobalParaFormatLayer));
1.774 + if (ret != KErrNone)
1.775 + {
1.776 + CPlainText::Delete(aPos,length);
1.777 + User::Leave(ret);
1.778 + }
1.779 + SetHasChanged(ETrue);
1.780 + }
1.781 +
1.782 + iParserData->MergeRange(aPos,0,length);
1.783 + CallEditObserver(aPos,length);
1.784 +
1.785 + __TEST_INVARIANT;
1.786 + }
1.787 +
1.788 +
1.789 +EXPORT_C void CRichText::InsertL(TInt aPos,const TPictureHeader& aHeader)
1.790 +/**Inserts a picture header into the text object at a specified document
1.791 +position. The picture header specified must reference a valid picture, or
1.792 +a panic occurs.
1.793 +
1.794 +A panic also occurs if the text object is in an "insert pending" state
1.795 +(SetInsertCharFormatL() has been called and has not been cancelled using
1.796 +CancelInsertCharFormat()) and aPos is not the same as the insertion point.
1.797 +
1.798 +This method takes ownership of a picture referenced in aHeader.
1.799 +
1.800 +@param aPos The document position at which to insert the picture header. Must
1.801 +be valid, or a panic occurs.
1.802 +@param aHeader A picture header. This holds a pointer to the picture to insert,
1.803 +and information about the picture. */
1.804 + {
1.805 + __TEST_INVARIANT;
1.806 + if (aPos < 0 || aPos > DocumentLength())
1.807 + {
1.808 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_INSERTL, "ECharPosBeyondDocument" );
1.809 + }
1.810 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.811 +
1.812 + CleanupStack::PushL(aHeader.iPicture);
1.813 +
1.814 + if (!IndexPresent())
1.815 + CreateAndGenerateMarkupComponentL();
1.816 + TBuf<1> picture;
1.817 + picture.Append(EPictureCharacter);
1.818 + CPlainText::InsertL(aPos, picture);
1.819 +
1.820 + CleanupStack::Pop(aHeader.iPicture);
1.821 +
1.822 + TBool pictureOwnershipTaken(EFalse);
1.823 + TRAPD(ret, iIndex->InsertL(aPos, aHeader,pictureOwnershipTaken));
1.824 + if (ret != KErrNone)
1.825 + {
1.826 + if(!pictureOwnershipTaken)
1.827 + {
1.828 + const_cast <TPictureHeader&> (aHeader).DeletePicture();
1.829 + }
1.830 + CPlainText::Delete(aPos,picture.Length()); // remove the picture place-holder
1.831 + User::Leave(ret);
1.832 + }
1.833 +
1.834 + SetHasChanged(ETrue);
1.835 + iParserData->MergeRange(aPos,0,1);
1.836 + CallEditObserver(aPos,1);
1.837 + __TEST_INVARIANT;
1.838 + }
1.839 +
1.840 +
1.841 +EXPORT_C TBool CRichText::DeleteL(TInt aPos, TInt aLength)
1.842 +/** Deletes one or more characters beginning at, and including, the character at
1.843 +a specified document position. Can leave because paragraphs may be merged
1.844 +and reformatted by the function.
1.845 +
1.846 +@param aPos The start of the range of characters to delete. Must be valid
1.847 +or a panic occurs.
1.848 +@param aLength The number of characters to delete. Must be positive or a panic
1.849 +occurs. The sum of aPos and aLength must be less than the document length,
1.850 +or a panic occurs.
1.851 +@return Indicates whether two paragraphs have been merged as a result of the
1.852 +delete, indicating that the formatting of part of the resulting paragraph
1.853 +may have changed. */
1.854 + {
1.855 + // Deletes aRange number of characters from the text component
1.856 + // and the corresponding index data.
1.857 + // Delete commences at, and includes, character position aPos.
1.858 + __TEST_INVARIANT;
1.859 +
1.860 + if (aPos < 0 || aPos > DocumentLength())
1.861 + {
1.862 + OstTrace0( TRACE_FATAL, CRICHTEXT_DELETEL, "ECharPosBeyondDocument" );
1.863 + }
1.864 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.865 + if (aLength < 0)
1.866 + {
1.867 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_DELETEL, "EDebugDeleteZeroLength" );
1.868 + }
1.869 + __ASSERT_ALWAYS(aLength >= 0, Panic(EDebugDeleteZeroLength));
1.870 + if (aPos + (aLength - 1) > DocumentLength())
1.871 + {
1.872 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_DELETEL, "ECharPosBeyondDocument" );
1.873 + }
1.874 + __ASSERT_ALWAYS(aPos + (aLength - 1) <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.875 +
1.876 + TBool requireMerge = EFalse;
1.877 + if (!IndexPresent())
1.878 + CPlainText::Delete(aPos,aLength);
1.879 + else
1.880 + {
1.881 + iIndex->CancelInsertCharFormat();
1.882 + TIndexDeleteInfo info;
1.883 + iIndex->SetForDeleteL(info, aPos, aLength);
1.884 + CPlainText::Delete(aPos,aLength);
1.885 + requireMerge = iIndex->DeleteNow(info);
1.886 + }
1.887 + iParserData->MergeRange(aPos,aLength,0);
1.888 + CallEditObserver(aPos,-aLength);
1.889 +
1.890 + __TEST_INVARIANT;
1.891 + return requireMerge;
1.892 + }
1.893 +
1.894 +EXPORT_C void CRichText::DeleteParagraph(TInt aPos, TInt aLength)
1.895 +/** Deletes one or more whole paragraphs of text. No paragraphs can be merged together
1.896 +by this function, so it cannot leave it must only be used to delete entire
1.897 +paragraphs.
1.898 +
1.899 +@param aPos The document position of the start of the first paragraph to delete.
1.900 +Must be a valid position or a panic occurs.
1.901 +@param aLength The number of characters to delete. */
1.902 + {
1.903 + // Use to remove entire paragraphs of text.
1.904 + // Leave-safe if called in this context.
1.905 + // MUST NOT CALL if not in this context.
1.906 + __TEST_INVARIANT;
1.907 +
1.908 + // Store the length of the text before we commence with deletions.
1.909 + TInt initialDocLen=DocumentLength();
1.910 +
1.911 + if (aPos < 0 || aPos > initialDocLen)
1.912 + {
1.913 + OstTrace0( TRACE_FATAL, CRICHTEXT_DELETEPARAGRAPH, "ECharPosBeyondDocument" );
1.914 + }
1.915 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= initialDocLen, Panic(ECharPosBeyondDocument));
1.916 + if (aPos + aLength > initialDocLen + 1)
1.917 + {
1.918 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_DELETEPARAGRAPH, "ECharPosBeyondDocument" );
1.919 + }
1.920 + __ASSERT_ALWAYS(aPos + aLength <= initialDocLen + 1, Panic(ECharPosBeyondDocument));
1.921 +
1.922 + if (aLength <= 0)
1.923 + return;
1.924 +
1.925 + if (IndexPresent())
1.926 + iIndex->DeleteParagraph(aPos, aLength);
1.927 + CPlainText::Delete(aPos,aLength);
1.928 +
1.929 + // Change here for defect INC005336.
1.930 + // Previously the MergeRange call (see else line) was incorrectly handling
1.931 + // the scenario where all but the first paragraph was deleted e.g. pasting
1.932 + // multi line buffer into a single line text control in a new email on Techview
1.933 + // emulator.
1.934 + // This was because the deletion in the two lines above would delete the
1.935 + // 'end-of-text' maker causing the iEndParse member of CParserData to
1.936 + // index the char right after the end of test marker. This would panic
1.937 + // plugin parsers thatsubsquently executed.
1.938 +
1.939 + if (aPos+aLength > initialDocLen)
1.940 + // When deletion includes the end-of-text marker, adjust start
1.941 + // supplied so that it appears to MergeRange that we are
1.942 + // deleting the paragraph and CR just before it which belongs
1.943 + // to the previous paragraph and not the end-of-text marker.
1.944 + // This is actually the end result of the deletion anyway!
1.945 + iParserData->MergeRange(initialDocLen-aLength,aLength,0);
1.946 + else
1.947 + // All other deletions which don't.
1.948 + iParserData->MergeRange(aPos,aLength,0);
1.949 +
1.950 + CallEditObserver(aPos,-aLength);
1.951 +
1.952 + __TEST_INVARIANT;
1.953 + }
1.954 +
1.955 +EXPORT_C void CRichText::DeleteFromParagraph(TInt aPos, TInt aLength)
1.956 +/** Removes a range of characters from within a single paragraph only. Should not
1.957 +be used for deleting an entire paragraph or paragraphs because this may cause
1.958 +it to leave. Otherwise, it is guaranteed not to leave.
1.959 +
1.960 +@param aPos The document position of the start of the range of characters
1.961 +to delete. Must be a valid document position, or a panic occurs.
1.962 +@param aLength The number of characters to delete. The sum of aPos and aLength
1.963 +must be less than the document length, or a panic occurs. */
1.964 + {
1.965 + // Removes aLength characters from *within* a single paragraph only.
1.966 + // Guaranteed not to leave if this pre-condition holds true.
1.967 + __TEST_INVARIANT;
1.968 +
1.969 + if (aPos < 0 || aPos > DocumentLength())
1.970 + {
1.971 + OstTrace0( TRACE_FATAL, CRICHTEXT_DELETEFROMPARAGRAPH, "ECharPosBeyondDocument" );
1.972 + }
1.973 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.974 + if (aPos + (aLength - 1) > DocumentLength())
1.975 + {
1.976 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_DELETEFROMPARAGRAPH, "ECharPosBeyondDocument" );
1.977 + }
1.978 + __ASSERT_ALWAYS(aPos + (aLength - 1) <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.979 +
1.980 + if (aLength <= 0)
1.981 + return;
1.982 +
1.983 + if (IndexPresent())
1.984 + iIndex->DeleteFromParagraph(aPos, aLength);
1.985 + CPlainText::Delete(aPos,aLength);
1.986 + iParserData->MergeRange(aPos,aLength,0);
1.987 + CallEditObserver(aPos,-aLength);
1.988 +
1.989 + __TEST_INVARIANT;
1.990 + }
1.991 +
1.992 +EXPORT_C TInt CRichText::ParagraphCount()const
1.993 +/** Gets a count of the number of paragraphs in the text object.
1.994 +
1.995 +Note:
1.996 +
1.997 +The paragraph delimiter which terminates every text object means this function
1.998 +always returns a count of at least one.
1.999 +
1.1000 +@return The number of paragraphs in the document. */
1.1001 + {
1.1002 + // Returns a count of the number of paragraphs
1.1003 + // in the document.
1.1004 + //
1.1005 + __TEST_INVARIANT;
1.1006 +
1.1007 + if (IndexPresent())
1.1008 + return iIndex->ParagraphCount();
1.1009 + else
1.1010 + return CPlainText::ParagraphCount();
1.1011 + }
1.1012 +
1.1013 +
1.1014 +EXPORT_C TEtextComponentInfo CRichText::ComponentInfo() const
1.1015 +/** Gets information about the number of components contained in the text object
1.1016 +(the field count, the picture count and the style count).
1.1017 +
1.1018 +@return Contains the component information. */
1.1019 + {
1.1020 + return TEtextComponentInfo(FieldCount(), PictureCount(), StyleCount());
1.1021 + }
1.1022 +
1.1023 +EXPORT_C TInt CRichText::CharPosOfParagraph(TInt& aLength, TInt aParaOffset) const
1.1024 +/** Finds the length and the start position of a paragraph identified by its
1.1025 +paragraph number. The first paragraph is numbered zero.
1.1026 +
1.1027 +Notes:
1.1028 +
1.1029 +if aParaOffset is invalid, (equal to or greater than the total number of
1.1030 +paragraphs), the function's return value is EScanEndOfData (= -1)
1.1031 +
1.1032 +@param aLength On return contains the length of the specified paragraph.
1.1033 +@param aParaOffset The paragraph number. The first paragraph is numbered zero.
1.1034 +@return The document position of the first character in the paragraph. */
1.1035 + {
1.1036 + // Returns the character position of the first character of paragraph aParaOffset,
1.1037 + // where aParaOffset specifies the nth paragraph.
1.1038 + // The length of this nth paragraph is written to aLength.
1.1039 + //
1.1040 + // If aParaOffset specifies a paragraph that does not exist, EScanEndOfData is returned.
1.1041 + //
1.1042 + __TEST_INVARIANT;
1.1043 +
1.1044 + if (IndexPresent())
1.1045 + return iIndex->CharPosOfParagraph(aLength, aParaOffset);
1.1046 + else
1.1047 + return CPlainText::CharPosOfParagraph(aLength, aParaOffset);
1.1048 + }
1.1049 +
1.1050 +EXPORT_C TInt CRichText::ParagraphNumberForPos(TInt& aPos) const
1.1051 +/** Gets the number of the paragraph which contains a document position.
1.1052 +Paragraph numbering begins at zero.
1.1053 +
1.1054 +@param aPos A document position. Must be valid or a panic occurs. On return,
1.1055 +contains the document position of the first character in the paragraph in
1.1056 +which it is located.
1.1057 +@return The number of the paragraph containing the specified document position. */
1.1058 + {
1.1059 + // Returns the paragraph offset for the specified character position aPos.
1.1060 + // aPos is in turn modified to hold the character position of the first character
1.1061 + // of this paragraph. If aPos is already on a paragraph boundary then do nothing.
1.1062 + //
1.1063 + __TEST_INVARIANT;
1.1064 + if (aPos < 0 || aPos > DocumentLength())
1.1065 + {
1.1066 + OstTrace0( TRACE_FATAL, CRICHTEXT_PARAGRAPHNUMBERFORPOS, "ECharPosBeyondDocument" );
1.1067 + }
1.1068 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1069 +
1.1070 + if (IndexPresent())
1.1071 + return iIndex->ParagraphNumberForPos(aPos);
1.1072 + else
1.1073 + return CPlainText::ParagraphNumberForPos(aPos);
1.1074 + }
1.1075 +
1.1076 +/** Applies character formatting to a zero length selection, for example
1.1077 +turning bold on. This has the effect that the formatting will be applied to
1.1078 +text subsequently inserted at the position. This "insert pending" state is
1.1079 +cancelled by calling CancelInsertCharFormat().
1.1080 +
1.1081 +Note 1: After calling this function, if text is inserted at a different
1.1082 +position to aPos, a panic will occur, unless CancelInsertCharFormat() has been
1.1083 +called before the insertion to cancel the "insert pending" state.
1.1084 +
1.1085 +Note 2: If the insert character format is being set for the end of the
1.1086 +paragraph, the paragraph delimiter is set to that format as well. This helps
1.1087 +end-of-paragraph behaviour be more similar to other places.
1.1088 +
1.1089 +@param aFormat The character format values to apply.
1.1090 +@param aMask Character format mask specifying the attributes affected.
1.1091 +@param aPos The document position at which to insert the character format.
1.1092 +@pre aPos must be a valid position, or a panic will occur. */
1.1093 +EXPORT_C void CRichText::SetInsertCharFormatL(const TCharFormat& aFormat,
1.1094 + const TCharFormatMask& aMask, TInt aPos)
1.1095 + {
1.1096 + SetExtendedInsertCharFormatL(aFormat, aMask,aPos);
1.1097 + }
1.1098 +
1.1099 +void CancelInsertCharFormat(TAny* aCRichTextIndex)
1.1100 + {
1.1101 + reinterpret_cast<CRichTextIndex*>(aCRichTextIndex)->CancelInsertCharFormat();
1.1102 + }
1.1103 +
1.1104 +void CRichText::SetExtendedInsertCharFormatL(const TCharFormatX& aFormat, const TCharFormatXMask& aMask, TInt aPos)
1.1105 + {
1.1106 + if (aPos < 0 || aPos > DocumentLength())
1.1107 + {
1.1108 + OstTrace0( TRACE_FATAL, CRICHTEXT_SETEXTENDEDINSERTCHARFORMATL, "ECharPosBeyondDocument" );
1.1109 + }
1.1110 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1111 + CreateAndGenerateMarkupComponentL();
1.1112 + CRichTextIndex* index = iIndex.AsPtr();
1.1113 + if (index->InsertCharFormatIsActive())
1.1114 + {
1.1115 + TCharFormatX format = aFormat;
1.1116 + TCharFormatXMask mask = aMask;
1.1117 + CCharFormatLayer* currentLayer = index->GetCurrentInsertCharFormat();
1.1118 + currentLayer->Sense(format,mask);
1.1119 + CCharFormatLayer* newLayer = CCharFormatLayer::NewCopyBaseL(currentLayer);
1.1120 + CleanupStack::PushL(newLayer);
1.1121 + newLayer->SetL(format,mask);
1.1122 + if (Read(aPos, 1)[0] == EParagraphDelimiter)
1.1123 + index->ApplyCharFormatL(aFormat, aMask, aPos, 1, EFalse);
1.1124 + if (index->InsertCharFormatIsActive())
1.1125 + {
1.1126 + currentLayer = index->GetCurrentInsertCharFormat();
1.1127 + currentLayer->Swap(*newLayer);
1.1128 + }
1.1129 + CleanupStack::PopAndDestroy(newLayer);
1.1130 + }
1.1131 + else
1.1132 + {
1.1133 + TCleanupItem cleanup(::CancelInsertCharFormat, index);
1.1134 + CleanupStack::PushL(cleanup);
1.1135 + index->NewInsertCharFormatL(aFormat, aMask, aPos);
1.1136 + if (Read(aPos, 1)[0] == EParagraphDelimiter)
1.1137 + index->ApplyCharFormatL(aFormat, aMask, aPos, 1, EFalse);
1.1138 + CleanupStack::Pop();
1.1139 + }
1.1140 + SetHasChanged(TRUE);
1.1141 + }
1.1142 +
1.1143 +EXPORT_C void CRichText::ExtendedInterface(TAny*& aInterface, TUid aInterfaceId)
1.1144 +/**
1.1145 +Returns the interface corresponding to the specified UID if it exists, or 0 if not.
1.1146 +Overridden versions should base call rather than returning 0.
1.1147 +For KUidRichText, CRichText will be returned if rich text is supported.
1.1148 +
1.1149 +@param aInterfaceId The UID indicating the interface to return
1.1150 +@param aInterface The interface corresponding to aInterfaceId
1.1151 +if it is supported, or 0 if it is not
1.1152 +*/
1.1153 + {
1.1154 + if(KUidRichText == aInterfaceId)
1.1155 + {
1.1156 + aInterface = REINTERPRET_CAST(TAny*, this);
1.1157 + }
1.1158 + else
1.1159 + {
1.1160 + CGlobalText::ExtendedInterface(aInterface, aInterfaceId);
1.1161 + }
1.1162 + }
1.1163 +
1.1164 +EXPORT_C TBool CRichText::DelSetInsertCharFormatL(TInt aPos, TInt aLength)
1.1165 +/** Deletes a range of characters. The range affected is from aPos to
1.1166 +aPos+(aLength-1) inclusive. It differs from DeleteL() in that this function
1.1167 +preserves the formatting of the deleted character at position aPos, so that
1.1168 +any text subsequently inserted at aPos will have that formatting applied to it.
1.1169 +
1.1170 +A panic occurs if:
1.1171 +
1.1172 +after calling this function, text is inserted at a different position to aPos,
1.1173 +without calling CancelInsertCharFormat() before the insertion
1.1174 +
1.1175 +aPos is invalid
1.1176 +
1.1177 +aLength is negative
1.1178 +
1.1179 +the range goes beyond the end of the document
1.1180 +
1.1181 +@param aPos The document position of the first character to delete.
1.1182 +@param aLength The number of characters to delete.
1.1183 +@return ETrue if two paragraphs have been merged as a result of the deletion;
1.1184 +EFalse if there has been no paragraph merge. */
1.1185 + {
1.1186 + // Delete aLength characters, commencing at, and including, aPos.
1.1187 + // If aPos is on a phrase boundary, and the whole phrase or more is deleted then
1.1188 + // remember temporarily the phrase format. This is applied to any content that is
1.1189 + // immediately inserted.
1.1190 + //
1.1191 + __TEST_INVARIANT;
1.1192 + if (aPos < 0 || aPos > DocumentLength())
1.1193 + {
1.1194 + OstTrace0( TRACE_FATAL, CRICHTEXT_DELSETINSERTCHARFORMATL, "ECharPosBeyondDocument" );
1.1195 + }
1.1196 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1197 + if (aLength < 0)
1.1198 + {
1.1199 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_DELSETINSERTCHARFORMATL, "EDebugDeleteZeroLength" );
1.1200 + }
1.1201 + __ASSERT_ALWAYS(aLength >= 0, Panic(EDebugDeleteZeroLength));
1.1202 + if (aPos + (aLength - 1) > DocumentLength())
1.1203 + {
1.1204 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_DELSETINSERTCHARFORMATL, "ECharPosBeyondDocument" );
1.1205 + }
1.1206 + __ASSERT_ALWAYS(aPos + (aLength - 1) <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1207 +
1.1208 + TBool parasMerged = EFalse;
1.1209 + if (!IndexPresent())
1.1210 + CPlainText::DeleteL(aPos, aLength);
1.1211 + else
1.1212 + {
1.1213 + parasMerged = iIndex->DelSetInsertCharFormatL(aPos, aLength);
1.1214 + CPlainText::Delete(aPos,aLength);
1.1215 + SetHasChanged(ETrue);
1.1216 + }
1.1217 + iParserData->MergeRange(aPos,aLength,0);
1.1218 + CallEditObserver(aPos,-aLength);
1.1219 +
1.1220 + __TEST_INVARIANT;
1.1221 + return parasMerged;
1.1222 + }
1.1223 +
1.1224 +EXPORT_C void CRichText::CancelInsertCharFormat()
1.1225 +/** Cancels the "insert pending" state set by a call to SetInsertCharFormatL()
1.1226 +or DelSetInsertCharFormatL().
1.1227 +
1.1228 +This function removes the restriction on the text insertion position imposed
1.1229 +by these two functions. It is recommended that it is called before every cursor
1.1230 +movement, scroll, paste, etc. This call is a small overhead, and has no effect
1.1231 +if not applicable. */
1.1232 + {
1.1233 + // Cancels the transitory state where a specified character format
1.1234 + // is applied *on top of* any inherited formatting. eg, when bold is on.
1.1235 + // Cancel when: (1) the text position is altered. (2) the first character
1.1236 + // has been inserted following the setting of this state.
1.1237 + //
1.1238 + if (IndexPresent() && iIndex->InsertCharFormatIsActive())
1.1239 + {
1.1240 + iIndex->CancelInsertCharFormat();
1.1241 + SetHasChanged(ETrue);
1.1242 + }
1.1243 + }
1.1244 +
1.1245 +EXPORT_C void CRichText::ApplyParaFormatL(const CParaFormat* aFormat, const TParaFormatMask& aMask, TInt aPos, TInt aLength)
1.1246 +/** Applies paragraph formatting to a range of paragraphs. The attributes which
1.1247 +are set in the mask are taken from aFormat and applied. The attributes which
1.1248 +are not set in the mask are not changed.
1.1249 +
1.1250 +The region affected consists of every paragraph containing one or more
1.1251 +characters in the range aPos to aPos+(aLength-1).
1.1252 +
1.1253 +@param aFormat Contains the paragraph format attribute values to apply.
1.1254 +@param aMask Specifies which paragraph format attributes should be affected.
1.1255 +@param aPos The document position of the start of the range.
1.1256 +@param aLength The number of characters in the range. */
1.1257 + {
1.1258 + // Applies the specified format attributes to the paragraphs covering
1.1259 + // character position aPos to aPos+aLength-1.
1.1260 + //
1.1261 + __TEST_INVARIANT;
1.1262 + if (aPos < 0 || aPos > DocumentLength())
1.1263 + {
1.1264 + OstTrace0( TRACE_FATAL, CRICHTEXT_APPLYPARAFORMATL, "ECharPosBeyondDocument" );
1.1265 + }
1.1266 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1267 + if (aLength < 0)
1.1268 + {
1.1269 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_APPLYPARAFORMATL, "EApplyParaFormatNegativeLength" );
1.1270 + }
1.1271 + __ASSERT_ALWAYS(aLength >= 0,Panic(EApplyParaFormatNegativeLength));
1.1272 + if (aPos + (aLength - 1) > DocumentLength())
1.1273 + {
1.1274 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_APPLYPARAFORMATL, "ECharPosBeyondDocument" );
1.1275 + }
1.1276 + __ASSERT_ALWAYS(aPos + (aLength - 1) <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1277 +
1.1278 + CreateAndGenerateMarkupComponentL();
1.1279 + iIndex->ApplyParaFormatL(aFormat, aMask, aPos, aLength);
1.1280 + SetHasChanged(ETrue);
1.1281 +
1.1282 + __TEST_INVARIANT;
1.1283 + }
1.1284 +
1.1285 +EXPORT_C void CRichText::ApplyCharFormatL(const TCharFormat& aFormat, const TCharFormatMask& aMask, TInt aPos, TInt aLength)
1.1286 +/** Applies character formatting to a range of characters. The attributes which
1.1287 +are set in the mask are read from aFormat and applied. The attributes which
1.1288 +are not set in the mask are not changed. The range of characters affected
1.1289 +is from aPos to aPos+(aLength-1) inclusive. The sum of aPos and aLength
1.1290 +must be less than or equal to the document length, or a panic occurs.
1.1291 +
1.1292 +@param aFormat Contains the character format attribute values to apply.
1.1293 +@param aMask Bitmask specifying which character format attributes should be
1.1294 +applied.
1.1295 +@param aPos Document position from which to apply the new character formatting.
1.1296 +Must be greater than or equal to zero, or a panic occurs.
1.1297 +@param aLength The number of characters to which the new formatting should
1.1298 +be applied. Must be greater than or equal to zero, or a panic occurs. If the
1.1299 +length is zero, the function has the same effect as SetInsertCharFormatL(). */
1.1300 + {
1.1301 + // Applies the specified character formatting to the characters conatined within the range
1.1302 + // aPos to aPos+(aLength-1).
1.1303 + // If aLength is zero, the SetInsertCharFormat state is called.
1.1304 + //
1.1305 + __ETEXT_WATCH(APPLY_CHAR_FORMAT);
1.1306 + __TEST_INVARIANT;
1.1307 +
1.1308 + TInt document_length = DocumentLength();
1.1309 + if (aPos < 0)
1.1310 + {
1.1311 + OstTrace0( TRACE_FATAL, CRICHTEXT_APPLYCHARFORMATL, "ECharPosBeyondDocument" );
1.1312 + }
1.1313 + __ASSERT_ALWAYS(aPos >= 0,Panic(ECharPosBeyondDocument));
1.1314 + if (aLength < 0)
1.1315 + {
1.1316 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_APPLYCHARFORMATL, "EApplyCharFormatNegativeLength" );
1.1317 + }
1.1318 + __ASSERT_ALWAYS(aLength >= 0,Panic(EApplyCharFormatNegativeLength));
1.1319 + if (aPos + aLength - 1 > document_length)
1.1320 + {
1.1321 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_APPLYCHARFORMATL, "ECharPosBeyondDocument" );
1.1322 + }
1.1323 + __ASSERT_ALWAYS(aPos + aLength - 1 <= document_length,Panic(ECharPosBeyondDocument));
1.1324 +
1.1325 + //If some characters are highlighted AND current position + highlighted txt = document length
1.1326 + // Fix for INC097216. Compensate for the changes introduced to Form in defect fix INC087637,
1.1327 + // which now considers the height of the EOD character; meaning that this character now
1.1328 + // needs to be formatted along with rest of text.
1.1329 + if ((aLength > 0) && (aPos + aLength == document_length))
1.1330 + {
1.1331 + aLength++;
1.1332 + }
1.1333 +
1.1334 + DoApplyExtendedCharFormatL(aFormat, aMask, aPos, aLength);
1.1335 +
1.1336 + __TEST_INVARIANT;
1.1337 + __ETEXT_WATCH_END(APPLY_CHAR_FORMAT);
1.1338 + }
1.1339 +
1.1340 +// This method is used internally only. It does not format the EOD character.
1.1341 +void CRichText::ApplyExtendedCharFormatL(const TCharFormatX& aFormat,const TCharFormatXMask& aMask,TInt aPos,TInt aLength)
1.1342 + {
1.1343 + TInt document_length = DocumentLength();
1.1344 + if (aPos < 0)
1.1345 + {
1.1346 + OstTrace0( TRACE_FATAL, CRICHTEXT_APPLYEXTENDEDCHARFORMATL, "ECharPosBeyondDocument" );
1.1347 + }
1.1348 + __ASSERT_ALWAYS(aPos >= 0,Panic(ECharPosBeyondDocument));
1.1349 + if (aLength < 0)
1.1350 + {
1.1351 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_APPLYEXTENDEDCHARFORMATL, "EApplyCharFormatNegativeLength" );
1.1352 + }
1.1353 + __ASSERT_ALWAYS(aLength >= 0,Panic(EApplyCharFormatNegativeLength));
1.1354 + if (aPos + aLength - 1 > document_length)
1.1355 + {
1.1356 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_APPLYEXTENDEDCHARFORMATL, "ECharPosBeyondDocument" );
1.1357 + }
1.1358 + __ASSERT_ALWAYS(aPos + aLength - 1 <= document_length,Panic(ECharPosBeyondDocument));
1.1359 +
1.1360 + DoApplyExtendedCharFormatL(aFormat, aMask, aPos, aLength);
1.1361 + }
1.1362 +
1.1363 +// Apply the extended character formatting.
1.1364 +void CRichText::DoApplyExtendedCharFormatL(const TCharFormatX& aFormat,const TCharFormatXMask& aMask,TInt aPos,TInt aLength)
1.1365 + {
1.1366 + if (aLength > 0)
1.1367 + {
1.1368 + CreateAndGenerateMarkupComponentL();
1.1369 + iIndex->ApplyCharFormatL(aFormat,aMask,aPos,aLength);
1.1370 + SetHasChanged(ETrue);
1.1371 + }
1.1372 + else
1.1373 + SetExtendedInsertCharFormatL(aFormat,aMask,aPos);
1.1374 + }
1.1375 +
1.1376 +EXPORT_C void CRichText::SetStyleListExternallyOwned(const CStyleList& aStyleList)
1.1377 +/** Assigns an externally owned style list to the rich text object.
1.1378 +Replaces any previous style list used by the object. Calls
1.1379 +SetStyleListExternallyOwned(ETrue).
1.1380 +
1.1381 +@param aExternallyOwned The style list to assign to this rich text object.
1.1382 +Not owned by the rich text object. */
1.1383 + {
1.1384 + CStyleList* styleList = CONST_CAST(CStyleList*, &aStyleList);
1.1385 + iStyleList = styleList;
1.1386 + SetStyleListExternallyOwned(ETrue);
1.1387 + }
1.1388 +
1.1389 +EXPORT_C void CRichText::ApplyParagraphStyleL(const CParagraphStyle& aStyle, TInt aPos, TInt aLength, CParagraphStyle::TApplyParaStyleMode aMode)
1.1390 +/** Applies a specified paragraph style to a range of paragraphs. The region
1.1391 +affected consists of every paragraph containing one or more characters in the
1.1392 +range aPos to aPos+(aLength-1).
1.1393 +
1.1394 +A panic occurs if:
1.1395 +
1.1396 +aPos is invalid, or
1.1397 +
1.1398 +aLength is negative, or
1.1399 +
1.1400 +the range goes beyond the end of the document, or
1.1401 +
1.1402 +the rich text object has no style list
1.1403 +
1.1404 +@param aStyle The style to apply.
1.1405 +@param aPos The document position of the start of the range.
1.1406 +@param aLength The number of characters in the range.
1.1407 +@param aMode Controls what specific formatting, if any, should be preserved
1.1408 +when the style is applied. */
1.1409 + {
1.1410 + // Applies the specified paragraph style to the paragraphs covering
1.1411 + // character positions aPos to aPos+aLength-1.
1.1412 + //
1.1413 + __TEST_INVARIANT;
1.1414 + if (aPos < 0 || aPos > DocumentLength())
1.1415 + {
1.1416 + OstTrace0( TRACE_FATAL, CRICHTEXT_APPLYPARAGRAPHSTYLEL, "ECharPosBeyondDocument" );
1.1417 + }
1.1418 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1419 + if (aLength < 0)
1.1420 + {
1.1421 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_APPLYPARAGRAPHSTYLEL, "EApplyParaStyleNegativeLength" );
1.1422 + }
1.1423 + __ASSERT_ALWAYS(aLength >= 0, Panic(EApplyParaStyleNegativeLength));
1.1424 + if (aPos + (aLength - 1) > DocumentLength())
1.1425 + {
1.1426 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_APPLYPARAGRAPHSTYLEL, "ECharPosBeyondDocument" );
1.1427 + }
1.1428 + __ASSERT_ALWAYS(aPos + (aLength - 1) <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1429 + if (!StyleListPresent())
1.1430 + {
1.1431 + OstTrace0( TRACE_FATAL, DUP3_CRICHTEXT_APPLYPARAGRAPHSTYLEL, "ERichTextNotSetForUsingStyles" );
1.1432 + }
1.1433 + __ASSERT_ALWAYS(StyleListPresent(), Panic(ERichTextNotSetForUsingStyles));
1.1434 +
1.1435 + CreateAndGenerateMarkupComponentL();
1.1436 + iIndex->ApplyParagraphStyleL(aStyle, aPos, aLength, iGlobalCharFormatLayer, aMode);
1.1437 + SetHasChanged(ETrue);
1.1438 +
1.1439 + __TEST_INVARIANT;
1.1440 + }
1.1441 +
1.1442 +EXPORT_C void CRichText::NotifyStyleChangedL(const CParagraphStyle* aTo, const CParagraphStyle* aFrom)
1.1443 +/** Removes a style from every paragraph in the document to which it applies,
1.1444 +and replaces it with another.
1.1445 +
1.1446 +If style aTo is NULL, aFrom is replaced by the global character and paragraph
1.1447 +format layers, so that in effect, style aFrom is removed. Any specific
1.1448 +formatting which has been applied to the paragraphs is retained.
1.1449 +
1.1450 +Notes:
1.1451 +
1.1452 +This function should be called on the text content object after changing a
1.1453 +style in the style list.
1.1454 +
1.1455 +A panic occurs if the rich text object does not use a style list (this can
1.1456 +be tested for using StyleListPresent()).
1.1457 +
1.1458 +@param aTo The new paragraph style to apply.
1.1459 +@param aFrom The paragraph style to remove. */
1.1460 + {
1.1461 + // Update the rich text index following the change of an applied paragraph style.
1.1462 + //
1.1463 + __TEST_INVARIANT;
1.1464 + if (!StyleListPresent())
1.1465 + {
1.1466 + OstTrace0( TRACE_FATAL, CRICHTEXT_NOTIFYSTYLECHANGEDL, "ERichTextNotSetForUsingStyles" );
1.1467 + }
1.1468 + __ASSERT_ALWAYS(StyleListPresent(), Panic(ERichTextNotSetForUsingStyles));
1.1469 +
1.1470 + CreateAndGenerateMarkupComponentL();
1.1471 + iIndex->NotifyStyleChangedL(aTo, aFrom, *iGlobalParaFormatLayer, *iGlobalCharFormatLayer);
1.1472 + SetHasChanged(ETrue);
1.1473 +
1.1474 + __TEST_INVARIANT;
1.1475 + }
1.1476 +
1.1477 +EXPORT_C const CParaFormatLayer* CRichText::ParagraphStyle(TBool& aStyleChangesOverRange, TInt aPos, TInt aLength) const
1.1478 +/** Gets a pointer to the first paragraph style encountered in the specified
1.1479 +range.
1.1480 +
1.1481 +@param aStyleChangesOverRange On return, set to ETrue if more than one paragraph
1.1482 +style is used over the specified range of characters. Otherwise EFalse
1.1483 +@param aPos The document position of the start of the range. Must be valid.
1.1484 +@param aLength The number of characters in the range. Must be greater than
1.1485 +or equal to zero.
1.1486 +@return Pointer to the paragraph style which applies to the paragraph containing
1.1487 +document position aPos. Its type (returned by CParaFormatLayer::Type())
1.1488 +indicates whether this object is a style, or just a paragraph format layer. */
1.1489 + {
1.1490 + __TEST_INVARIANT;
1.1491 + if (aPos < 0 || aPos > DocumentLength())
1.1492 + {
1.1493 + OstTrace0( TRACE_FATAL, CRICHTEXT_PARAGRAPHSTYLE, "ECharPosBeyondDocument" );
1.1494 + }
1.1495 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1496 + if (aLength < 0)
1.1497 + {
1.1498 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_PARAGRAPHSTYLE, "EParagraphStyleNegativeLength" );
1.1499 + }
1.1500 + __ASSERT_ALWAYS(aLength >= 0,Panic(EParagraphStyleNegativeLength));
1.1501 + if (aPos + (aLength - 1) > DocumentLength())
1.1502 + {
1.1503 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_PARAGRAPHSTYLE, "ECharPosBeyondDocument" );
1.1504 + }
1.1505 + __ASSERT_ALWAYS(aPos + (aLength - 1) <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1506 +
1.1507 + if (IndexPresent())
1.1508 + return iIndex->ParagraphStyle(aStyleChangesOverRange, aPos, aLength);
1.1509 + else
1.1510 + {
1.1511 + aStyleChangesOverRange = EFalse;
1.1512 + return iGlobalParaFormatLayer;
1.1513 + }
1.1514 + }
1.1515 +
1.1516 +EXPORT_C void CRichText::SetHasChanged(TBool aHasChanged)
1.1517 +/** Sets whether the document's content or formatting has changed. This function
1.1518 +is called with an value of ETrue by all functions which modify the text content
1.1519 +or formatting. Use CEditableText::HasChanged() to test whether the document
1.1520 +has changed.
1.1521 +
1.1522 +@param aHasChanged ETrue if the text object has been changed, EFalse if not. */
1.1523 + {
1.1524 + // Replaces the base class method of the same name.
1.1525 + //
1.1526 + if (aHasChanged && IndexPresent())
1.1527 + iIndex->DocumentChanged();
1.1528 + CGlobalText::SetHasChanged(aHasChanged);
1.1529 + }
1.1530 +
1.1531 +EXPORT_C void CRichText::RemoveSpecificParaFormatL(TInt aPos, TInt aLength)
1.1532 +/** Removes all specific paragraph formatting from a range of paragraphs. This
1.1533 +does not remove formatting from the object's global paragraph format layer.
1.1534 +The region affected consists of every paragraph containing one or more
1.1535 +characters in the range covered by document position aPos to aPos+(aLength-1)
1.1536 +inclusive.
1.1537 +
1.1538 +A panic occurs in the following situations:
1.1539 +
1.1540 +the position is negative,
1.1541 +
1.1542 +the length is negative,
1.1543 +
1.1544 +the range goes beyond the end of the document
1.1545 +
1.1546 +@param aPos The document position of the start of the range.
1.1547 +@param aLength The number of characters in the range. */
1.1548 + {
1.1549 + // Removes all specific paragraph formatting from the selected region.
1.1550 + //
1.1551 + __ETEXT_WATCH(REMOVE_PARA_FORMAT);
1.1552 +
1.1553 + __TEST_INVARIANT;
1.1554 +
1.1555 + if (aPos < 0 || aPos > DocumentLength())
1.1556 + {
1.1557 + OstTrace0( TRACE_FATAL, CRICHTEXT_REMOVESPECIFICPARAFORMATL, "ECharPosBeyondDocument" );
1.1558 + }
1.1559 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1560 + if (aLength < 0)
1.1561 + {
1.1562 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_REMOVESPECIFICPARAFORMATL, "ERemoveSpecificParaFormatNegativeLength" );
1.1563 + }
1.1564 + __ASSERT_ALWAYS(aLength >= 0, Panic(ERemoveSpecificParaFormatNegativeLength));
1.1565 + if (aPos + (aLength - 1) > DocumentLength())
1.1566 + {
1.1567 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_REMOVESPECIFICPARAFORMATL, "ECharPosBeyondDocument" );
1.1568 + }
1.1569 + __ASSERT_ALWAYS(aPos + (aLength - 1) <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1570 +
1.1571 + if (IndexPresent())
1.1572 + {
1.1573 + iIndex->RemoveSpecificParaFormatL(aPos, aLength);
1.1574 + SetHasChanged(ETrue);
1.1575 + }
1.1576 +
1.1577 + __TEST_INVARIANT;
1.1578 +
1.1579 + __ETEXT_WATCH_END(REMOVE_PARA_FORMAT);
1.1580 + }
1.1581 +
1.1582 +EXPORT_C void CRichText::RemoveSpecificCharFormatL(TInt aPos, TInt aLength)
1.1583 +/** Removes all specific character formatting from a range of characters (does
1.1584 +not remove the formatting which has been taken from the object's global character
1.1585 +format layer). A panic occurs in the following situations:
1.1586 +
1.1587 +the position is negative,
1.1588 +
1.1589 +the length is negative,
1.1590 +
1.1591 +the range goes beyond the end of the document
1.1592 +
1.1593 +@param aPos The document position of the start of the region affected.
1.1594 +@param aLength The number of characters in the region affected. If zero, the
1.1595 +function has no effect. */
1.1596 + {
1.1597 + __TEST_INVARIANT;
1.1598 +
1.1599 + TInt document_length = DocumentLength();
1.1600 + if (aPos < 0 || aPos > DocumentLength())
1.1601 + {
1.1602 + OstTrace0( TRACE_FATAL, CRICHTEXT_REMOVESPECIFICCHARFORMATL, "ECharPosBeyondDocument" );
1.1603 + }
1.1604 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1605 + if (aLength < 0)
1.1606 + {
1.1607 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_REMOVESPECIFICCHARFORMATL, "ERemoveSpecificParaFormatNegativeLength" );
1.1608 + }
1.1609 + __ASSERT_ALWAYS(aLength >= 0, Panic(ERemoveSpecificParaFormatNegativeLength));
1.1610 + if (aPos + (aLength - 1) > DocumentLength())
1.1611 + {
1.1612 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_REMOVESPECIFICCHARFORMATL, "ECharPosBeyondDocument" );
1.1613 + }
1.1614 + __ASSERT_ALWAYS(aPos + (aLength - 1) <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1615 +
1.1616 + // in correspondance to INC097216, character format removing considers the height of end of document
1.1617 + // character
1.1618 + if (aPos + aLength == document_length)
1.1619 + {
1.1620 + aLength++;
1.1621 + }
1.1622 +
1.1623 + if (aLength > 0 && IndexPresent())
1.1624 + {
1.1625 + iIndex->RemoveSpecificCharFormatL(aPos, aLength);
1.1626 + SetHasChanged(ETrue);
1.1627 + }
1.1628 +
1.1629 + __TEST_INVARIANT;
1.1630 + }
1.1631 +
1.1632 +EXPORT_C void CRichText::GetChars(TPtrC& aText, TCharFormat& aFormat, TInt aPos) const
1.1633 +/** Gets a constant pointer descriptor to a portion of the text object
1.1634 +with constant character formatting.
1.1635 +
1.1636 +The view starts at the document position specified, and ends at: the
1.1637 +last character which shares the same character formatting, orthe end
1.1638 +of the document, orthe end of the segment, if segmented storage is
1.1639 +being usedwhichever occurs first. Also fills a character format object
1.1640 +with the character formatting of the range of characters.
1.1641 +
1.1642 +@param aView On return, a constant pointer to a portion of the text.
1.1643 +@param aFormat On return, contains the character formatting of the text.
1.1644 +@param aPos The start position for the view. Must be a valid document
1.1645 +position, or a panic occurs. */
1.1646 + {
1.1647 + // Get a run of text and its format, starting at aPos.
1.1648 + __ETEXT_WATCH(GET_CHARS)
1.1649 + TCharFormatX format;
1.1650 + GetTextAndExtendedFormat(aText, format, aPos);
1.1651 + OverrideFormatForParsersIfApplicable(aText, format, aPos);
1.1652 + aFormat = format.iCharFormat;
1.1653 + OverrideFormatOfInlineTextIfApplicable(aText, aFormat, aPos);
1.1654 + __ETEXT_WATCH_END(GET_CHARS)
1.1655 + }
1.1656 +
1.1657 +
1.1658 +void CRichText::GetTextAndExtendedFormat(TPtrC& aText,TCharFormatX& aFormat,TInt aPos) const
1.1659 + {
1.1660 + __TEST_INVARIANT;
1.1661 + TInt documentLength = DocumentLength();
1.1662 + if (aPos < 0 || aPos > documentLength)
1.1663 + {
1.1664 + OstTrace0( TRACE_FATAL, CRICHTEXT_GETTEXTANDEXTENDEDFORMAT, "ECharPosBeyondDocument" );
1.1665 + }
1.1666 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= documentLength, Panic(ECharPosBeyondDocument));
1.1667 + if (!IndexPresent())
1.1668 + {
1.1669 + aText.Set(Read(aPos));
1.1670 + iGlobalCharFormatLayer->SenseEffective(aFormat);
1.1671 + }
1.1672 + else
1.1673 + {
1.1674 + int phrase_length = iIndex->GetChars(aFormat,aPos);
1.1675 + aText.Set(Read(aPos,phrase_length));
1.1676 + }
1.1677 + __TEST_INVARIANT;
1.1678 + }
1.1679 +
1.1680 +EXPORT_C TInt CRichText::GetPictureSizeInTwips(TSize& aSize, TInt aPos) const
1.1681 +/** Gets the size of a picture located at a specified document position.
1.1682 +
1.1683 +@param aSize On return, contains the size of the picture located at aPos.
1.1684 +@param aPos Document position of the picture. Must be a valid position.
1.1685 +@return KErrNotFound if there is no picture at the specified document position,
1.1686 +KErrNone if there is. */
1.1687 + {
1.1688 + __TEST_INVARIANT;
1.1689 + if (aPos < 0 || aPos > DocumentLength())
1.1690 + {
1.1691 + OstTrace0( TRACE_FATAL, CRICHTEXT_GETPICTURESIZEINTWIPS, "ECharPosBeyondDocument" );
1.1692 + }
1.1693 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1694 +
1.1695 + if (IndexPresent())
1.1696 + return iIndex->GetPictureSizeInTwips(aSize, aPos);
1.1697 + else
1.1698 + return KErrNotFound;
1.1699 + }
1.1700 +
1.1701 +EXPORT_C CPicture* CRichText::PictureHandleL(TInt aPos, MLayDoc::TForcePictureLoad aForceLoad) const
1.1702 +/** Gets a pointer to the picture located at a specified document position, if
1.1703 +one exists. If the picture is not in memory, the function loads it (if the
1.1704 +second argument has a value of MLayDoc::EForceLoadTrue).
1.1705 +
1.1706 +Note:
1.1707 +
1.1708 +In order to load the picture, a picture factory and a store resolver must
1.1709 +have been set.
1.1710 +
1.1711 +@param aPos Document position of the picture character. Must be a valid position.
1.1712 +@param aForceLoad If the picture is not loaded into memory,
1.1713 +MLayDoc::EForceLoadTrue loads it using the picture factory;
1.1714 +MLayDoc::EForceLoadFalse does not, and in this case, the function returns NULL.
1.1715 +@return A pointer to the picture located at aPos. NULL if aPos does not specify
1.1716 +a picture character, or if there is a picture at aPos which is not in memory,
1.1717 +and the second argument is MLayDoc::EForceLoadFalse. */
1.1718 + {
1.1719 + __ETEXT_WATCH(PICTURE_HANDLE);
1.1720 +
1.1721 + __TEST_INVARIANT;
1.1722 + if (aPos<0 || aPos>DocumentLength())
1.1723 + {
1.1724 + OstTrace0( TRACE_FATAL, CRICHTEXT_PICTUREHANDLEL, "ECharPosBeyondDocument" );
1.1725 + }
1.1726 + __ASSERT_ALWAYS(aPos>=0 && aPos<=DocumentLength(),Panic(ECharPosBeyondDocument));
1.1727 +
1.1728 + if (IndexPresent())
1.1729 + return iIndex->PictureHandleL(aPos, aForceLoad);
1.1730 + else
1.1731 + return NULL;
1.1732 +
1.1733 + __ETEXT_WATCH_END(PICTURE_HANDLE);
1.1734 + }
1.1735 +
1.1736 +EXPORT_C void CRichText::GetParagraphFormatL(CParaFormat* aFormat, TInt aPos) const
1.1737 +/** Gets the effective paragraph formatting which applies to the paragraph which
1.1738 +contains a specified document position. On return, aFormat is filled with
1.1739 +values for all paragraph format attributes.
1.1740 +
1.1741 +@param aFormat On return, filled with the paragraph's effective paragraph
1.1742 +formatting.
1.1743 +@param aPos Any document position within the paragraph of interest. */
1.1744 + {
1.1745 + __ETEXT_WATCH(GET_PARAGRAPH_FORMAT)
1.1746 +
1.1747 + __TEST_INVARIANT;
1.1748 + if (aPos < 0 || aPos > DocumentLength())
1.1749 + {
1.1750 + OstTrace0( TRACE_FATAL, CRICHTEXT_GETPARAGRAPHFORMATL, "ECharPosBeyondDocument" );
1.1751 + }
1.1752 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1753 +
1.1754 + if (!IndexPresent())
1.1755 + CGlobalText::GetParagraphFormatL(aFormat, aPos);
1.1756 + else
1.1757 + {
1.1758 + aFormat->Reset();
1.1759 + iIndex->GetParagraphFormatL(aFormat, aPos);
1.1760 + }
1.1761 +
1.1762 + __ETEXT_WATCH_END(GET_PARAGRAPH_FORMAT)
1.1763 + }
1.1764 +
1.1765 +EXPORT_C void CRichText::GetSpecificParagraphFormatL(CParaFormat* aFormat,
1.1766 + TParaFormatMask& aMask,
1.1767 + TInt aPos) const
1.1768 +// Fills aFormat with the effective Paragraph format attributes for the paragraph
1.1769 +// in which character position aPos is contained.
1.1770 +//
1.1771 + {
1.1772 + __ETEXT_WATCH(GET_PARAGRAPH_FORMAT)
1.1773 +
1.1774 + __TEST_INVARIANT;
1.1775 + if (aPos < 0 || aPos > DocumentLength())
1.1776 + {
1.1777 + OstTrace0( TRACE_FATAL, CRICHTEXT_GETSPECIFICPARAGRAPHFORMATL, "ECharPosBeyondDocument" );
1.1778 + }
1.1779 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1780 +
1.1781 + aFormat->Reset();
1.1782 + aMask.ClearAll();
1.1783 + if (IndexPresent())
1.1784 + iIndex->GetSpecificParagraphFormatL(aFormat, aMask, aPos);
1.1785 +
1.1786 + __ETEXT_WATCH_END(GET_PARAGRAPH_FORMAT)
1.1787 + }
1.1788 +
1.1789 +EXPORT_C void CRichText::GetParaFormatL(CParaFormat* aFormat, TParaFormatMask& aVaries, TInt aPos, TInt aLength,
1.1790 + CParaFormat::TParaFormatGetMode aMode) const
1.1791 +/** Gets the effective paragraph formatting which applies to a range of paragraphs.
1.1792 +The region involved is every paragraph containing one or more characters in
1.1793 +the range aPos to aPos+(aLength-1) inclusive. On return, aFormat is filled
1.1794 +with values for all paragraph format attributes and the mask indicates the
1.1795 +values that change over the region, and whose value is therefore indeterminate.
1.1796 +
1.1797 +Note:
1.1798 +
1.1799 +If aMode has a value of EFixedAttributes, the function cannot leave.
1.1800 +
1.1801 +@param aFormat Must not be NULL or a panic occurs. On return, contains the
1.1802 +effective paragraph formatting for the range of paragraphs.
1.1803 +@param aVaries On return, a bitmask indicating which paragraph format attributes
1.1804 +vary over the range of characters selected.
1.1805 +@param aPos The document position of the start of the range.
1.1806 +@param aLength The number of characters in the range.
1.1807 +@param aMode The default, EAllAttributes means that values for all paragraph
1.1808 +format attributes are written to aFormat. EFixedAttributes means that tabs,
1.1809 +bullets and borders are not written to aFormat. */
1.1810 + {
1.1811 + // Senses the paragraph format of para(s) covered by the region aPos to aPos+aLength-1.
1.1812 + // aFormat takes the values of all attributes, and the mask aMask indicates those values that change
1.1813 + // over the selected region, and are therefore *indeterminate*.
1.1814 + // Application: seeding paragraph formatting dialogs.
1.1815 + //
1.1816 + __TEST_INVARIANT;
1.1817 + if (aPos < 0 || aPos > DocumentLength())
1.1818 + {
1.1819 + OstTrace0( TRACE_FATAL, CRICHTEXT_GETPARAFORMATL, "ECharPosBeyondDocument" );
1.1820 + }
1.1821 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1822 + if (aLength < 0)
1.1823 + {
1.1824 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_GETPARAFORMATL, "EGetParaFormatNegativeLength" );
1.1825 + }
1.1826 + __ASSERT_ALWAYS(aLength >= 0, Panic(EGetParaFormatNegativeLength));
1.1827 + if (aPos + aLength > DocumentLength())
1.1828 + {
1.1829 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_GETPARAFORMATL, "ECharPosBeyondDocument" );
1.1830 + }
1.1831 + __ASSERT_ALWAYS(aPos + aLength <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1832 +
1.1833 + if (IndexPresent())
1.1834 + iIndex->GetParaFormatL(aFormat, aVaries, aPos, aLength, aMode);
1.1835 + else
1.1836 + CGlobalText::GetParaFormatL(aFormat, aVaries, aPos, aLength, aMode);
1.1837 + }
1.1838 +
1.1839 +EXPORT_C void CRichText::GetCharFormat(TCharFormat& aFormat, TCharFormatMask& aVaries, TInt aPos, TInt aLength) const
1.1840 +/** Gets the effective character formatting which applies to a range of
1.1841 +characters. The range of characters involved is from aPos to aPos+(aLength-1)
1.1842 +inclusive. On return, aFormat is filled with values for all character format
1.1843 +attributes, and on return, the mask indicates the values that change over the
1.1844 +region, and whose value is therefore indeterminate.
1.1845 +
1.1846 +The length value can be zero. In this case, the character formatting sensed
1.1847 +is that of the character immediately to the left of the position specified.
1.1848 +
1.1849 +@param aFormat On return, contains the character format values for the range
1.1850 +of characters.
1.1851 +@param aVaries On return, indicates which character format attributes vary
1.1852 +over the range.
1.1853 +@param aPos Document position of the start of the range. Must be valid or a
1.1854 +panic occurs.
1.1855 +@param aLength Number of characters in the range. Must be greater than or equal
1.1856 +to zero, or a panic occurs. */
1.1857 + {
1.1858 + // Senses the character formatting of the phrase(s) covered by the region aPos to aPos+aLength-1.
1.1859 + // May be called with zero length.
1.1860 + // aFormat takes the values of all character format attributes, and the mask aMask indicates those
1.1861 + // values that change over the selected region, and are therefore *indeterminate*.
1.1862 + // Application: seeding character formatting dialogs.
1.1863 + //
1.1864 + TCharFormatX format;
1.1865 + TCharFormatXMask varies;
1.1866 + GetExtendedCharFormat(format, varies, aPos, aLength);
1.1867 + aFormat = format.iCharFormat;
1.1868 + varies.ClearExtendedAttribs();
1.1869 + aVaries = varies;
1.1870 + }
1.1871 +
1.1872 +
1.1873 +void CRichText::GetExtendedCharFormat(TCharFormatX& aFormat, TCharFormatXMask& aVaries, TInt aPos, TInt aLength) const
1.1874 + {
1.1875 + __TEST_INVARIANT;
1.1876 + int document_length = DocumentLength();
1.1877 + if (aPos < 0 || aPos > document_length)
1.1878 + {
1.1879 + OstTrace0( TRACE_FATAL, CRICHTEXT_GETEXTENDEDCHARFORMAT, "ECharPosBeyondDocument" );
1.1880 + }
1.1881 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= document_length, Panic(ECharPosBeyondDocument));
1.1882 + if (aLength < 0)
1.1883 + {
1.1884 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_GETEXTENDEDCHARFORMAT, "EGetCharFormatNegativeLength" );
1.1885 + }
1.1886 + __ASSERT_ALWAYS(aLength >= 0, Panic(EGetCharFormatNegativeLength));
1.1887 + if (aPos + aLength - 1 > document_length)
1.1888 + {
1.1889 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_GETEXTENDEDCHARFORMAT, "ECharPosBeyondDocument" );
1.1890 + }
1.1891 + __ASSERT_ALWAYS(aPos + aLength - 1 <= document_length, Panic(ECharPosBeyondDocument));
1.1892 +
1.1893 + if (IndexPresent())
1.1894 + iIndex->GetCharFormat(aFormat, aVaries, aPos, aLength);
1.1895 + else
1.1896 + {
1.1897 + iGlobalCharFormatLayer->SenseEffective(aFormat);
1.1898 + aVaries.ClearAll();
1.1899 + }
1.1900 + }
1.1901 +
1.1902 +
1.1903 +void CRichText::GetSpecificCharFormatLeftRight(TCharFormat& aFormat,
1.1904 + TCharFormatMask& aMask,
1.1905 + TInt aPos,
1.1906 + TBool aLeft) const
1.1907 + {
1.1908 + __ETEXT_WATCH(GET_SPECIFIC_CHARS);
1.1909 +
1.1910 + __TEST_INVARIANT;
1.1911 +
1.1912 + if (aPos < 0 || aPos > DocumentLength())
1.1913 + {
1.1914 + OstTrace0( TRACE_FATAL, CRICHTEXT_GETSPECIFICCHARFORMATLEFTRIGHT, "ECharPosBeyondDocument" );
1.1915 + }
1.1916 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= DocumentLength(), Panic(ECharPosBeyondDocument));
1.1917 +
1.1918 + if (IndexPresent())
1.1919 + {
1.1920 + TCharFormatX format;
1.1921 + TCharFormatXMask mask;
1.1922 + iIndex->GetSpecificCharFormatDirection(format, mask, aPos, aLeft);
1.1923 + aFormat = format.iCharFormat;
1.1924 + mask.ClearExtendedAttribs();
1.1925 + aMask = mask;
1.1926 + }
1.1927 +
1.1928 + __ETEXT_WATCH_END(GET_SPECIFIC_CHARS);
1.1929 + }
1.1930 +
1.1931 +EXPORT_C void CRichText::GetSpecificCharFormat(TCharFormat& aFormat, TCharFormatMask& aMask, TInt aPos) const
1.1932 +/** Gets the specific character formatting which applies to the character to the
1.1933 +left of a document position. Specific formatting is just the formatting which
1.1934 +has been applied over the object's global format layers - it is not the
1.1935 +same as the effective formatting.
1.1936 +
1.1937 +@param aFormat On return contains the specific character formatting which
1.1938 +applies to the character to the left of the document position.
1.1939 +@param aMask On return, indicates which character format attributes have been
1.1940 +applied specifically, (not taken from the global layers).
1.1941 +@param aPos The document position. Must be valid or a panic occurs. */
1.1942 + {
1.1943 + // Return the format attributes store in the specific layer only, for the specified document position.
1.1944 + // THIS IS NOT THE EFFECTIVE FORMAT, BUT THE SPECIFIC FORMATTING ONLY.
1.1945 + //
1.1946 + GetSpecificCharFormatLeftRight(aFormat, aMask, aPos, ETrue);
1.1947 + }
1.1948 +
1.1949 +EXPORT_C void CRichText::GetSpecificCharFormatRight(TCharFormat& aFormat, TCharFormatMask& aMask, TInt aPos) const
1.1950 +/** Gets the specific character formatting which applies to the character logically
1.1951 +after a document position. Note that this is not necessarily the character
1.1952 +to the right of the document position, because right to left text is supported.
1.1953 +
1.1954 +Specific formatting is just the formatting which has been applied over the
1.1955 +object's global format layers it is not the same as the effective formatting.
1.1956 +
1.1957 +@param aFormat On return, contains the specific character formatting which
1.1958 +applies to the character logically after the document position.
1.1959 +@param aMask On return, indicates which character format attributes have been
1.1960 +applied specifically, (not taken from the global layers).
1.1961 +@param aPos The document position. Must be valid or a panic occurs. */
1.1962 + {
1.1963 + GetSpecificCharFormatLeftRight(aFormat, aMask, aPos, EFalse);
1.1964 + }
1.1965 +
1.1966 +TBool CRichText::IndexPresent()const
1.1967 +// Returns ETrue if the rich text index is present, otherwise
1.1968 +// returns EFalse.
1.1969 +//
1.1970 + {
1.1971 + return iIndex.IsPtr() && iIndex.AsPtr();
1.1972 + }
1.1973 +
1.1974 +
1.1975 +EXPORT_C TInt CRichText::PictureCount() const
1.1976 +/** Gets a count of the number of pictures contained in the rich text object.
1.1977 +
1.1978 +@return The picture count. */
1.1979 + {return (IndexPresent()) ? iIndex->iPictureCount : 0;}
1.1980 +
1.1981 +
1.1982 +void CRichText::SetParaTypeIsSingle(TBool aBool)
1.1983 + {
1.1984 + if (aBool)
1.1985 + iFlags |= KParaTypeIsSingle;
1.1986 + else
1.1987 + iFlags &= ~KParaTypeIsSingle;
1.1988 + }
1.1989 +
1.1990 +
1.1991 +TBool CRichText::ParaTypeIsSingle() const
1.1992 + {return iFlags & KParaTypeIsSingle;}
1.1993 +
1.1994 +
1.1995 +EXPORT_C void CRichText::AppendTakingSolePictureOwnershipL(const CRichText& aSource)
1.1996 +/** Appends a rich text object to this one. The text is appended immediately after
1.1997 +the end-of-text paragraph delimiter. The incoming text's formatting is set
1.1998 +to be based on the global formatting of this rich text object.
1.1999 +
1.2000 +Notes:
1.2001 +
1.2002 +If this rich text object is empty (e.g. because it is newly initialised, or
1.2003 +has been reset), then the end-of-text delimiter of the incoming rich text
1.2004 +is not appended. This avoids the possibility of having a trailing paragraph
1.2005 +delimiter, giving one more empty line than would typically be desired.
1.2006 +
1.2007 +If the incoming rich text contains pictures which have been loaded into memory,
1.2008 +their sole ownership is transferred to the current rich text object. In aSource,
1.2009 +these picture handles are set to NULL.
1.2010 +
1.2011 +@param aSource The rich text object to append. */
1.2012 + {
1.2013 + // Appends the specified rich text object to this one.
1.2014 + // If this rich text is empty or has been newly initialised or reset, then the final paragraph delimiter
1.2015 + // of the incoming rich text is NOT appended, thus avoiding the prospect of having a trailing, empty
1.2016 + // paragraph delimiter, giving one more empty line than would typically be desired.
1.2017 + //
1.2018 + __ETEXT_WATCH(APPEND_RICH_TEXT);
1.2019 +
1.2020 + // Append the text
1.2021 + const TInt thisDocumentLength = DocumentLength();
1.2022 + MPictureFactory* factory = NULL;
1.2023 + MRichTextStoreResolver* resolver = NULL;
1.2024 + if (thisDocumentLength == 0) // this is an empty document
1.2025 + {
1.2026 + factory = iPictureFactory;
1.2027 + resolver = iStoreResolver;
1.2028 + Reset(); // destroy the markup component if it exists. Makes the job easier
1.2029 + }
1.2030 + //
1.2031 + PrepareAppendMarkupL(aSource); // requires no rollback - objects in a (bigger) stable state
1.2032 + //
1.2033 + TRAPD(ret, DoAppendTakingSolePictureOwnershipL(aSource));
1.2034 + if (ret != KErrNone)
1.2035 + {
1.2036 + CPlainText::Delete(thisDocumentLength,DocumentLength() - thisDocumentLength);
1.2037 + User::Leave(ret);
1.2038 + }
1.2039 + if (thisDocumentLength == 0)
1.2040 + {
1.2041 + DeleteParagraph(0, 1); // remove excess first paragraph from empty documents
1.2042 + SetPictureFactory(factory, resolver);
1.2043 + }
1.2044 + int new_length = DocumentLength() - thisDocumentLength;
1.2045 + iParserData->MergeRange(thisDocumentLength,0,new_length);
1.2046 + CallEditObserver(thisDocumentLength,new_length);
1.2047 +
1.2048 + __TEST_INVARIANT;
1.2049 +
1.2050 + __ETEXT_WATCH_END(APPEND_RICH_TEXT);
1.2051 + }
1.2052 +
1.2053 +
1.2054 +void CRichText::DoAppendTakingSolePictureOwnershipL(const CRichText& aSource)
1.2055 + {
1.2056 + TInt lengthRemaining = aSource.DocumentLength() + 1; // we want to append the para delimiters also!
1.2057 + TInt consumed = 0;
1.2058 + FOREVER
1.2059 + {
1.2060 + TPtrC view = aSource.Read(consumed);
1.2061 + if (view.Length() > lengthRemaining)
1.2062 + view.Set(view.Ptr(), lengthRemaining);
1.2063 + CPlainText::DoPtInsertL(DocumentLength() + 1, view); // insert AFTER the final paragraph delimiter
1.2064 + TInt viewLength = view.Length();
1.2065 + lengthRemaining -= viewLength;
1.2066 + if (lengthRemaining == 0)
1.2067 + break;
1.2068 + consumed += viewLength;
1.2069 + }
1.2070 +
1.2071 + if (IndexPresent())
1.2072 + {
1.2073 + if (!aSource.IndexPresent())
1.2074 + {
1.2075 + OstTrace0( TRACE_DUMP, DUP1_CRICHTEXT_DOAPPENDTAKINGSOLEPICTUREOWNERSHIPL, "Invariant" );
1.2076 + }
1.2077 + __ASSERT_DEBUG(aSource.IndexPresent(), User::Invariant()); // PrepareAppend should have sorted this
1.2078 +
1.2079 + TGlobalLayerInfoAppend info(GlobalParaFormatLayer(), GlobalCharFormatLayer(), aSource.GlobalParaFormatLayer(), aSource.GlobalCharFormatLayer());
1.2080 + iIndex->AppendTakingSolePictureOwnershipL(aSource.iIndex, info);
1.2081 + }
1.2082 +
1.2083 + __TEST_INVARIANT;
1.2084 + }
1.2085 +
1.2086 +
1.2087 +void CRichText::PrepareAppendMarkupL(const CRichText& aSource)
1.2088 +// Guarantees that both the component and aggregate objects have a valid markup component.
1.2089 +//
1.2090 + {
1.2091 + if (aSource.HasMarkupData() && !HasMarkupData())
1.2092 + CreateAndGenerateMarkupComponentL();
1.2093 + else if (IndexPresent())
1.2094 + CONST_CAST(CRichText&, aSource).CreateAndGenerateMarkupComponentL();
1.2095 + }
1.2096 +
1.2097 +
1.2098 +EXPORT_C void CRichText::AppendParagraphL(TInt aReplicas)
1.2099 +/** Appends one or more empty paragraphs to the document. The new paragraphs take
1.2100 +on the formatting specified in the global format layers.
1.2101 +
1.2102 +@param aReplicas The number of empty paragraphs to append to the document.
1.2103 +By default, a single paragraph. */
1.2104 + {
1.2105 + // Inserts an empty paragraph at the end of the document.
1.2106 + // The new paragraph takes on the format as described
1.2107 + // by the global format layers.
1.2108 + //
1.2109 + __ETEXT_WATCH(APPEND_PARAGRAPH);
1.2110 +
1.2111 + __TEST_INVARIANT;
1.2112 +
1.2113 + TInt documentLength = DocumentLength();
1.2114 + if (aReplicas == 1)
1.2115 + CPlainText::InsertL(documentLength, CEditableText::EParagraphDelimiter);
1.2116 + else
1.2117 + {
1.2118 + HBufC* bb = HBufC::NewLC(aReplicas);
1.2119 + TPtr buf = bb->Des();
1.2120 + buf.Fill(CEditableText::EParagraphDelimiter, aReplicas);
1.2121 + CPlainText::InsertL(documentLength, buf);
1.2122 + CleanupStack::PopAndDestroy(); // bb
1.2123 + }
1.2124 + //
1.2125 + if (IndexPresent())
1.2126 + {
1.2127 + TRAPD(ret,
1.2128 + iIndex->AppendParagraphL(iGlobalParaFormatLayer, iGlobalCharFormatLayer, aReplicas));
1.2129 + if (ret != KErrNone)
1.2130 + {
1.2131 + CPlainText::Delete(DocumentLength() - aReplicas, aReplicas);
1.2132 + User::Leave(ret);
1.2133 + }
1.2134 + SetHasChanged(ETrue);
1.2135 + }
1.2136 +
1.2137 + int new_length = DocumentLength() - documentLength;
1.2138 + iParserData->MergeRange(documentLength,0,new_length);
1.2139 + CallEditObserver(documentLength,new_length);
1.2140 + __TEST_INVARIANT;
1.2141 +
1.2142 + __ETEXT_WATCH_END(APPEND_PARAGRAPH);
1.2143 + }