Symaptic: os/textandloc/textrendering/texthandling/stext/TXTGLOBL.CPP@260cb5ec6c19

     1 /*

     2 * Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 *

    16 */

    19 #include <e32std.h>

    20 #include <e32base.h>

    21 #include <gdi.h>

    23 #include "TXTFMLYR.H"

    24 #include "TXTGLOBL.H"

    26 #include "TXTSTD.H"

    27 #include "OstTraceDefinitions.h"

    28 #ifdef OST_TRACE_COMPILER_IN_USE

    29 #include "TXTGLOBLTraces.h"

    30 #endif

    33 /**

    34 @internalAll

    35 */

    36 EXPORT_C void MLayDoc::MLayDoc_Reserved_1() {}

    37 EXPORT_C void CGlobalText::__DbgTestInvariant()const

    38 // Class Invariants.

    39 //

    40 	{

    41 #ifdef _DEBUG

    42 // ASSERT: The global format layers are never null.

    43 	__ASSERT_DEBUG(iGlobalParaFormatLayer!=NULL,User::Invariant());

    44 	__ASSERT_DEBUG(iGlobalCharFormatLayer!=NULL,User::Invariant());

    45 #endif

    46 	}

    49 EXPORT_C CGlobalText* CGlobalText::NewL(const CParaFormatLayer* aGlobalParaLayer,const CCharFormatLayer* aGlobalCharLayer,

    50 										TDocumentStorage aStorage,TInt aDefaultTextGranularity)

    51 /** Allocates and constructs an empty global text object with a paragraph and a

    52 character format layer. A single end-of-document delimiter is inserted.

    54 @param aGlobalParaLayer Pointer to the paragraph format layer referenced by

    55 the text object. Must not be NULL, or a panic occurs.

    56 @param aGlobalCharLayer Pointer to the character format layer referenced by

    57 the text object. Must not be NULL, or a panic occurs.

    58 @param aStorage The type of in-memory buffer to use. Defaults to

    59 ESegmentedStorage.

    60 @param aDefaultTextGranularity Specifies the granularity of the in-memory buffer.

    61 Default is EDefaultTextGranularity bytes (=256).

    62 @return Pointer to the global text object. */

    63 	{

    64 	if (aGlobalParaLayer==NULL)

    65 	    {

    66 	    OstTrace0( TRACE_FATAL, CGLOBALTEXT_NEWL, "ENullFormatLayerHandle" );

    67 	    }

    68 	__ASSERT_ALWAYS(aGlobalParaLayer!=NULL,Panic(ENullFormatLayerHandle));

    69 	if (aGlobalCharLayer==NULL)

    70 	    {

    71 	    OstTrace0( TRACE_FATAL, DUP1_CGLOBALTEXT_NEWL, "ENullFormatLayerHandle" );

    72 	    }

    73 	__ASSERT_ALWAYS(aGlobalCharLayer!=NULL,Panic(ENullFormatLayerHandle));

    75 	CGlobalText* self=new(ELeave) CGlobalText(aGlobalParaLayer,aGlobalCharLayer);

    76 	CleanupStack::PushL(self);

    77 	self->ConstructL(aStorage,aDefaultTextGranularity);

    78 	CleanupStack::Pop();

    79 	return self;

    80 	}

    82 EXPORT_C CGlobalText* CGlobalText::NewL(const CStreamStore& aStore,TStreamId aStreamId,

    83 										const CParaFormatLayer* aGlobalParaLayer,const CCharFormatLayer* aGlobalCharLayer,

    84 										MTextFieldFactory* aFactory,

    85 										TDocumentStorage aStorage)

    86 /** Returns a handle to a new instance of this class, whose textual content is

    87 restored from the specified read-stream.  The global text object *uses* (does

    88 not own) the supplied global format layers.*/

    89 	{

    90 	if (aGlobalParaLayer==NULL)

    91 	    {

    92 	    OstTrace0( TRACE_FATAL, DUP2_CGLOBALTEXT_NEWL, "ENullFormatLayerHandle" );

    93 	    }

    94 	__ASSERT_ALWAYS(aGlobalParaLayer!=NULL,Panic(ENullFormatLayerHandle));

    95 	if (aGlobalCharLayer==NULL)

    96 	    {

    97 	    OstTrace0( TRACE_FATAL, DUP3_CGLOBALTEXT_NEWL, "ENullFormatLayerHandle" );

    98 	    }

    99 	__ASSERT_ALWAYS(aGlobalCharLayer!=NULL,Panic(ENullFormatLayerHandle));

   101 	CGlobalText* self=new(ELeave) CGlobalText(aGlobalParaLayer,aGlobalCharLayer);

   102 	CleanupStack::PushL(self);

   103 	self->ConstructL(aStore,aStreamId,aFactory,aStorage);

   104 	CleanupStack::Pop();

   105 	return self;

   106 	}

   109 EXPORT_C CGlobalText::CGlobalText()

   110 	{}

   113 EXPORT_C CGlobalText::CGlobalText(const CParaFormatLayer* aGlobalParaLayer,const CCharFormatLayer* aGlobalCharLayer):

   114 	iGlobalParaFormatLayer(aGlobalParaLayer),

   115 	iGlobalCharFormatLayer(aGlobalCharLayer)

   116 	{

   117 	__TEST_INVARIANT;

   118 	}

   120 EXPORT_C CGlobalText::~CGlobalText()

   121 /** The destructor is empty, and is present only to cause the virtual function

   122 table to be defined in a unique module. */

   123 	{}

   125 EXPORT_C void CGlobalText::SetGlobalParaFormat(const CParaFormatLayer* aParaFormatLayer)

   126 /** Replaces the paragraph format layer referenced by the global text object.

   128 @param aParaFormatLayer Pointer to the paragraph format layer to be referenced

   129 by the global text object. */

   130 	{

   131 	iGlobalParaFormatLayer=aParaFormatLayer;

   132 	CEditableText::SetHasChanged(ETrue);

   134 	__TEST_INVARIANT;

   135 	}

   137 EXPORT_C void CGlobalText::SetGlobalCharFormat(const CCharFormatLayer* aCharFormatLayer)

   138 /** Replaces the character format layer referenced by the global text object.

   140 @param aCharFormatLayer Pointer to the character format layer to be referenced

   141 by the global text object. */

   142 	{

   143 	iGlobalCharFormatLayer=aCharFormatLayer;

   144 	CEditableText::SetHasChanged(ETrue);

   146 	__TEST_INVARIANT;

   147 	}

   150 EXPORT_C void CGlobalText::ApplyParaFormatL(const CParaFormat* aFormat,const TParaFormatMask& aMask,

   151 											TInt /*aPos*/,TInt /*aLength*/)

   152 /** Changes the text object's paragraph formatting. The attributes which are

   153 set in the mask are read from aFormat into the text object's paragraph format

   154 layer. The attributes which are not set in the mask are not changed. Note

   155 that the position and length arguments are only used in the rich text

   156 implementation of this function.

   158 @param aFormat Contains the paragraph format attribute values to apply.

   159 @param aMask Bitmask specifying the paragraph format attributes to change.

   160 @param aPos This argument is not used for global text.

   161 @param aLength This argument is not used for global text. */

   162 	{

   164 	__TEST_INVARIANT;

   166 	TParaFormatMask applyMask=aMask;

   167 	CParaFormat* pf=CParaFormat::NewL(*aFormat);

   168 	CleanupStack::PushL(pf);

   169 	iGlobalParaFormatLayer->SenseL(pf,applyMask);

   170 	CONST_CAST(CParaFormatLayer*,iGlobalParaFormatLayer)->SetL(pf,applyMask);

   171 	CleanupStack::PopAndDestroy();  // pf

   172 	CEditableText::SetHasChanged(ETrue);

   174 	__TEST_INVARIANT;

   175 	}

   177 EXPORT_C void CGlobalText::ApplyCharFormatL(const TCharFormat& aFormat,const TCharFormatMask& aMask,

   178 											TInt /*aPos*/,TInt /*aLength*/)

   179 /** Changes the text object's character formatting. The attributes which are

   180 set in the mask are read from aFormat into the text object's character format

   181 layer. The attributes which are not set in the mask are not changed. Note

   182 that the position and length arguments are only used in the rich text

   183 implementation of this function.

   185 @param aFormat Contains the character format attribute values to apply.

   186 @param aMask Bitmask specifying the character format attributes to change.

   187 @param aPos This argument is not used for global text.

   188 @param aLength This argument is not used for global text. */

   189 	{

   191 	__TEST_INVARIANT;

   193 	TCharFormatMask applyMask=aMask;

   194 	TCharFormat cf(aFormat);

   195 	iGlobalCharFormatLayer->Sense(cf,applyMask);

   196 	(CONST_CAST(CCharFormatLayer*,iGlobalCharFormatLayer))->SetL(cf,applyMask);

   197 	CEditableText::SetHasChanged(ETrue);

   199 	__TEST_INVARIANT;

   200 	}

   202 EXPORT_C TInt CGlobalText::LdDocumentLength()const

   203 /** Gets the the number of characters in the document.

   205 Note: the count includes all non-printing characters but excludes the end

   206 of text paragraph delimiter, so that the smallest return value is always zero.

   208 @return The number of characters contained in the document. */

   209    {

   210    __TEST_INVARIANT;

   212    return CPlainText::DocumentLength();

   213    }

   215 EXPORT_C TInt CGlobalText::LdToParagraphStart(TInt& aCurrentPos)const

   216 /** Gets the document position of the start of the paragraph containing a

   217 specified document position.

   219 @param aCurrentPos Specifies a document position: must be valid or a panic

   220 occurs. On return, specifies the document position of the first character

   221 in the paragraph in which it is located.

   222 @return The number of characters skipped in scanning to the start of the

   223 paragraph. */

   224 	{

   225 	__TEST_INVARIANT;

   227 	return CPlainText::ToParagraphStart(aCurrentPos);

   228 	}

   230 EXPORT_C TBool CGlobalText::EnquirePageBreak(TInt aPos,TInt aLength)const

   231 /** Tests whether a page break occurs within a range of characters. Returns

   232 false if no page table has been set up: see CPlainText::SetPageTable(). The

   233 start and end of the range must be valid document positions, or a panic occurs.

   235 @param aPos The document position from which to begin searching for a page

   236 break.

   237 @param aLength The number of characters to search for a page break, beginning

   238 at aPos. The default is zero.

   239 @return ETrue if a page break occurs within the specified range, otherwise

   240 EFalse. */

   241 	{

   242 	__TEST_INVARIANT;

   244 	return PageContainingPos(aPos+aLength)>PageContainingPos(aPos);

   245 	}

   247 EXPORT_C void CGlobalText::GetChars(TPtrC& aView,TCharFormat& aFormat,TInt aStartPos)const

   248 /** Gets a constant pointer descriptor to a portion of the text object. The

   249 portion starts at document position aStartPos, and ends at the end of the

   250 document, or the end of the segment, if segmented storage is being used. Also

   251 fills a character format object with the text object's effective character

   252 formatting. The start position must be valid, or a panic occurs.

   254 @param aView On return, a constant pointer to a portion of the text.

   255 @param aFormat On return, contains the text object's effective character

   256 formatting.

   257 @param aStartPos The start position for the view. */

   258 	{

   259 	if (aStartPos<0 || aStartPos>DocumentLength())

   260 	    {

   261 	    OstTrace0( TRACE_FATAL, CGLOBALTEXT_GETCHARS, "ECharPosBeyondDocument" );

   262 	    }

   263 	__ASSERT_ALWAYS(aStartPos>=0 && aStartPos<=DocumentLength(),Panic(ECharPosBeyondDocument));

   265 	aView.Set(Read(aStartPos));

   266 	iGlobalCharFormatLayer->SenseEffective(aFormat);

   267 	OverrideFormatOfInlineTextIfApplicable(aView,aFormat,aStartPos);

   268 	}

   270 EXPORT_C void CGlobalText::GetParagraphFormatL(CParaFormat* aFormat,TInt /*aPos*/) const

   271 /** Gets the text object's effective paragraph formatting. The aPos value is

   272 only used in the rich text implementation of this function.

   274 @param aFormat On return, filled with the text object's effective paragraph

   275 formatting.

   276 @param aPos This argument is not used for global text. */

   277 	{

   278 	// Get the paragraph format. Global text has a single unvarying character format so aPos is ignored.

   279 	iGlobalParaFormatLayer->SenseEffectiveL(aFormat);

   280 	}

   283 EXPORT_C void CGlobalText::GetParaFormatL(CParaFormat* aFormat,TParaFormatMask& aVaries,TInt /*aPos*/,TInt /*aLength*/,

   284 										  CParaFormat::TParaFormatGetMode aMode) const

   285 /** Gets the the global text object's effective paragraph formatting. Note that

   286 the position and length arguments are only used in the rich text implementation

   287 of this function.

   289 @param aFormat Must not be NULL or a panic occurs. On return, contains the

   290 effective paragraph formatting for the global text object.

   291 @param aVaries On return, a bitmask indicating which paragraph format attributes

   292 vary over the range of characters selected. This is only relevant for rich

   293 text, so for global text returns a value of zero for all attributes.

   294 @param aPos This argument is not used for global text.

   295 @param aLength This argument is not used for global text.

   296 @param aMode The default, EAllAttributes indicates that values for all paragraph

   297 format attributes are written to aFormat. EFixedAttributes indicates that

   298 tabs, bullets and borders are not written to aFormat. */

   299 	{

   300 	iGlobalParaFormatLayer->SenseEffectiveL(aFormat,aMode);

   301 	aVaries.ClearAll();

   302 	}

   306 EXPORT_C void CGlobalText::GetCharFormat(TCharFormat& aFormat,TCharFormatMask& aVaries,

   307 										 TInt /*aPos*/,TInt /*aLength*/) const

   308 /** Gets the global text object's effective character formatting. Note that the

   309 last three arguments are not relevant to the global text implementation of

   310 this function.

   312 @param aFormat On return, contains the effective character formatting for

   313 the global text object.

   314 @param aVaries On return, a bitmask indicating which character format attributes

   315 vary over the range of characters selected. This is only relevant for rich

   316 text, so for global text returns a value of zero for all attributes.

   317 @param aPos This argument is not used for global text.

   318 @param aLength This argument is not used for global text. */

   319 	{

   320 	iGlobalCharFormatLayer->SenseEffective(aFormat);

   321 	aVaries.ClearAll();

   322 	}

   324 EXPORT_C CPicture* CGlobalText::PictureHandleL(TInt /*aPos*/,MLayDoc::TForcePictureLoad /*aForceLoad*/) const

   325 /**  Global text provides no support for pictures, so this implementation

   326 of the function returns NULL. */

   327 	{

   328 	// Global text provides no support for pictures.

   329 	return NULL;

   330 	}

   332 EXPORT_C TInt CGlobalText::GetPictureSizeInTwips(TSize& /*aSize*/, TInt /*aPos*/) const

   333 /** Global text provides no support for pictures, so this implementation

   334 of the function returns KErrNotFound. */

   335 	{

   336 	// Global text provides no support for pictures.

   337 	return KErrNotFound;

   338 	}

   340 EXPORT_C TBool CGlobalText::SelectParagraphLabel(TInt /*aPos*/)

   341 /** Global text does not support paragraph labels, so this function

   342 returns EFalse. */

   343     {

   344 	return EFalse;

   345 	}

   347 EXPORT_C void CGlobalText::CancelSelectLabel()

   348 /** Not supported. */

   349 	{

   350 	}

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200
changeset 1	260cb5ec6c19
permissions	-rw-r--r--