2 * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
4 * This component and the accompanying materials are made available
5 * under the terms of "Eclipse Public License v1.0"
6 * which accompanies this distribution, and is available
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
19 #ifndef __TXTMFMTX_H__
20 #define __TXTMFMTX_H__
25 // Defines interface for getting/setting formatting attributes.
31 Specifies the mixin protocol for getting and setting character and paragraph
34 It is inherited by classes which support character and paragraph formatting,
35 e.g. CRichText and CGlobalText. Its purpose is to allow developers to apply
36 and retrieve formatting without needing to know which type of editable text
39 All functions defined in this class use a document position and a length.
40 These values are only relevant to rich text. In general, they must be valid
41 (i.e. the range must not extend beyond the bounds of the document), or a panic
42 occurs. In global text, formatting is applied globally, so that the length
43 and position values are ignored.
50 // Paragraph format attributes
53 /** Gets the effective paragraph formatting which applies to a range of paragraphs.
54 Also gets a bit mask which indicates which values change over the region,
55 and whose value is therefore indeterminate.
57 @param aFormat On return, contains the effective paragraph formatting for
58 the range of paragraphs. For global text, this is the paragraph formatting
59 of the entire text object.
60 @param aVaries On return, a bitmask indicating which paragraph format attributes
61 vary over the range of characters selected. For global text, this mask contains
62 a value of zero for every attribute because formatting is applied globally.
63 @param aPos The document position of the start of the range.
64 @param aLength The number of characters in the range.
65 @param aMode The default, EAllAttributes means that values for all paragraph
66 format attributes are written to aFormat. EFixedAttributes means that tabs,
67 bullets and borders are not written to aFormat. */
68 virtual void GetParaFormatL(CParaFormat* aFormat,TParaFormatMask& aVaries,TInt aPos,TInt aLength,
69 CParaFormat::TParaFormatGetMode aMode=CParaFormat::EAllAttributes)const=0;
72 /** Applies paragraph formatting to a range of paragraphs. The attributes which
73 are set in the mask are taken from aFormat and applied. The attributes which
74 are not set in the mask are not applied.
76 @param aFormat Contains the paragraph format attribute values to apply.
77 @param aMask Specifies which paragraph format attributes should be applied.
78 @param aPos The document position of the start of the range.
79 @param aLength The number of characters in the range. */
80 virtual void ApplyParaFormatL(const CParaFormat* aFormat,const TParaFormatMask& aMask,TInt aPos,TInt aLength)=0;
82 // Character format attributes
85 /** Gets the effective character formatting which applies to a range of characters.
86 Also gets a bit mask which indicates which values change over the region,
87 and whose value is therefore indeterminate.
89 @param aFormat On return, contains the character format values for the range
90 of characters. For global text, this is the character formatting of the entire
92 @param aVaries On return, indicates which character format attributes vary
93 over the range and whose values are therefore indeterminate. For global text,
94 this mask contains a value of zero for every attribute because formatting
96 @param aPos The document position of the start of the range.
97 @param aLength The number of characters in the range. */
98 virtual void GetCharFormat(TCharFormat& aFormat,TCharFormatMask& aVaries,TInt aPos,TInt aLength)const=0;
101 /** Applies character formatting to a range of characters. The attributes which
102 are set in the mask are taken from aFormat and applied. The attributes which
103 are not set in the mask are not applied.
105 @param aFormat Contains the character format attribute values to apply.
106 @param aMask Bitmask specifying which character format attributes should be
108 @param aPos Document position from which to apply the new character formatting.
110 @param aLength The number of characters to which the new formatting should
112 virtual void ApplyCharFormatL(const TCharFormat& aFormat,const TCharFormatMask& aMask,TInt aPos,TInt aLength)=0;