sl@0: /*
sl@0: * Copyright (c) 1997-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: #ifndef __TXTFRMAT_H__
sl@0: #define __TXTFRMAT_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <e32base.h>
sl@0: #include <gdi.h>
sl@0: 
sl@0: 
sl@0: // Classes declared in this file:
sl@0: class TTabStop;
sl@0: class TParaBorder;
sl@0: class TBullet;
sl@0: class TParaBorderArray;
sl@0: class CParaFormat;
sl@0: class TParaFormatMask;
sl@0: class TFontPresentation;
sl@0: class TCharFormat;
sl@0: class TCharFormatMask;
sl@0: 
sl@0: /** 
sl@0: Provides support for system colours, in addition to literal colours, in 
sl@0: text formatting.
sl@0: 
sl@0: The base class TRgb stores the 24-bit literal colour value using a TUint32. 
sl@0: TLogicalRgb uses the MSB from iValue2 data member as an 8-bit index. The 
sl@0: purpose of the  index is to allow applications to use logical colours. If the 
sl@0: index is zero, the value is not a logical colour; it is treated as an ordinary 
sl@0: TRgb value. If the index is non zero (1-255), the colour should be translated by the 
sl@0: application into a system colour. Indices 254 and 255 are reserved for the 
sl@0: system foreground and background colours, respectively and should be translated 
sl@0: into them. Translation from index to RGB colour occurs in the implementation of 
sl@0: MFormParam::SystemColor().
sl@0: 
sl@0: All colours in the Text and Text Attributes API are stored using TLogicalRgb 
sl@0: values and are initialised to either TLogicalRgb::ESystemForegroundColor or 
sl@0: TLogicalRgb::ESystemBackgroundColor.
sl@0: 
sl@0: This system allows an application to set its text colours once, perhaps using 
sl@0: the system-wide colour scheme, rather than having to set the colours each 
sl@0: time a text object is created. It is also compatible with legacy code which 
sl@0: expects TRgb rather than TLogicalRgb values: for example, the logical 
sl@0: foreground and background colours have their bottom three bytes filled with 
sl@0: black and white respectively so that code which expects TRgb values can still 
sl@0: use them. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class TLogicalRgb : public TRgb
sl@0: 	{
sl@0: 	public:
sl@0:  
sl@0: 	/*
sl@0: 	Reserved colour indices for default foreground and background colours,
sl@0: 	and colours for the selection highlight. The top 128 indices (128-255)
sl@0: 	are reserved for future expansion, but the first 126 non-zero indices
sl@0: 	(1-127) can be used by the GUI as convenient.
sl@0: 	*/ 
sl@0: 	enum
sl@0: 		{
sl@0: 		ESystemSelectionForegroundIndex = 252,
sl@0: 		ESystemSelectionBackgroundIndex = 253,
sl@0: 		/** Index reserved for the system foreground colour (=254). */
sl@0: 		ESystemForegroundIndex = 254,
sl@0: 		/** Index reserved for the system background colour (=255). */
sl@0: 		ESystemBackgroundIndex = 255
sl@0: 		};
sl@0: 
sl@0: 	
sl@0: 	 
sl@0: 	/** Used to construct TLogicalRgb objects which should use either the 
sl@0: 	system foreground or background colour. */
sl@0: 	enum TSystemColor
sl@0: 		{
sl@0: 		ESystemSelectionForegroundColor = ESystemSelectionForegroundIndex << 24,
sl@0: 		ESystemSelectionBackgroundColor = ESystemSelectionBackgroundIndex << 24,
sl@0: 		/** The system foreground colour. */
sl@0: 		ESystemForegroundColor = ESystemForegroundIndex << 24,
sl@0: 		/** The system background colour. */
sl@0: 		ESystemBackgroundColor = (ESystemBackgroundIndex << 24) | 0xFFFFFF
sl@0: 		};
sl@0: 		 
sl@0: 	/** Constructs a new TLogicalRgb object. */
sl@0: 	TLogicalRgb() : 
sl@0: 		iValue2(0) 
sl@0: 		{ 
sl@0: 		}
sl@0: 	
sl@0: 	/** Constructs the object with a 32-bit integer. The index is stored in the 
sl@0: 	MSB of iValue2 data member. A TRgb value may be stored in the base TRgb class. 
sl@0: 	@param aValue Integer holding the logical colour index. */
sl@0: 	TLogicalRgb(TUint32 aValue): 
sl@0: 		iValue2(aValue & 0xFF000000)
sl@0: 		{ 
sl@0: 		SetInternal((TUint32)aValue | 0xFF000000);
sl@0: 		}
sl@0: 		
sl@0: 	/** Constructs the object with a TSystemColor value.
sl@0: 	@param aValue Identifies whether the colour is the system foreground or 
sl@0: 	system background colour. */
sl@0: 	TLogicalRgb(TSystemColor aValue) : 
sl@0: 		iValue2((TUint32)aValue & 0xFF000000)
sl@0: 		{ 
sl@0: 		SetInternal((TUint32)aValue | 0xFF000000);
sl@0: 		}
sl@0: 
sl@0: 	/** Constructs a new TLogicalRgb object from an existing one. */
sl@0: 	TLogicalRgb(const TRgb& aRgb) : 
sl@0: 		TRgb(aRgb),
sl@0: 		iValue2(0)
sl@0: 		{ 
sl@0: 		}
sl@0: 	 
sl@0: 	/** Returns the logical colour's index value. Zero indicates that the value 
sl@0: 	is not a logical colour; it is an ordinary TRgb value. 254 and 255 indicate 
sl@0: 	the system foreground and background colours, respectively.
sl@0: 	@return The index: between zero and 255 inclusive. */
sl@0: 	TUint SystemColorIndex() const 
sl@0: 		{ 
sl@0: 		return iValue2 >> 24; 
sl@0: 		}
sl@0: 		
sl@0: 	/** Sets the logical colour's index value.
sl@0: 	@param aIndex The new index value (between 1 and 253 inclusive). */
sl@0: 	void SetSystemColorIndex(TUint aIndex) 
sl@0: 		{ 
sl@0: 		iValue2 = aIndex << 24; 
sl@0: 		}
sl@0: 	
sl@0: private:	
sl@0: 	TUint32 iValue2;
sl@0: 	
sl@0: 	};
sl@0: 
sl@0: /** 
sl@0: Indicates which format attributes are relevant when setting or sensing text 
sl@0: formatting. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: enum TTextFormatAttribute
sl@0: 	{
sl@0: 	// Paragraph format attributes.
sl@0: 	/** Language of the paragraph for proofing. */
sl@0: 	EAttParaLanguage,
sl@0: 	/** Background colour of the paragraph. */
sl@0: 	EAttFillColor,
sl@0: 	/** Leading text margin. */
sl@0: 	EAttLeftMargin,
sl@0: 	/** Trailing text margin. */
sl@0: 	EAttRightMargin,
sl@0: 	/** First line leading indent. */
sl@0: 	EAttIndent,
sl@0: 	/** Horizontal alignment of paragraph. */
sl@0: 	EAttAlignment,
sl@0: 	/** Vertical paragraph alignment. */
sl@0: 	EAttVerticalAlignment,
sl@0: 	/** Inter-line spacing. */
sl@0: 	EAttLineSpacing,
sl@0: 	/** Control for EAttLineSpacing. */
sl@0: 	EAttLineSpacingControl,
sl@0: 	/** Space above paragraph. */
sl@0: 	EAttSpaceBefore,
sl@0: 	/** Space below paragraph. */
sl@0: 	EAttSpaceAfter,
sl@0: 	/** Whether a page break can occur within the paragraph. */
sl@0: 	EAttKeepTogether,
sl@0: 	/** Whether a page break can occur between this and the next paragraph. */
sl@0: 	EAttKeepWithNext,
sl@0: 	/** Whether a page break should be inserted before this paragraph. */
sl@0: 	EAttStartNewPage,
sl@0: 	/** Whether the last line of a paragraph can appear by itself at the top of a new 
sl@0: 	page, (widow), or the first line of a paragraph can appear by itself at the 
sl@0: 	bottom of the page, (orphan). */
sl@0: 	EAttWidowOrphan,
sl@0: 	/** Whether the paragraph should line wrap at the right margin. */
sl@0: 	EAttWrap,
sl@0: 	/** Distance between paragraph border and enclosed text. */
sl@0: 	EAttBorderMargin,
sl@0: 	/** Top of paragraph border. */
sl@0: 	EAttTopBorder,
sl@0: 	/** Bottom of paragraph border. */
sl@0: 	EAttBottomBorder,
sl@0: 	/** Left-hand side of paragraph border. */
sl@0: 	EAttLeftBorder,
sl@0: 	/** Right-hand side of paragraph border. */
sl@0: 	EAttRightBorder,
sl@0: 	/** Bullet point associated with paragraph. */
sl@0: 	EAttBullet,
sl@0: 	/** Spacing between default tab stops. */
sl@0: 	EAttDefaultTabWidth,
sl@0: 	/** Tab stop. */
sl@0: 	EAttTabStop,
sl@0: 
sl@0: 	// Character format attributes.
sl@0: 	/** Language of individual characters within a paragraph for proofing. */
sl@0: 	EAttCharLanguage,
sl@0: 	/** Text colour. */
sl@0: 	EAttColor,
sl@0: 	/** Text highlight colour. */
sl@0: 	EAttFontHighlightColor,
sl@0: 	/** Text highlight style. */
sl@0: 	EAttFontHighlightStyle,
sl@0: 	/** Font height. */
sl@0: 	EAttFontHeight,
sl@0: 	/** Font posture (i.e. italics). */
sl@0: 	EAttFontPosture,
sl@0: 	/** Font stroke weight (i.e. bold). */
sl@0: 	EAttFontStrokeWeight,
sl@0: 	/** Subscript, superscript or normal print position. */
sl@0: 	EAttFontPrintPos,
sl@0: 	/** Underlining. */
sl@0: 	EAttFontUnderline,
sl@0: 	/** Strikethrough. */
sl@0: 	EAttFontStrikethrough,
sl@0: 	/** The typeface name. */
sl@0: 	EAttFontTypeface,
sl@0: 	/** Vertical picture alignment. */
sl@0: 	EAttFontPictureAlignment,
sl@0: 	/** Hidden text. */
sl@0: 	EAttFontHiddenText,
sl@0: 
sl@0: 	/** Used internally to indicate the count of all attributes. */
sl@0: 	ETextFormatAttributeCount
sl@0: 	};
sl@0: 
sl@0: /*
sl@0: Following enum and variable should not be used by external developers.
sl@0: */
sl@0: enum {EVariableLengthValue = 0};
sl@0: 
sl@0: const TInt KMaxStyleName = 0x20;
sl@0: const TInt KMaxParaAttributes = EAttTabStop;
sl@0: const TInt KMaxCharAttributes = EAttFontHiddenText - KMaxParaAttributes;
sl@0: const TInt KTabNotFound = -1;
sl@0: 
sl@0: /** 
sl@0: A tab stop.
sl@0: 
sl@0: This is a position on a page used to align columns of text. It has a twips 
sl@0: position and an alignment. The twips position is the width in twips (1/1440th 
sl@0: of an inch) of the tab stop, i.e. the number of twips from the start of the 
sl@0: line at which text can be inserted. It uniquely identifies the tab stop. The 
sl@0: alignment (left, right, or centre) indicates how text inserted at the tab 
sl@0: stop should be aligned.
sl@0: 
sl@0: Tab stops are paragraph format attributes. They are owned by the CParaFormat 
sl@0: class, through which tab stops can be added and removed. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class TTabStop
sl@0: 	{
sl@0: public:
sl@0: 	/** Text alignment at the tab stop. */
sl@0: 	enum TTabType
sl@0: 		{
sl@0: 		/** No tab. */
sl@0: 		ENullTab, 
sl@0: 		/** Text is aligned to the tab stop's leading edge (left for
sl@0: 		left-to-right paragraphs, right for right-to-left paragraphs). */
sl@0: 		ELeftTab, 
sl@0: 		/** Text is aligned to the tab stop's trailing edge (right for
sl@0: 		left-to-right paragraphs, left for right-to-left paragraphs). */
sl@0: 		ECenteredTab, 
sl@0: 		/** Text is right aligned at the tab stop. */
sl@0: 		ERightTab
sl@0: 		};
sl@0: public:
sl@0: 	IMPORT_C TTabStop();
sl@0: 	IMPORT_C TTabStop(const TTabStop& aTabStop);
sl@0: 	IMPORT_C TTabStop& operator=(const TTabStop& aTabStop);
sl@0: 	IMPORT_C TBool operator==(const TTabStop& aTabStop) const;
sl@0: 	inline TBool operator!=(const TTabStop& aTabStop) const;
sl@0: public:
sl@0: 	/** The twips position. This is the width in twips of the tab stop, i.e. 
sl@0: 	the number of twips from the start of the line at which text can be 
sl@0: 	inserted. */
sl@0: 	TUint32 iTwipsPosition;
sl@0: 	/** Text alignment at the tab stop. */
sl@0: 	TTabType iType;
sl@0: 	};
sl@0: 
sl@0: /** 
sl@0: Defines the characteristics of one of the four sides of a paragraph border. 
sl@0: 
sl@0: These are the line style, thickness and colour. Paragraph borders are paragraph 
sl@0: format attributes. They are owned by the CParaFormat class which allows 
sl@0: paragraph borders to be added and removed. The CParaFormat::TParaBorderSide 
sl@0: enumeration identifies which side of the paragraph the object applies to. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class TParaBorder
sl@0: 	{
sl@0: public:
sl@0: 	
sl@0: 	/** Line styles. */
sl@0: 	enum TLineStyle 
sl@0: 		{
sl@0: 		/** No line style. */
sl@0: 		ENullLineStyle, 
sl@0: 		/** Solid line. */
sl@0: 		ESolid, 
sl@0: 		/** Double solid line. */
sl@0: 		EDouble,
sl@0: 		/** Dotted line. */
sl@0: 		EDotted, 
sl@0: 		/** Dashed line. */
sl@0: 		EDashed, 
sl@0: 		/** Alternating dots and dashes. */
sl@0: 		EDotDash, 
sl@0: 		/** Alternating sequence of two dots and a dash. */
sl@0: 		EDotDotDash
sl@0: 		};
sl@0: 	//
sl@0: 	IMPORT_C TParaBorder();
sl@0: 	IMPORT_C TBool operator==(const TParaBorder& aParaBorder) const;
sl@0: 	inline TBool operator!=(const TParaBorder& aParaBorder) const;
sl@0: public:
sl@0: 	/** The line style. By default, ENullLineStyle. */
sl@0: 	TLineStyle iLineStyle;
sl@0: 	/** The line thickness in twips. By default, zero. */
sl@0: 	TInt iThickness;
sl@0: 	/** The line colour. By default, the system's default foreground colour. */
sl@0: 	TLogicalRgb iColor;
sl@0: 	/** ETrue indicates that the line colour is set to the default or current 
sl@0: 	text colour, overriding iColor. EFalse indicates that the iColor value is 
sl@0: 	used. By default, ETrue. */
sl@0: 	TBool iAutoColor;
sl@0: 	};
sl@0: 
sl@0: /** 
sl@0: Stores the four sides of a paragraph border.
sl@0: 
sl@0: Paragraph borders sides are set individually using functions provided by class 
sl@0: CParaFormat. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class TParaBorderArray
sl@0: 	{
sl@0: public:
sl@0: 	TParaBorder iBorder[4];
sl@0: 	};
sl@0: 
sl@0: /** 
sl@0: A bullet point. 
sl@0: 
sl@0: This is a paragraph format attribute, stored as the iBullet member of class 
sl@0: CParaFormat.
sl@0: 
sl@0: Bullet points have a typeface, height, colour and a character code (defines 
sl@0: the symbol displayed). Single level bullets only are supported. Bullets may 
sl@0: also have a hanging indent. If set, this means that the rest of the paragraph 
sl@0: following the line containing the bullet point is indented. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class TBullet
sl@0: 	{
sl@0: 	public:
sl@0: 	IMPORT_C TBullet();
sl@0: 	IMPORT_C TBool operator ==(const TBullet& aBullet) const;
sl@0: 	inline TBool operator !=(const TBullet& aBullet) const;
sl@0: 
sl@0: 	/**
sl@0: 	Identifies the bullet style.
sl@0: 
sl@0: 	Note: Styles other than ENullStyle and EBulletStyle are not currently supported.
sl@0: 	They have the same effect as the EBulletStyle.
sl@0: 	*/
sl@0: 	enum TStyle
sl@0: 		{
sl@0: 		/**
sl@0: 		No bullet. Used for style layers that override a bullet with the absence of a bullet.
sl@0: 		*/
sl@0: 		ENullStyle,
sl@0: 		/**
sl@0: 		A bullet point. Character with code 0x2022 is used by default.
sl@0: 		*/
sl@0: 		EBulletStyle,
sl@0: 		EArabicNumberStyle,
sl@0: 		ESmallRomanNumberStyle,
sl@0: 		ECapitalRomanNumberStyle,
sl@0: 		ESmallLetterStyle,
sl@0: 		ECapitalLetterStyle
sl@0: 		};
sl@0: 
sl@0: 	/** Paragraph alignment */
sl@0: 	enum TAlignment
sl@0: 		{
sl@0: 		/** Paragraph left aligned. */
sl@0: 		ELeftAlign,
sl@0: 		/** Paragraph centre aligned. */
sl@0: 		ECenterAlign,
sl@0: 		/** Paragraph right aligned. */
sl@0: 		ERightAlign
sl@0: 		};
sl@0: 
sl@0: 	/** The Unicode character used to represent the bullet point. By default 
sl@0: 	0x2022. */
sl@0: 	TChar iCharacterCode;		// the bullet or other symbol used if iStyle is EBulletStyle
sl@0: 	/** The height in twips of the font used for the bullet point character. 
sl@0: 	By default, zero. */
sl@0: 	TUint iHeightInTwips;
sl@0: 	/** The typeface used for the bullet point character. */
sl@0: 	TTypeface iTypeface;
sl@0: 	/** ETrue to indent the rest of the paragraph from the bullet point. 
sl@0: 	EFalse to align the bullet point character with the rest of the paragraph. */
sl@0: 	TBool iHangingIndent;
sl@0: 	/** The colour of the bullet point character. By default, the system's 
sl@0: 	default foreground colour. */
sl@0: 	TLogicalRgb iColor;
sl@0: 	TStyle iStyle;				// is this a bullet or a number or a letter?
sl@0: 	TInt iStartNumber;			// the number of the first paragraph in a run of paragraphs in this style
sl@0: 	TAlignment iAlignment;		// alignment of the bullet or number within the margin
sl@0: 	};
sl@0: 
sl@0: /** 
sl@0: A transient container of paragraph format attributes, including tab stops, 
sl@0: bullet points and paragraph borders. 
sl@0: 
sl@0: Rich and global text objects store paragraph formatting using paragraph format 
sl@0: layers (see class CParaFormatLayer). The CParaFormat class is used to store 
sl@0: the relevant attribute values when setting or sensing a CParaFormatLayer. 
sl@0: It is normally used in combination with a TParaFormatMask, to specify which 
sl@0: attributes are relevant to the function concerned.
sl@0: 
sl@0: On construction, all CParaFormat member data is initialised. The attributes 
sl@0: which are not explicitly set are assigned default values. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class CParaFormat: public CBase
sl@0: 	{
sl@0: public:
sl@0: 	/** Miscellaneous constants. */
sl@0: 	enum
sl@0: 		{
sl@0: 		/** The maximum number of paragraph borders (= 4). */
sl@0: 		EMaxParaBorder = 4
sl@0: 		};
sl@0: 
sl@0: 	/** Paragraph border sides */
sl@0: 	enum TParaBorderSide
sl@0: 		{
sl@0: 		/** The border at the top of the paragraph. */
sl@0: 		EParaBorderTop,
sl@0: 		/** The border at the bottom of the paragraph. */
sl@0: 		EParaBorderBottom,
sl@0: 		/** The border on the left hand side. */
sl@0: 		EParaBorderLeft,
sl@0: 		/** The border on the right hand side. */
sl@0: 		EParaBorderRight
sl@0: 		};
sl@0: 
sl@0: 	/** Line spacing control */
sl@0: 	enum TLineSpacingControl
sl@0: 		{
sl@0: 		/** Twips line spacing must be at least as wide as the 
sl@0: 		iLineSpacingInTwips value. */
sl@0: 		ELineSpacingAtLeastInTwips,
sl@0: 		/** Twips line spacing must be exactly the iLineSpacingInTwips value. */
sl@0: 		ELineSpacingExactlyInTwips,
sl@0: 		/** Pixels line spacing must be at least as wide as the line spacing 
sl@0: 		value in pixels. */
sl@0: 		ELineSpacingAtLeastInPixels,
sl@0: 		/** Pixels line spacing must be exactly the same as the line spacing 
sl@0: 		value in pixels. */
sl@0: 		ELineSpacingExactlyInPixels
sl@0: 		};
sl@0: 
sl@0: 	/** Paragraph alignment */
sl@0: 	enum TAlignment
sl@0: 		{
sl@0: 		/** Paragraph aligned to the leading margin (left for left-to-right
sl@0: 		paragraphs, right for right-to-left paragraphs). */
sl@0: 		ELeftAlign,
sl@0: 		/** Paragraph top aligned. */
sl@0: 		ETopAlign = ELeftAlign,
sl@0: 		/** Paragraph centre aligned. */
sl@0: 		ECenterAlign,
sl@0: 		/** Paragraph aligned to the trailing margin (right for left-to-right
sl@0: 		paragraphs, left for right-to-left paragraphs). */
sl@0: 		ERightAlign,
sl@0: 		/** Paragraph bottom aligned. */
sl@0: 		EBottomAlign = ERightAlign,
sl@0: 		/** Paragraph justified. */
sl@0: 		EJustifiedAlign,
sl@0: 		/** Used by the spreadsheet application. Unlike ETopAlign and 
sl@0: 		EBottomAlign, provides no default implementation. */
sl@0: 		EUnspecifiedAlign,
sl@0: 		/** User-defined paragraph alignment. */
sl@0: 		ECustomAlign,
sl@0: 		/** Absolute left alignment */
sl@0: 		EAbsoluteLeftAlign,
sl@0: 		/** Absolute right alignment */
sl@0: 		EAbsoluteRightAlign
sl@0: 		};
sl@0: 
sl@0: 	/** Attribute sense mode */
sl@0: 	enum TParaFormatGetMode
sl@0: 		{
sl@0: 		/** Indicates that all paragraph format attributes are written to the 
sl@0: 		result when sensing paragraph format attributes. */
sl@0: 		EAllAttributes,
sl@0: 		/** Indicates that tabs, bullets and borders are not sensed. */
sl@0: 		EFixedAttributes
sl@0: 		};
sl@0: 
sl@0: 	IMPORT_C static CParaFormat* NewL();
sl@0: 	IMPORT_C static CParaFormat* NewLC();
sl@0: 	IMPORT_C static CParaFormat* NewL(const CParaFormat& aFormat);
sl@0: 	IMPORT_C CParaFormat();
sl@0: 	IMPORT_C ~CParaFormat();
sl@0: 	IMPORT_C void ResetNonDestructive();  // preserves any allocated tabs, bullets or borders.
sl@0: 	IMPORT_C void Reset();  // full reset, deletes and nulls any allocated tabs, bullets or borders.
sl@0: 	IMPORT_C void CopyL(const CParaFormat& aFormat, const TParaFormatMask& aMask);
sl@0: 	IMPORT_C void CopyL(const CParaFormat& aFormat);
sl@0: 	IMPORT_C void Strip();  // Cleans up this paragraph format.
sl@0: 	IMPORT_C TBool IsEqual(const CParaFormat& aFormat, const TParaFormatMask& aMask) const;
sl@0: 	IMPORT_C TBool IsEqual(const CParaFormat& aFormat) const;
sl@0: 	IMPORT_C void StoreTabL(const TTabStop& aTabStop);
sl@0: 	IMPORT_C void RemoveTab(TInt aTabTwipsPosition);
sl@0: 	inline void RemoveAllTabs();
sl@0: 	IMPORT_C const TTabStop TabStop(TInt aTabIndex) const;
sl@0: 	inline TInt TabCount() const;
sl@0: 	IMPORT_C TInt LocateTab(TInt aTabTwipsPosition) const;
sl@0: 	IMPORT_C void SetParaBorderL(TParaBorderSide aSide, const TParaBorder& aBorder);  // Overwrites any existing border for that side
sl@0: 	IMPORT_C void RemoveAllBorders();
sl@0: 	IMPORT_C const TParaBorder ParaBorder(TParaBorderSide aSide) const;
sl@0: 
sl@0: 	/** Tests whether any paragraph borders have been set.
sl@0: 	
sl@0: 	@return ETrue if any paragraph borders have been set, EFalse if not. */
sl@0: 	inline TBool BordersPresent() const { return iParaBorderArray != NULL;}
sl@0: 	
sl@0:     inline TParaBorder* ParaBorderPtr(TParaBorderSide aSide)
sl@0: 
sl@0: 	/** Gets a pointer to the paragraph border on the side specified. If no 
sl@0: 	paragraph border array has been allocated, returns NULL.
sl@0: 	
sl@0: 	@param aSide The side for the paragraph border. 
sl@0: 	@return Pointer to the paragraph border on the specified side. */
sl@0: 		{ return iParaBorderArray ? &iParaBorderArray->iBorder[aSide] : NULL; }
sl@0: 	IMPORT_C TBool AllBordersEqual(const CParaFormat& aFormat) const;
sl@0: 	IMPORT_C TBool IsBorderEqual(TParaBorderSide aSide, const CParaFormat& aFormat) const;
sl@0: private:
sl@0: 	CParaFormat(const CParaFormat& aFormat);
sl@0: 	void CreateTabListL();
sl@0: 	enum
sl@0: 		{
sl@0: 		ETabStoreGranularity = 2
sl@0: 		};
sl@0: 
sl@0: 	CParaFormat& operator=(const CParaFormat& aParaFormat);	// intentionally unimplemented
sl@0: private:
sl@0: 	CArrayFixFlat<TTabStop>* iTabList;			// ordered list of tab stops; null if none
sl@0: 	TParaBorderArray* iParaBorderArray;			// array of paragraph borders; null if none
sl@0: public:
sl@0: 	/** The background colour of the paragraph. By default the default system 
sl@0: 	background colour. This colour applies to the area bounded by the paragraph 
sl@0: 	border, if one exists. */
sl@0: 	TLogicalRgb iFillColor;
sl@0: 	/** The language of the paragraph for proofing. By default 
sl@0: 	KParaDefaultLanguage. Used for example when spell checking a document 
sl@0: 	which contains text in more than one language, so that the program 
sl@0: 	recognises the text as being in another language. */
sl@0: 	TInt32 iLanguage;						
sl@0: 	/** The width in twips of the leading margin (left for left-to-right
sl@0: 	paragraphs, right for right-to-left paragraphs). By default
sl@0: 	KParaDefaultLeftMargin (zero). */
sl@0: 	TInt32 iLeftMarginInTwips;
sl@0: 	/** The width in twips of the trailing margin (right for left-to-right
sl@0: 	paragraphs, left for right-to-left paragraphs). By default
sl@0: 	KParaDefaultRightMargin (zero). */
sl@0: 	TInt32 iRightMarginInTwips;
sl@0: 	/** An indent for the first line in the paragraph, relative to the leading
sl@0: 	margin (left for left-to-right paragraphs, right for right-to-left
sl@0: 	paragraphs). By default KParaDefaultIndent (zero). */
sl@0: 	TInt32 iIndentInTwips;
sl@0: 	/** Horizontal alignment of paragraph. By default KParaDefaultHorizAlign 
sl@0: 	(left). */
sl@0: 	TAlignment iHorizontalAlignment;
sl@0: 	/** Vertical alignment of paragraph, (intended for use by spreadsheet 
sl@0: 	applications). 	By default KParaDefaultVertAlign (unspecified). */
sl@0: 	TAlignment iVerticalAlignment;
sl@0: 	/** Inter-line spacing within the paragraph, in twips. By default 
sl@0: 	KParaDefaultLineSpacing (200 twips). */
sl@0: 	TInt32 iLineSpacingInTwips;	// distance between successive baselines
sl@0: 	/** Control for the iLineSpacingInTwips value. By default, 
sl@0: 	KParaDefaultLineSpacingControl 	(ELineSpacingAtLeastInTwips). */
sl@0: 	TLineSpacingControl iLineSpacingControl;	// whether iLineSpacingInTwips means 'at least' or 'exactly'
sl@0: 	/** Space above paragraph. By default KParaDefaultSpaceBefore (zero). */
sl@0: 	TInt32 iSpaceBeforeInTwips;	
sl@0: 	/** Space below paragraph. By default KParaDefaultSpaceAfter (zero). */
sl@0: 	TInt32 iSpaceAfterInTwips;	
sl@0: 	/** Prevents a page break within paragraph if ETrue. By default 
sl@0: 	KParaDefaultKeepTogether (EFalse). */
sl@0: 	TBool iKeepTogether;	
sl@0: 	/** Prevents a page break between this paragraph and the following 
sl@0: 	paragraph if ETrue. By default, KParaDefaultKeepWithNext (EFalse). */
sl@0: 	TBool iKeepWithNext;	
sl@0: 	/** Inserts a page break immediately before this paragraph if ETrue. 
sl@0: 	By default, KParaDefaultStartNewPage (EFalse). */
sl@0: 	TBool iStartNewPage;		
sl@0: 	/** Prevents the printing of the last line of a paragraph at the top 
sl@0: 	of the page (referred to as a widow), or the first line of a paragraph 
sl@0: 	at the bottom of the page, (referred to as an orphan). By default, 
sl@0: 	KParaDefaultWidowOrphan (EFalse). */
sl@0: 	TBool iWidowOrphan;	
sl@0: 	/** Specifies whether the paragraph should line wrap at the right margin. 
sl@0: 	By default KParaDefaultWrap (ETrue). */
sl@0: 	TBool iWrap;
sl@0: 	/** Distance in twips between the paragraph border and the enclosed text. 
sl@0: 	By default KParaDefaultBorderMargin (zero). */
sl@0: 	TInt32 iBorderMarginInTwips;	
sl@0: 	/** The bullet point associated with the paragraph. A NULL value indicates 
sl@0: 	no bullet point. By default NULL. */
sl@0: 	TBullet* iBullet;		
sl@0: 	/** Specifies the default tab stop width. By default KParaDefaultTabWidth 
sl@0: 	(360 twips). */
sl@0: 	TUint32 iDefaultTabWidthInTwips;
sl@0: 	};
sl@0: 
sl@0: /** 
sl@0: Masks the paragraph format attributes which are involved when setting and 
sl@0: sensing paragraph formatting. 
sl@0: 
sl@0: Used in conjunction with an object of class CParaFormat. When setting formatting, 
sl@0: only the attributes which are set in the mask will participate in the relevant 
sl@0: function. When sensing formatting, on return, the mask indicates which attributes 
sl@0: were sensed from the format layer, and were not taken from the default values. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class TParaFormatMask
sl@0: 	{
sl@0: public:
sl@0: 	inline TParaFormatMask();
sl@0: 	inline void SetAttrib(TTextFormatAttribute aAttribute);
sl@0: 	inline void ClearAttrib(TTextFormatAttribute aAttribute);
sl@0: 	IMPORT_C void SetAll();
sl@0: 	IMPORT_C void ClearAll();
sl@0: 	inline TBool AttribIsSet(TTextFormatAttribute aAttribute) const;
sl@0: 	inline TBool IsNull() const;
sl@0: 	IMPORT_C TBool operator==(const TParaFormatMask& aMask) const;
sl@0: 	inline TBool operator!=(const TParaFormatMask& aMask) const;
sl@0: 
sl@0: private:
sl@0: 	TUint32 iGuard;
sl@0: 	};
sl@0: 
sl@0: /** 
sl@0: Specifies the font-independent character format attributes, including bold, 
sl@0: italics and underlining.
sl@0: 
sl@0: An instance of this class is owned by the character formatting container (class 
sl@0: TCharFormat). 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class TFontPresentation
sl@0: 	{
sl@0: public:
sl@0: 		
sl@0: 	/** Highlight style */
sl@0: 	enum TFontHighlightStyle
sl@0: 		{
sl@0: 		/** No highlighting used. */
sl@0: 		EFontHighlightNone,
sl@0: 		/** Normal (square cornered) highlighting used. */
sl@0: 		EFontHighlightNormal,
sl@0: 		/** Rounded corner highlighting used. */
sl@0: 		EFontHighlightRounded,
sl@0: 		/** Text is drawn offset towards the bottom-right in the highlight 
sl@0: 		colour, (iHighlightColor) before being drawn again in the text colour, 
sl@0: 		(iTextColor) creating a shadow effect. */
sl@0: 		EFontHighlightShadow,
sl@0: 		/** Placeholder for "unrecognised word" highlighting style for FEPs */
sl@0: 		EFontHighlightNoMatchesIndicator,
sl@0: 		/** First custom highlighting style is used.
sl@0: 		@see MFormCustomDraw::DrawText(). */
sl@0: 		EFontHighlightFirstCustomStyle = 128,
sl@0: 		/** Second custom highlighting style is used. 
sl@0: 		@see MFormCustomDraw::DrawText(). */
sl@0: 		EFontHighlightLastCustomStyle = 255
sl@0: 		};
sl@0: 	
sl@0: 	
sl@0: 	/** Vertical picture alignment */
sl@0: 	enum TAlignment
sl@0: 		{
sl@0: 		/** The top of the picture is aligned flush with the top of the font's 
sl@0: 		ascent, so that the picture may descend below the line. */
sl@0: 		EAlignTop,
sl@0: 		/** The bottom of the picture is aligned flush with the bottom of the 
sl@0: 		font's descent so that the picture may extend above the line. */
sl@0: 		EAlignBottom,
sl@0: 		/** The picture is aligned so that its centre is positioned at the 
sl@0: 		baseline of the line. */
sl@0: 		EAlignCentered,
sl@0: 		/** The bottom of the picture is aligned with the baseline of the font.
sl@0: 		This is the default. */
sl@0: 		EAlignBaseLine
sl@0: 		};
sl@0: 	//
sl@0: 	IMPORT_C TFontPresentation();
sl@0: 	//
sl@0: 	// Enquiry function
sl@0: 	IMPORT_C TBool IsEqual(const TFontPresentation& aFontPresentation, const TCharFormatMask& aMask) const;
sl@0: public:
sl@0: 	/** The text colour. By default, the default system foreground colour. */
sl@0: 	TLogicalRgb iTextColor;
sl@0: 	/** The highlight colour for selected text. Only takes effect if 
sl@0: 	iHighlightStyle is not EFontHighlightNone. By default, the default system 
sl@0: 	foreground colour. */
sl@0: 	TLogicalRgb iHighlightColor;  // Background color
sl@0: 	/** Style for character highlighting. By default EFontHighlightNone. */
sl@0: 	TFontHighlightStyle iHighlightStyle;
sl@0: 	/** The value of the strikethrough attribute. By default EStrikethroughOff. */
sl@0: 	TFontStrikethrough iStrikethrough;
sl@0: 	/** The value of the underline attribute. By default EUnderlineOff. */
sl@0: 	TFontUnderline iUnderline;
sl@0: 	/** Specifies whether or not text is hidden. Note that hidden text is not 
sl@0: 	currently supported by the text layout engine. This attribute is provided 
sl@0: 	to preserve information when copying from and to devices which support 
sl@0: 	hidden text. By default EFalse. */
sl@0: 	TBool iHiddenText;
sl@0: 	/** The vertical alignment of a picture character. By default 
sl@0: 	EAlignBaseLine. */
sl@0: 	TAlignment iPictureAlignment;
sl@0: 	};
sl@0: 
sl@0: /** 
sl@0: A transient container of character format attributes, including 
sl@0: font-dependent and font-independent attributes. 
sl@0: 
sl@0: The font-independent attributes are stored in a TFontPresentation object. 
sl@0: Rich and global text objects store character formatting using character format 
sl@0: layers (see class CCharFormatLayer). The TCharFormat class is used to store 
sl@0: the relevant attribute values when setting or sensing a CCharFormatLayer. 
sl@0: It is normally used in combination with a TCharFormatMask, to specify which 
sl@0: attributes are relevant to the function concerned. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class TCharFormat
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C TCharFormat();
sl@0: 	IMPORT_C TCharFormat(const TDesC &aTypefaceName, TInt aHeight);
sl@0: 	//
sl@0: 	// Enquiry functions
sl@0: 	IMPORT_C TBool IsEqual(const TCharFormat& aFormat, const TCharFormatMask& aMask) const;
sl@0: 	IMPORT_C TBool IsEqual(const TCharFormat& aFormat) const;
sl@0: public:
sl@0: 	/** Specifies the language of individual characters for proofing. Used for 
sl@0: 	example when spell checking a document which contains text in more than one 
sl@0: 	language, so that the program recognises the text as being in another 
sl@0: 	language. Language is also a paragraph format attribute. If the language 
sl@0: 	setting of a character is different from the language setting of the 
sl@0: 	containing paragraph, the character's setting takes precedence. */
sl@0: 	TInt32 iLanguage;
sl@0: 	/** Font independent character format attributes. */
sl@0: 	TFontPresentation iFontPresentation; 
sl@0: 	/** Device independent font specification. */
sl@0: 	TFontSpec iFontSpec;  
sl@0: 	};
sl@0: 
sl@0: /** 
sl@0: Masks the character format attributes which are involved when setting and 
sl@0: sensing character formatting.
sl@0: 
sl@0: Used in conjunction with an object of class TCharFormat.
sl@0: 
sl@0: When setting formatting, only the attributes which are set in the mask should 
sl@0: participate in the relevant function. When sensing formatting, on return, 
sl@0: the mask indicates which attributes were sensed from the format layer, and 
sl@0: were not taken from the default values. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class TCharFormatMask
sl@0: 	{
sl@0: public:
sl@0: 	inline TCharFormatMask();
sl@0: 	inline void SetAttrib(TTextFormatAttribute aAttribute);
sl@0: 	inline void ClearAttrib(TTextFormatAttribute aAttribute);
sl@0: 	inline TBool AttribIsSet(TTextFormatAttribute aAttribute) const;
sl@0: 	IMPORT_C void SetAll();
sl@0: 	IMPORT_C void ClearAll();
sl@0: 	inline TBool IsNull()const;
sl@0: 	IMPORT_C TBool operator==(const TCharFormatMask& aMask) const;
sl@0: 	inline TBool operator!=(const TCharFormatMask& aMask) const;
sl@0: 
sl@0: private:
sl@0: 	TUint32 iGuard;
sl@0: 	};
sl@0: 
sl@0: #include <txtfrmat.inl>
sl@0: 
sl@0: #endif