sl@0: /*
sl@0: * Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description: 
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <e32base.h>
sl@0: 
sl@0: #include <gdi.h>
sl@0: #include "TXTFRMAT.H"
sl@0: 
sl@0: #include "TXTSTD.H"
sl@0: #include "OstTraceDefinitions.h"
sl@0: #ifdef OST_TRACE_COMPILER_IN_USE
sl@0: #include "TXTFRMATTraces.h"
sl@0: #endif
sl@0: 
sl@0: 
sl@0: 
sl@0: const TInt KParaDefaultLanguage=0;
sl@0: const TInt KParaDefaultLeftMargin=0;
sl@0: const TInt KParaDefaultRightMargin=0;
sl@0: const TInt KParaDefaultIndent=0;
sl@0: const CParaFormat::TAlignment KParaDefaultHorizAlign=CParaFormat::ELeftAlign;
sl@0: const CParaFormat::TAlignment KParaDefaultVertAlign=CParaFormat::EUnspecifiedAlign;
sl@0: const TInt KParaDefaultLineSpacing=200; // 200 twips = 10pt
sl@0: const CParaFormat::TLineSpacingControl KParaDefaultLineSpacingControl=CParaFormat::ELineSpacingAtLeastInTwips;
sl@0: const TInt KParaDefaultSpaceBefore=0;
sl@0: const TInt KParaDefaultSpaceAfter=0;
sl@0: const TBool KParaDefaultKeepTogether=EFalse;
sl@0: const TBool KParaDefaultKeepWithNext=EFalse;
sl@0: const TBool KParaDefaultStartNewPage=EFalse;
sl@0: const TBool KParaDefaultWidowOrphan=EFalse;
sl@0: const TBool KParaDefaultWrap=ETrue;
sl@0: const TInt KParaDefaultBorderMargin=0;
sl@0: const TInt KParaDefaultTabWidth=360; // 360 twips = 0.25"
sl@0: const TUint KParFormatBits = (2 << EAttTabStop) - 1;
sl@0: const TUint KCharFormatBits = (2 << (EAttFontHiddenText - EAttCharLanguage)) - 1;
sl@0: 
sl@0: 	
sl@0: EXPORT_C TTabStop::TTabStop():
sl@0: 	iTwipsPosition(0),
sl@0: 	iType(ELeftTab)
sl@0: /** The default C++ constructor constructs a TTabStop. The twips position is 
sl@0: initialised to zero and the alignment to ELeftTab. */
sl@0:  	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TTabStop::TTabStop(const TTabStop& aTabStop):
sl@0: 	iTwipsPosition(aTabStop.iTwipsPosition),
sl@0: 	iType(aTabStop.iType)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TTabStop& TTabStop::operator=(const TTabStop& aTabStop)
sl@0: /** Assigns the twips position and alignment of aTabStop to the current TTabStop.
sl@0: 
sl@0: @param aTabStop The tab stop to assign to the current tab stop. 
sl@0: @return The current tab stop. */
sl@0: 	{
sl@0: 	iTwipsPosition=aTabStop.iTwipsPosition;
sl@0: 	iType=aTabStop.iType;
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool TTabStop::operator==(const TTabStop& aTabStop)const
sl@0: /** Compares two tab stops for equality. To be equal, they must have the same 
sl@0: twips position and alignment.
sl@0: 
sl@0: @param aTabStop The tab stop to compare with the current tab stop. 
sl@0: @return ETrue if both tab stops have the same twips position and alignment. 
sl@0: EFalse if not. */
sl@0: 	{
sl@0: 	if (iTwipsPosition!=aTabStop.iTwipsPosition)
sl@0: 		return EFalse;
sl@0: 	if (iType!=aTabStop.iType)
sl@0: 		return EFalse;
sl@0: 	return ETrue;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TParaBorder::TParaBorder():
sl@0: 	iLineStyle(ENullLineStyle),
sl@0: 	iThickness(0),
sl@0: 	iColor(TLogicalRgb::ESystemForegroundColor),
sl@0: 	iAutoColor(ETrue)
sl@0: /** The default C++ constructor constructs a TParaBorder, initializing its line 
sl@0: style to ENullLineStyle, its line thickness to zero, its colour to KRgbBlack 
sl@0: and iAutocolor to ETrue. */
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool TParaBorder::operator==(const TParaBorder& aParaBorder)const
sl@0: /** Compares two paragraph border sides for equality. For two paragraph border 
sl@0: sides to be equal, all data members must be equal.
sl@0: 
sl@0: @param aBorder The paragraph border to compare with the current border.
sl@0: @return ETrue if the two paragraph border sides are equal, EFalse if not. */
sl@0: 	{
sl@0: 	if (iLineStyle!=aParaBorder.iLineStyle)
sl@0: 		return EFalse;
sl@0: 	if (iThickness!=aParaBorder.iThickness)
sl@0: 		return EFalse;
sl@0: 	if (iColor!=aParaBorder.iColor)
sl@0: 		return EFalse;
sl@0: 	if (iAutoColor!=aParaBorder.iAutoColor)
sl@0: 		return EFalse;
sl@0: 	return ETrue;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBullet::TBullet():
sl@0: 	iCharacterCode(0x2022),
sl@0: 	iHeightInTwips(0),
sl@0: 	iHangingIndent(TRUE),
sl@0: 	iColor(TLogicalRgb::ESystemForegroundColor),
sl@0: 	iStyle(EBulletStyle),
sl@0: 	iStartNumber(1),
sl@0: 	iAlignment(ELeftAlign)
sl@0: /** The default C++ constructor constructs a TBullet, initializing the 
sl@0: character code to 0x2022, the height to zero, the colour to the system's 
sl@0: default foreground colour and the hanging indent to ETrue. The typeface 
sl@0: is not initialised. */
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool TBullet::operator==(const TBullet& aBullet)const
sl@0: /** Compares two bullet points for equality. For two bullet points to be equal, 
sl@0: all data members must be equal.
sl@0: 
sl@0: @param aBullet The bullet point to compare. 
sl@0: @return ETrue if the two bullet points are equal, EFalse if not. */
sl@0: 	{
sl@0: 	return iCharacterCode == aBullet.iCharacterCode &&
sl@0: 		   iHeightInTwips == aBullet.iHeightInTwips &&
sl@0: 		   iHangingIndent == aBullet.iHangingIndent &&
sl@0: 		   iColor == aBullet.iColor &&
sl@0: 		   iStyle == aBullet.iStyle &&
sl@0: 		   iStartNumber == aBullet.iStartNumber &&
sl@0: 		   iAlignment == aBullet.iAlignment &&
sl@0: 		   iTypeface == aBullet.iTypeface;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CParaFormat* CParaFormat::NewL()
sl@0: /** Allocates and constructs a CParaFormat object. All attributes are 
sl@0: initialised with default values.
sl@0: 
sl@0: @return The new CParaFormat object. */
sl@0: 	{
sl@0: 	return new(ELeave) CParaFormat;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CParaFormat* CParaFormat::NewLC()
sl@0: /** Allocates and constructs a CParaFormat object. All attributes are 
sl@0: initialised with default values. Leaves the object on the cleanup stack.
sl@0: 
sl@0: @return The new CParaFormat object. */
sl@0: 	{
sl@0: 	CParaFormat* self=new(ELeave) CParaFormat;
sl@0: 	CleanupStack::PushL(self);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CParaFormat* CParaFormat::NewL(const CParaFormat& aFormat)
sl@0: /** Allocates and constructs a new CParaFormat. All attributes are initialised 
sl@0: to the values contained in the aFormat argument.
sl@0: 
sl@0: @param aFormat Paragraph format container whose values are used to initialise 
sl@0: the new CParaFormat. 
sl@0: @return The new CParaFormat object. */
sl@0: 	{
sl@0: 	CParaFormat* self = new(ELeave) CParaFormat(aFormat);
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->CopyL(aFormat);
sl@0: 	CleanupStack::Pop();
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CParaFormat::CParaFormat():
sl@0: 	iTabList(NULL),
sl@0: 	iParaBorderArray(NULL),
sl@0: 	iFillColor(TLogicalRgb::ESystemBackgroundColor),
sl@0: 	iLanguage(KParaDefaultLanguage),
sl@0: 	iLeftMarginInTwips(KParaDefaultLeftMargin),
sl@0: 	iRightMarginInTwips(KParaDefaultRightMargin),
sl@0: 	iIndentInTwips(KParaDefaultIndent),
sl@0: 	iHorizontalAlignment(KParaDefaultHorizAlign),
sl@0: 	iVerticalAlignment(KParaDefaultVertAlign),
sl@0: 	iLineSpacingInTwips(KParaDefaultLineSpacing),
sl@0: 	iLineSpacingControl(KParaDefaultLineSpacingControl),
sl@0: 	iSpaceBeforeInTwips(KParaDefaultSpaceBefore),
sl@0: 	iSpaceAfterInTwips(KParaDefaultSpaceAfter),
sl@0: 	iKeepTogether(KParaDefaultKeepTogether),
sl@0: 	iKeepWithNext(KParaDefaultKeepWithNext),
sl@0: 	iStartNewPage(KParaDefaultStartNewPage),
sl@0: 	iWidowOrphan(KParaDefaultWidowOrphan),
sl@0: 	iWrap(KParaDefaultWrap),
sl@0: 	iBorderMarginInTwips(KParaDefaultBorderMargin),
sl@0: 	iBullet(NULL),
sl@0: 	iDefaultTabWidthInTwips(KParaDefaultTabWidth)
sl@0: /** The default C++ constructor constructs a new CParaFormat initialising all 
sl@0: attributes to the default settings.
sl@0: 
sl@0: Note: This function allows a CParaFormat object to be created on the stack. This 
sl@0: should only be done if it is known in advance that the object will not be 
sl@0: used to store tab stops, bullets or borders. */
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: 
sl@0: CParaFormat::CParaFormat(const CParaFormat& aFormat):
sl@0: 	iFillColor(aFormat.iFillColor),
sl@0: 	iLanguage(aFormat.iLanguage),
sl@0: 	iLeftMarginInTwips(aFormat.iLeftMarginInTwips),
sl@0: 	iRightMarginInTwips(aFormat.iRightMarginInTwips),
sl@0: 	iIndentInTwips(aFormat.iIndentInTwips),
sl@0: 	iHorizontalAlignment(aFormat.iHorizontalAlignment),
sl@0: 	iVerticalAlignment(aFormat.iVerticalAlignment),
sl@0: 	iLineSpacingInTwips(aFormat.iLineSpacingInTwips),
sl@0: 	iLineSpacingControl(aFormat.iLineSpacingControl),
sl@0: 	iSpaceBeforeInTwips(aFormat.iSpaceBeforeInTwips),
sl@0: 	iSpaceAfterInTwips(aFormat.iSpaceAfterInTwips),
sl@0: 	iKeepTogether(aFormat.iKeepTogether),
sl@0: 	iKeepWithNext(aFormat.iKeepWithNext),
sl@0: 	iStartNewPage(aFormat.iStartNewPage),
sl@0: 	iWidowOrphan(aFormat.iWidowOrphan),
sl@0: 	iWrap(aFormat.iWrap),
sl@0: 	iBorderMarginInTwips(aFormat.iBorderMarginInTwips),
sl@0: 	iDefaultTabWidthInTwips(aFormat.iDefaultTabWidthInTwips)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: void CParaFormat::CreateTabListL()
sl@0: 	{
sl@0: 	if (!iTabList)
sl@0: 		iTabList = new(ELeave) CArrayFixFlat<TTabStop>(ETabStoreGranularity);
sl@0: 	}
sl@0:  
sl@0: EXPORT_C CParaFormat::~CParaFormat()
sl@0: /** The destructor frees all resources owned by the paragraph format container 
sl@0: (tabs, borders and bullets), prior to its destruction. 
sl@0: 
sl@0: Note that Strip() also sets the resource pointers to NULL. This is important 
sl@0: in case CParaFormat is on the stack and gets deleted twice: once by the cleanup 
sl@0: stack and once by exceptions being unwound. */
sl@0: 	{
sl@0: 	Strip();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CParaFormat::CopyL(const CParaFormat& aFormat)
sl@0: /** Copies all attribute values from another paragraph format container.
sl@0: 
sl@0: @param aFormat Contains the attribute values to copy. */
sl@0: 	{
sl@0: 	TParaFormatMask mask;
sl@0: 	mask.SetAll();
sl@0: 	CopyL(aFormat,mask);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CParaFormat::CopyL(const CParaFormat& aFormat,const TParaFormatMask& aMask)
sl@0: /** Copies selected attribute values from another paragraph format container. 
sl@0: Only the attributes which are set in the mask are copied.
sl@0: 
sl@0: @param aFormat Contains the attribute values to copy. 
sl@0: @param aMask Bitmask specifying the attributes to copy. */
sl@0: 	{
sl@0: 	if (aMask.AttribIsSet(EAttParaLanguage))
sl@0: 		iLanguage=aFormat.iLanguage;
sl@0: 	if (aMask.AttribIsSet(EAttFillColor))
sl@0: 		iFillColor=aFormat.iFillColor;
sl@0: 	if (aMask.AttribIsSet(EAttLeftMargin))
sl@0: 		iLeftMarginInTwips=aFormat.iLeftMarginInTwips;
sl@0: 	if (aMask.AttribIsSet(EAttRightMargin))
sl@0: 		iRightMarginInTwips=aFormat.iRightMarginInTwips;
sl@0: 	if (aMask.AttribIsSet(EAttIndent))
sl@0: 		iIndentInTwips=aFormat.iIndentInTwips;
sl@0: 	if (aMask.AttribIsSet(EAttAlignment))
sl@0: 		iHorizontalAlignment=aFormat.iHorizontalAlignment;
sl@0: 	if (aMask.AttribIsSet(EAttVerticalAlignment))
sl@0: 		iVerticalAlignment=aFormat.iVerticalAlignment;
sl@0: 	if (aMask.AttribIsSet(EAttLineSpacing))
sl@0: 		iLineSpacingInTwips=aFormat.iLineSpacingInTwips;
sl@0: 	if (aMask.AttribIsSet(EAttLineSpacingControl))
sl@0: 		iLineSpacingControl=aFormat.iLineSpacingControl;
sl@0: 	if (aMask.AttribIsSet(EAttSpaceBefore))
sl@0: 		iSpaceBeforeInTwips=aFormat.iSpaceBeforeInTwips;
sl@0: 	if (aMask.AttribIsSet(EAttSpaceAfter))
sl@0: 		iSpaceAfterInTwips=aFormat.iSpaceAfterInTwips;
sl@0: 	if (aMask.AttribIsSet(EAttKeepTogether))
sl@0: 		iKeepTogether=aFormat.iKeepTogether;
sl@0: 	if (aMask.AttribIsSet(EAttKeepWithNext))
sl@0: 		iKeepWithNext=aFormat.iKeepWithNext;
sl@0: 	if (aMask.AttribIsSet(EAttStartNewPage))
sl@0: 		iStartNewPage=aFormat.iStartNewPage;
sl@0: 	if (aMask.AttribIsSet(EAttWidowOrphan))
sl@0: 		iWidowOrphan=aFormat.iWidowOrphan;
sl@0: 	if (aMask.AttribIsSet(EAttWrap))
sl@0: 		iWrap=aFormat.iWrap;
sl@0: 
sl@0: 	// Copy borders; create a border array only if necessary.
sl@0: 	if (iParaBorderArray || aFormat.iParaBorderArray)
sl@0: 		{
sl@0: 		if (!iParaBorderArray)
sl@0: 			iParaBorderArray = new(ELeave) TParaBorderArray;
sl@0: 		if (aMask.AttribIsSet(EAttTopBorder))
sl@0: 			iParaBorderArray->iBorder[EParaBorderTop] = aFormat.ParaBorder(EParaBorderTop);
sl@0: 		if (aMask.AttribIsSet(EAttBottomBorder))
sl@0: 			iParaBorderArray->iBorder[EParaBorderBottom] = aFormat.ParaBorder(EParaBorderBottom);
sl@0: 		if (aMask.AttribIsSet(EAttLeftBorder))
sl@0: 			iParaBorderArray->iBorder[EParaBorderLeft] = aFormat.ParaBorder(EParaBorderLeft);
sl@0: 		if (aMask.AttribIsSet(EAttRightBorder))
sl@0: 			iParaBorderArray->iBorder[EParaBorderRight] = aFormat.ParaBorder(EParaBorderRight);
sl@0: 		TParaBorder default_border;
sl@0: 		TBool borders_are_default = TRUE;
sl@0: 		for (int i = 0; i < 4; i++)
sl@0: 			if (iParaBorderArray->iBorder[i] != default_border)
sl@0: 				{
sl@0: 				borders_are_default = FALSE;
sl@0: 				break;
sl@0: 				}
sl@0: 		if (borders_are_default)
sl@0: 			RemoveAllBorders();
sl@0: 		}
sl@0: 
sl@0: 	if (iBullet || aFormat.iBullet)
sl@0: 		{
sl@0: 		if (aMask.AttribIsSet(EAttBullet))
sl@0: 			{
sl@0: 			if (aFormat.iBullet && aFormat.iBullet->iStyle != TBullet::ENullStyle)
sl@0: 				{
sl@0: 				if (!iBullet)
sl@0: 					iBullet = new(ELeave) TBullet;
sl@0: 				*iBullet = *aFormat.iBullet;
sl@0: 				}
sl@0: 			else
sl@0: 				{
sl@0: 				delete iBullet;
sl@0: 				iBullet = NULL;
sl@0: 				}
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: 	if (aMask.AttribIsSet(EAttDefaultTabWidth))
sl@0: 		iDefaultTabWidthInTwips = aFormat.iDefaultTabWidthInTwips;
sl@0: 
sl@0: 	if (iTabList || aFormat.iTabList)
sl@0: 		{
sl@0: 		if (aMask.AttribIsSet(EAttTabStop))
sl@0: 			{
sl@0: 			RemoveAllTabs();
sl@0: 			if (aFormat.iTabList && aFormat.iTabList->Count())
sl@0: 				{
sl@0: 				CreateTabListL();
sl@0: 				iTabList->InsertL(0,&(aFormat.iTabList->At(0)),aFormat.iTabList->Count());
sl@0: 				}
sl@0: 			}
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool CParaFormat::IsEqual(const CParaFormat& aFormat,const TParaFormatMask& aMask) const
sl@0: /** Compares selected attribute values for equality. Only the attributes 
sl@0: specified in the mask are involved in the comparison.
sl@0: 
sl@0: @param aFormat Contains the attribute values to compare. 
sl@0: @param aMask Bitmask specifying the attributes to compare. 
sl@0: @return ETrue if the two format containers have the same values for the
sl@0: attributes specified in the mask, EFalse if not. */
sl@0: 	{
sl@0: 	if (aMask.AttribIsSet(EAttParaLanguage))
sl@0: 		{
sl@0: 		if (iLanguage!=aFormat.iLanguage)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttFillColor))
sl@0: 		{
sl@0: 		if (iFillColor!=aFormat.iFillColor)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttLeftMargin))
sl@0: 		{
sl@0: 		if (iLeftMarginInTwips!=aFormat.iLeftMarginInTwips)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttRightMargin))
sl@0: 		{
sl@0: 		if (iRightMarginInTwips!=aFormat.iRightMarginInTwips)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttIndent))
sl@0: 		{
sl@0: 		if (iIndentInTwips!=aFormat.iIndentInTwips)	
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttAlignment))
sl@0: 		{
sl@0: 		if (iHorizontalAlignment!=aFormat.iHorizontalAlignment)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttVerticalAlignment))
sl@0: 		{
sl@0: 		if (iVerticalAlignment!=aFormat.iVerticalAlignment)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttLineSpacing))
sl@0: 		{
sl@0: 		if (iLineSpacingInTwips!=aFormat.iLineSpacingInTwips)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttLineSpacingControl))
sl@0: 		{
sl@0: 		if (iLineSpacingControl!=aFormat.iLineSpacingControl)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttSpaceBefore))
sl@0: 		{
sl@0: 		if (iSpaceBeforeInTwips!=aFormat.iSpaceBeforeInTwips)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttSpaceAfter))
sl@0: 		{
sl@0: 		if (iSpaceAfterInTwips!=aFormat.iSpaceAfterInTwips)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttKeepTogether))
sl@0: 		{
sl@0: 		if (iKeepTogether!=aFormat.iKeepTogether)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttKeepWithNext))
sl@0: 		{
sl@0: 		if (iKeepWithNext!=aFormat.iKeepWithNext)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttStartNewPage))
sl@0: 		{
sl@0: 		if (iStartNewPage!=aFormat.iStartNewPage)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttWidowOrphan))
sl@0: 		{
sl@0: 		if (iWidowOrphan!=aFormat.iWidowOrphan)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttWrap))
sl@0: 		{
sl@0: 		if (iWrap!=aFormat.iWrap)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttBorderMargin))
sl@0: 		{
sl@0: 		if (iBorderMarginInTwips!=aFormat.iBorderMarginInTwips)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttTopBorder))
sl@0: 		{
sl@0: 		if (iParaBorderArray)
sl@0: 			{
sl@0: 			if (ParaBorder(EParaBorderTop)!=aFormat.ParaBorder(EParaBorderTop))
sl@0: 				return EFalse;
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			if (aFormat.ParaBorder(EParaBorderTop).iLineStyle!=TParaBorder::ENullLineStyle)
sl@0: 				return EFalse;
sl@0: 			}
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttBottomBorder))
sl@0: 		{
sl@0: 		if (iParaBorderArray)
sl@0: 			{
sl@0: 			if (ParaBorder(EParaBorderBottom)!=aFormat.ParaBorder(EParaBorderBottom))
sl@0: 				return EFalse;
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			if (aFormat.ParaBorder(EParaBorderBottom).iLineStyle!=TParaBorder::ENullLineStyle)
sl@0: 				return EFalse;
sl@0: 			}
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttLeftBorder))
sl@0: 		{
sl@0: 		if (iParaBorderArray)
sl@0: 			{
sl@0: 			if (ParaBorder(EParaBorderLeft)!=aFormat.ParaBorder(EParaBorderLeft))
sl@0: 				return EFalse;
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			if (aFormat.ParaBorder(EParaBorderLeft).iLineStyle!=TParaBorder::ENullLineStyle)
sl@0: 				return EFalse;
sl@0: 			}
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttRightBorder))
sl@0: 		{
sl@0: 		if (iParaBorderArray)
sl@0: 			{
sl@0: 			if (ParaBorder(EParaBorderRight)!=aFormat.ParaBorder(EParaBorderRight))
sl@0: 				return EFalse;
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			if (aFormat.ParaBorder(EParaBorderRight).iLineStyle!=TParaBorder::ENullLineStyle)
sl@0: 				return EFalse;
sl@0: 			}
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttBullet))
sl@0: 		{
sl@0: 		if (iBullet)
sl@0: 			{
sl@0: 			if (!aFormat.iBullet)
sl@0: 				return EFalse;
sl@0: 			if (*iBullet!=*aFormat.iBullet)
sl@0: 				return EFalse;
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			if (aFormat.iBullet)
sl@0: 				return EFalse;
sl@0: 			}
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttDefaultTabWidth))
sl@0: 		{
sl@0: 		if (iDefaultTabWidthInTwips!=aFormat.iDefaultTabWidthInTwips)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttTabStop))
sl@0: 		{
sl@0: 		if (TabCount()>0)
sl@0: 			{// Check the tablists are the same.
sl@0: 			if (TabCount()!=aFormat.TabCount())
sl@0: 				return EFalse;
sl@0: 			TInt tabCount=TabCount();
sl@0: 			for (TInt index=0;index<tabCount;index++)
sl@0: 				{// Check each stored tab is the same
sl@0: 				if (TabStop(index)!=aFormat.TabStop(index))
sl@0: 					return EFalse;
sl@0: 				}
sl@0: 			}
sl@0: 		else if (aFormat.TabCount()>0)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	return ETrue;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool CParaFormat::IsEqual(const CParaFormat& aFormat) const
sl@0: /** Compares all attribute values for equality.
sl@0: 
sl@0: @param aFormat Contains the attribute values to compare. 
sl@0: @return ETrue if the two format containers have the same values for all 
sl@0: attributes, EFalse if not. */
sl@0: 	{
sl@0: 	TParaFormatMask mask;
sl@0: 	mask.SetAll();
sl@0: 	return IsEqual(aFormat,mask);
sl@0: 	}
sl@0:  
sl@0: EXPORT_C void CParaFormat::Strip()
sl@0: /** Deletes all paragraph borders, bullets and tab stops. No other 
sl@0: attributes are affected. */
sl@0: 	{
sl@0: 	RemoveAllTabs();
sl@0: 	RemoveAllBorders();
sl@0: 	delete iBullet;
sl@0: 	iBullet = NULL;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CParaFormat::Reset()
sl@0: /** Resets all paragraph format attributes to their default values. All tab 
sl@0: stops, paragraph borders and bullet points which have been allocated are 
sl@0: deleted and set to NULL. */
sl@0: 	{
sl@0: 	ResetNonDestructive();
sl@0: 	Strip();
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C void CParaFormat::ResetNonDestructive()
sl@0: /** Resets all paragraph format attributes to their default values, but any 
sl@0: allocated tab stops, bullet points and paragraph borders are preserved. */
sl@0: 	{
sl@0: 	iLanguage=KParaDefaultLanguage;
sl@0: 	iFillColor=TLogicalRgb::ESystemBackgroundColor;
sl@0: 	iLeftMarginInTwips=KParaDefaultLeftMargin;
sl@0: 	iRightMarginInTwips=KParaDefaultRightMargin;
sl@0: 	iIndentInTwips=KParaDefaultIndent;
sl@0: 	iHorizontalAlignment=KParaDefaultHorizAlign;
sl@0: 	iVerticalAlignment=KParaDefaultVertAlign;
sl@0: 	iLineSpacingInTwips=KParaDefaultLineSpacing;
sl@0: 	iLineSpacingControl=KParaDefaultLineSpacingControl;
sl@0: 	iSpaceBeforeInTwips=KParaDefaultSpaceBefore;
sl@0: 	iSpaceAfterInTwips=KParaDefaultSpaceAfter;
sl@0: 	iKeepTogether=KParaDefaultKeepTogether;
sl@0: 	iKeepWithNext=KParaDefaultKeepWithNext;
sl@0: 	iStartNewPage=KParaDefaultStartNewPage;
sl@0: 	iWidowOrphan=KParaDefaultWidowOrphan;
sl@0: 	iWrap=KParaDefaultWrap;
sl@0: 	iBorderMarginInTwips=KParaDefaultBorderMargin;
sl@0: 	iDefaultTabWidthInTwips=KParaDefaultTabWidth;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CParaFormat::StoreTabL(const TTabStop& aTabStop)
sl@0: /** Adds a tab stop to the list of tab stops, maintaining the ordering of the 
sl@0: list, (ascending order of twips position). Multiple tabs with the same twips 
sl@0: position are not allowed, so that if aTabStop shares the same twips position 
sl@0: as an existing tab stop, regardless of its alignment, the existing tab stop is 
sl@0: replaced by aTabStop.
sl@0: 
sl@0: @param aTabStop The tab stop to be stored. */
sl@0: 	{
sl@0: 	CreateTabListL();
sl@0: 	TKeyArrayFix tabKey(_FOFF(TTabStop,iTwipsPosition),ECmpTUint32);
sl@0: 	TInt tabNumber;
sl@0: 	CArrayFixFlat<TTabStop>& tabs=*iTabList;
sl@0: 	if (tabs.FindIsq(aTabStop,tabKey,tabNumber)==0)
sl@0: 		tabs[tabNumber]=aTabStop;		// found one at this position
sl@0: 	else
sl@0: 		tabs.InsertL(tabNumber,aTabStop);	// add the new one
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CParaFormat::RemoveTab(TInt aTabPosition)
sl@0: /** Deletes a tab stop identified by its twips position. If the specified 
sl@0: tab stop does not exist, the function has no effect.
sl@0: 	
sl@0: @param aTabTwipsPosition The twips position of the tab stop to remove. */
sl@0: 
sl@0: 	{
sl@0: 	TInt tabNumber=LocateTab(aTabPosition);  // will return KTabNotFound if no tab list present
sl@0: 	if (tabNumber!=KTabNotFound)
sl@0: 		{
sl@0: 		iTabList->Delete(tabNumber);
sl@0: 		iTabList->Compress();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: EXPORT_C const TTabStop CParaFormat::TabStop(TInt aTabIndex) const
sl@0: /** Gets the tab stop located at the specified index within the tab list 
sl@0: (counting from zero). Tab stops are ordered in ascending order of twips 
sl@0: position. If the object has no tab list, then a default tab stop is returned.
sl@0: 
sl@0: @param aTabIndex The offset of the tab stop in the tab list. Must be less 
sl@0: than the total number of tab stops, or a panic occurs. To find the total number 
sl@0: of tab stops, use TabCount(). 
sl@0: @return The tab stop located at the specified index. */
sl@0: 	{
sl@0: 	if (aTabIndex>=TabCount())
sl@0: 	    {
sl@0: 	    OstTrace0( TRACE_FATAL, CPARAFORMAT_TABSTOP, "ETabNotFound" );
sl@0: 	    }
sl@0: 	__ASSERT_ALWAYS(aTabIndex<TabCount(),Panic(ETabNotFound));
sl@0: 	
sl@0: 	return (iTabList)
sl@0: 		? TTabStop((*iTabList)[aTabIndex])
sl@0: 		: TTabStop();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CParaFormat::LocateTab(TInt aTabPosition) const
sl@0: /** Locates the tab stop specified by its twips position, and returns its
sl@0: offset in the tab list.
sl@0: 
sl@0: @param aTabPosition The twips position of the tab stop.
sl@0: @return The tab stop's index within the tab list (counting from zero). 
sl@0: KTabNotFound indicates that  no tab stop has the specified twips 
sl@0: position, or that no tab list has been allocated. */
sl@0: 	{
sl@0: 	if (!iTabList)
sl@0: 		return KTabNotFound;
sl@0: 	TKeyArrayFix tabKey(_FOFF(TTabStop,iTwipsPosition),ECmpTUint32);
sl@0: 	TInt tabNumber=0;
sl@0: 	TTabStop tab;
sl@0: 	tab.iTwipsPosition=aTabPosition;
sl@0: 	TInt error=iTabList->FindIsq(tab,tabKey,tabNumber);
sl@0: 	return error ?KTabNotFound :tabNumber;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CParaFormat::SetParaBorderL(TParaBorderSide aSide,const TParaBorder& aBorder)
sl@0: /** Sets one side of the object's paragraph border. If a border on the specified 
sl@0: side already exists, it is replaced.
sl@0: 
sl@0: Note: Setting a single side of the object's paragraph border incurs the overhead 
sl@0: of allocating storage for the three other sides, which are assigned default 
sl@0: values.
sl@0: 
sl@0: @param aSide The side for the paragraph border. 
sl@0: @param aBorder Specification for the paragraph border. */
sl@0: 	{
sl@0: 	TParaBorderArray* borders=iParaBorderArray;
sl@0: 	if (!borders)
sl@0: 		iParaBorderArray=borders=new(ELeave) TParaBorderArray;
sl@0: 	borders->iBorder[aSide]=aBorder;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C const TParaBorder CParaFormat::ParaBorder(TParaBorderSide aSide)const
sl@0: /** Gets the paragraph border on the side specified. If no paragraph border 
sl@0: array has been allocated, returns a default paragraph border.
sl@0: 
sl@0: @param aSide The side for the paragraph border. 
sl@0: @return The paragraph border on the specified side. */
sl@0: 	{
sl@0: 	if (iParaBorderArray)
sl@0: 		return iParaBorderArray->iBorder[aSide];
sl@0: 	return TParaBorder();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CParaFormat::RemoveAllBorders()
sl@0: /** Deletes all paragraph borders. */
sl@0: 	{
sl@0: 	delete iParaBorderArray;
sl@0: 	iParaBorderArray = NULL;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool CParaFormat::AllBordersEqual(const CParaFormat& aFormat)const
sl@0: /** Tests whether all paragraph borders in the specified paragraph format 
sl@0: container are identical to the paragraph borders of this paragraph format 
sl@0: container.
sl@0: 
sl@0: @param aFormat Contains the set of paragraph borders to compare. 
sl@0: @return ETrue if both objects have exactly the same set of paragraph borders. 
sl@0: EFalse if not. */
sl@0: 	{
sl@0: 	if (aFormat.ParaBorder(EParaBorderTop)!=ParaBorder(EParaBorderTop))
sl@0: 		return EFalse;
sl@0: 	if (aFormat.ParaBorder(EParaBorderBottom)!=ParaBorder(EParaBorderBottom))
sl@0: 		return EFalse;
sl@0: 	if (aFormat.ParaBorder(EParaBorderLeft)!=ParaBorder(EParaBorderLeft))
sl@0: 		return EFalse;
sl@0: 	if (aFormat.ParaBorder(EParaBorderRight)!=ParaBorder(EParaBorderRight))
sl@0: 		return EFalse;
sl@0: 	return ETrue;
sl@0: 	}
sl@0:  
sl@0: EXPORT_C TBool CParaFormat::IsBorderEqual(TParaBorderSide aSide,const CParaFormat& aFormat)const
sl@0: /** Tests whether the paragraph border located on the specified side is the same 
sl@0: as the border on the corresponding side in this object. For two borders to 
sl@0: be equal, they must both either be set or unset, and if set, they must have 
sl@0: the same characteristics.
sl@0: 
sl@0: @param aSide Indicates which side should be compared. 
sl@0: @param aFormat Contains the paragraph border to compare. 
sl@0: @return ETrue if the border sides are identical. EFalse if not. */
sl@0: 	{
sl@0: 	return aFormat.ParaBorder(aSide)==ParaBorder(aSide);
sl@0: 	}
sl@0: 
sl@0:  EXPORT_C void TParaFormatMask::SetAll()
sl@0: /** Sets all attribute flags in the paragraph format mask. */
sl@0: 	{
sl@0: 	iGuard = KMaxTUint;
sl@0: 	}
sl@0:  
sl@0: EXPORT_C void TParaFormatMask::ClearAll()
sl@0: /** Clears all attribute flags in the paragraph format mask. */
sl@0: 	{
sl@0: 	iGuard=0;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C  TBool TParaFormatMask::operator==(const TParaFormatMask& aMask)const
sl@0: /** Compares two paragraph format masks for equality.
sl@0: 
sl@0: @param aMask The mask to compare. 
sl@0: @return ETrue if all flags are the same in both masks. EFalse if any differ. */
sl@0: 	{
sl@0: 	return (iGuard & KParFormatBits) == (aMask.iGuard & KParFormatBits);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TFontPresentation::TFontPresentation():
sl@0: 	iTextColor(TLogicalRgb::ESystemForegroundColor),
sl@0: 	iHighlightColor(TLogicalRgb::ESystemForegroundColor),
sl@0: 	iHighlightStyle(EFontHighlightNone),
sl@0: 	iStrikethrough(EStrikethroughOff),
sl@0: 	iUnderline(EUnderlineOff),
sl@0: 	iHiddenText(EFalse),
sl@0: 	iPictureAlignment(EAlignBaseLine)
sl@0: /** The default C++ constructor constructs a TFontPresentation object, 
sl@0: initializing all member data to default values. For details of these values, 
sl@0: see the table below. */
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool TFontPresentation::IsEqual(const TFontPresentation& aFontPresentation,const TCharFormatMask& aMask) const
sl@0: /** Compares selected attribute values for equality. Only the attributes 
sl@0: specified in the mask are involved in the comparison.
sl@0: 
sl@0: @param aFontPresentation Contains the attribute values to compare. 
sl@0: @param aMask Bitmask specifying the attributes involved in the comparison. 
sl@0: @return ETrue if the two objects have the same values for the attributes 
sl@0: specified in the mask, EFalse if not. */
sl@0: 	{
sl@0: 	// Compare two font presentations, comparing only the attributes selected by the mask.
sl@0: 	if (aMask.AttribIsSet(EAttColor))
sl@0: 		{
sl@0: 		if (iTextColor!=aFontPresentation.iTextColor)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttFontHighlightColor))
sl@0: 		{
sl@0: 		if (iHighlightColor!=aFontPresentation.iHighlightColor)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttFontHighlightStyle))
sl@0: 		{
sl@0: 		if (iHighlightStyle!=aFontPresentation.iHighlightStyle)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttFontStrikethrough))
sl@0: 		{
sl@0: 		if (iStrikethrough!=aFontPresentation.iStrikethrough)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttFontUnderline))
sl@0: 		{
sl@0: 		if (iUnderline!=aFontPresentation.iUnderline)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttFontHiddenText))
sl@0: 		{
sl@0: 		if (iHiddenText!=aFontPresentation.iHiddenText)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttFontPictureAlignment))
sl@0: 		{
sl@0: 		if (iPictureAlignment!=aFontPresentation.iPictureAlignment)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	return ETrue;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TCharFormat::TCharFormat():
sl@0: 	iLanguage(0)
sl@0: /** Allocates and constructs a TCharFormat object. The font-independent 
sl@0: attributes are initialised with default values. The language is initialised 
sl@0: to zero. The font (iFontSpec) is set to be proportional and serif and to have 
sl@0: a height of 200 twips. The typeface name is not initialised. */
sl@0: 	{
sl@0: 	iFontSpec.iTypeface.SetAttributes(TTypeface::EProportional | TTypeface::ESerif);
sl@0: 	iFontSpec.iHeight = 200;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TCharFormat::TCharFormat(const TDesC &aTypefaceName,TInt aHeight):
sl@0: 	iLanguage(0),
sl@0: 	iFontSpec(aTypefaceName,aHeight)
sl@0: /** The C++ constructor is used to construct the TCharFormat object with a font 
sl@0: (typeface name and font height). The font-independent attributes are initialised 
sl@0: to default values; for details, see class TFontPresentation. The language 
sl@0: is initialised to zero.
sl@0: 
sl@0: @param aTypefaceName Specifies the typeface name. 
sl@0: @param aHeight Specifies the font height in twips. */
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool TCharFormat::IsEqual(const TCharFormat& aFormat,const TCharFormatMask& aMask) const
sl@0: /** Compares selected attribute values for equality. Only the attributes 
sl@0: specified in the mask are involved in the comparison.
sl@0: 
sl@0: @param aFormat Contains the attribute values to compare. 
sl@0: @param aMask Bitmask specifying the attributes to compare. 
sl@0: @return ETrue if the two format containers have the same values for the 
sl@0: attributes specified in the mask, EFalse if not. */
sl@0: 	{
sl@0: 	if (aMask.AttribIsSet(EAttCharLanguage))
sl@0: 		{
sl@0: 		if (iLanguage!=aFormat.iLanguage)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (!iFontPresentation.IsEqual(aFormat.iFontPresentation,aMask))
sl@0: 		return EFalse;
sl@0: 	if (aMask.AttribIsSet(EAttFontHeight))
sl@0: 		{
sl@0: 		if (iFontSpec.iHeight!=aFormat.iFontSpec.iHeight)
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttFontTypeface))
sl@0: 		{
sl@0: 		if (!(iFontSpec.iTypeface==aFormat.iFontSpec.iTypeface))
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttFontPosture))
sl@0: 		{
sl@0: 		if (iFontSpec.iFontStyle.Posture()!=aFormat.iFontSpec.iFontStyle.Posture())
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttFontStrokeWeight))
sl@0: 		{
sl@0: 		if (iFontSpec.iFontStyle.StrokeWeight()!=aFormat.iFontSpec.iFontStyle.StrokeWeight())
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	if (aMask.AttribIsSet(EAttFontPrintPos))
sl@0: 		{
sl@0: 		if (iFontSpec.iFontStyle.PrintPosition()!=aFormat.iFontSpec.iFontStyle.PrintPosition())
sl@0: 			return EFalse;
sl@0: 		}
sl@0: 	return ETrue;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C TBool TCharFormat::IsEqual(const TCharFormat& aFormat) const
sl@0: /** Compares all attribute values for equality.
sl@0: 
sl@0: @param aFormat Contains the attribute values to compare. 
sl@0: @return ETrue if the two format containers have the same values for all 
sl@0: attributes, EFalse if not. */
sl@0: 	{
sl@0: 	TCharFormatMask mask;
sl@0: 	mask.SetAll();
sl@0: 	return IsEqual(aFormat,mask);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void TCharFormatMask::SetAll()
sl@0: /** Sets all attribute flags in the character format mask. */
sl@0: 	{
sl@0: 	iGuard = KMaxTUint;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void TCharFormatMask::ClearAll()
sl@0: /** Clears all attribute flags in the character format mask. */
sl@0: 	{
sl@0: 	iGuard = 0;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C  TBool TCharFormatMask::operator==(const TCharFormatMask& aMask)const
sl@0: /** Compares two character format masks for equality.
sl@0: 
sl@0: @param aMask The mask to compare. 
sl@0: @return ETrue if all flags are the same in both masks. EFalse if any differ. */
sl@0: 	{
sl@0: 	return (iGuard & KCharFormatBits) == (aMask.iGuard & KCharFormatBits);
sl@0: 	}