|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
#ifndef __UNIFIED_EDITOR_H__
|
|
sl@0
|
22 |
#define __UNIFIED_EDITOR_H__ 1
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
#include <tagma.h>
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
|
|
sl@0
|
27 |
#include <tagma_internal.h>
|
|
sl@0
|
28 |
#endif
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
/*
|
|
sl@0
|
31 |
The header file for MUnifiedEditor, an interface that unifies editing operations on backing text and layout,
|
|
sl@0
|
32 |
which are traditionally separated between ETEXT (backing text) and FORM (layout). It is not dependent
|
|
sl@0
|
33 |
on FORM or ETEXT, although there is an implementation (TFormAndTextEditor) using those components.
|
|
sl@0
|
34 |
*/
|
|
sl@0
|
35 |
|
|
sl@0
|
36 |
/**
|
|
sl@0
|
37 |
Base class for optional interfaces
|
|
sl@0
|
38 |
@internalComponent
|
|
sl@0
|
39 |
*/
|
|
sl@0
|
40 |
class MTmOptionalInterface
|
|
sl@0
|
41 |
|
|
sl@0
|
42 |
{
|
|
sl@0
|
43 |
};
|
|
sl@0
|
44 |
|
|
sl@0
|
45 |
/**
|
|
sl@0
|
46 |
UIDs for standard optional interfaces
|
|
sl@0
|
47 |
@internalComponent
|
|
sl@0
|
48 |
*/
|
|
sl@0
|
49 |
const TUint KUidMUnifiedEditorStyleSupport = 0x100092B6;
|
|
sl@0
|
50 |
const TUint KUidMUnifiedEditorPictureSupport = 0x100092B7;
|
|
sl@0
|
51 |
const TUint KUidMUnifiedEditorFieldSupport = 0x100092B8;
|
|
sl@0
|
52 |
const TUint KUidMUnifiedEditorClipboardSupport = 0x100095EF;
|
|
sl@0
|
53 |
|
|
sl@0
|
54 |
/**
|
|
sl@0
|
55 |
An interface class for text editing.
|
|
sl@0
|
56 |
|
|
sl@0
|
57 |
An object that supports text editing has some backing text - zero or more Unicode characters - and
|
|
sl@0
|
58 |
character and paragraph formats applicable to ranges of these characters. A paragraph is a sequence of characters
|
|
sl@0
|
59 |
terminating either at the end of the document or after the next paragraph separator, whichever comes first.
|
|
sl@0
|
60 |
|
|
sl@0
|
61 |
The format for a given position is derived from up to three formatting layers. The base layer is the lowest and
|
|
sl@0
|
62 |
provides default attributes. These may be optionally overridden by attributes from a named style, and these in
|
|
sl@0
|
63 |
turn may be overridden by specific formatting. Text editing objects may support any or none of these layers; they
|
|
sl@0
|
64 |
may in fact ignore all attempts to set format attributes.
|
|
sl@0
|
65 |
@internalComponent
|
|
sl@0
|
66 |
*/
|
|
sl@0
|
67 |
class MUnifiedEditor
|
|
sl@0
|
68 |
|
|
sl@0
|
69 |
{
|
|
sl@0
|
70 |
public:
|
|
sl@0
|
71 |
/**
|
|
sl@0
|
72 |
* constants used when getting formats
|
|
sl@0
|
73 |
*/
|
|
sl@0
|
74 |
enum TFormatLevel
|
|
sl@0
|
75 |
{
|
|
sl@0
|
76 |
ESpecific, // format applied by the user
|
|
sl@0
|
77 |
EEffective // the actual format: a combination of base and specific formats
|
|
sl@0
|
78 |
};
|
|
sl@0
|
79 |
class MStyleSupport : public MTmOptionalInterface
|
|
sl@0
|
80 |
/**
|
|
sl@0
|
81 |
An optional interface to support styles
|
|
sl@0
|
82 |
@internalComponent
|
|
sl@0
|
83 |
*/
|
|
sl@0
|
84 |
{
|
|
sl@0
|
85 |
public:
|
|
sl@0
|
86 |
/**
|
|
sl@0
|
87 |
* Creates a style.
|
|
sl@0
|
88 |
*/
|
|
sl@0
|
89 |
virtual TInt CreateStyleL(const RTmStyle& /*aStyle*/) { return KErrNotSupported; }
|
|
sl@0
|
90 |
/**
|
|
sl@0
|
91 |
* Sets the attributes of a style.
|
|
sl@0
|
92 |
*/
|
|
sl@0
|
93 |
virtual TInt ChangeStyleL(const RTmStyle& /*aStyle*/) { return KErrNotSupported; }
|
|
sl@0
|
94 |
/**
|
|
sl@0
|
95 |
* Applies the named style to the specified run of text.
|
|
sl@0
|
96 |
*/
|
|
sl@0
|
97 |
virtual TInt SetStyleL(TInt aPos, TInt aLength, const TDesC& aName) = 0;
|
|
sl@0
|
98 |
/**
|
|
sl@0
|
99 |
* Renames a style.
|
|
sl@0
|
100 |
*/
|
|
sl@0
|
101 |
virtual TInt RenameStyleL(const TDesC& /*aOldName*/,const TDesC& /*aNewName*/) { return KErrNotSupported; }
|
|
sl@0
|
102 |
/**
|
|
sl@0
|
103 |
* Deletes the named style.
|
|
sl@0
|
104 |
*/
|
|
sl@0
|
105 |
virtual TInt DeleteStyleL(const TDesC& /*aName*/) { return KErrNotSupported; }
|
|
sl@0
|
106 |
/**
|
|
sl@0
|
107 |
* Get the number of named styles.
|
|
sl@0
|
108 |
*/
|
|
sl@0
|
109 |
virtual TInt StyleCount() const = 0;
|
|
sl@0
|
110 |
/**
|
|
sl@0
|
111 |
* Gets the style set at the document position aPos. If no style is set
|
|
sl@0
|
112 |
* there return an empty string and the run length over which no style
|
|
sl@0
|
113 |
* applies.
|
|
sl@0
|
114 |
*/
|
|
sl@0
|
115 |
virtual void GetStyle(TInt aPos, TPtrC& aName, TInt& aRunLength) const = 0;
|
|
sl@0
|
116 |
/**
|
|
sl@0
|
117 |
* Gets the attributes of a named style by completing aStyle from its
|
|
sl@0
|
118 |
* name.
|
|
sl@0
|
119 |
*/
|
|
sl@0
|
120 |
virtual TInt GetStyleByNameL(const TDesC& aName, RTmStyle& aStyle) const = 0;
|
|
sl@0
|
121 |
/**
|
|
sl@0
|
122 |
* Gets the name and attributes of a style by index; use this in
|
|
sl@0
|
123 |
* conjunction with StyleCount to enumerate existing styles.
|
|
sl@0
|
124 |
*/
|
|
sl@0
|
125 |
virtual TInt GetStyleByIndexL(TInt aIndex, RTmStyle& aStyle) const = 0;
|
|
sl@0
|
126 |
};
|
|
sl@0
|
127 |
|
|
sl@0
|
128 |
/**
|
|
sl@0
|
129 |
An optional interface to support embedded pictures
|
|
sl@0
|
130 |
@internalComponent
|
|
sl@0
|
131 |
*/
|
|
sl@0
|
132 |
class MPictureSupport : public MTmOptionalInterface
|
|
sl@0
|
133 |
|
|
sl@0
|
134 |
{
|
|
sl@0
|
135 |
public:
|
|
sl@0
|
136 |
/**
|
|
sl@0
|
137 |
* Inserts a picture, passing ownership in.
|
|
sl@0
|
138 |
*/
|
|
sl@0
|
139 |
virtual void InsertPictureL(TInt aPos, const TPictureHeader& aPictureIn) = 0;
|
|
sl@0
|
140 |
/**
|
|
sl@0
|
141 |
* Deletes picture character in the text at aPos, if any. Ownership of
|
|
sl@0
|
142 |
* any picture is passed to the caller, therefore Picture(aPos,
|
|
sl@0
|
143 |
* aPictureOut) must have been called previously, and
|
|
sl@0
|
144 |
* aPictureOut.DeletePicture() must be called in the future to avoid a
|
|
sl@0
|
145 |
* memory leak.
|
|
sl@0
|
146 |
* If the character at aPos is a picture character, it will be deleted,
|
|
sl@0
|
147 |
* regardless of whether or not a picture was actually attatched.
|
|
sl@0
|
148 |
*/
|
|
sl@0
|
149 |
virtual void DropPictureL(TInt aPos) = 0;
|
|
sl@0
|
150 |
/**
|
|
sl@0
|
151 |
* Gets the picture if any at aPos. No picture is indicated by
|
|
sl@0
|
152 |
* aPictureOut.iPictureType containing KUidNull.
|
|
sl@0
|
153 |
* Ownership of the picture is retained. Note that aPictureOut is
|
|
sl@0
|
154 |
* merely overwritten by this function: aPictureOut.DeletePicture() is
|
|
sl@0
|
155 |
* NOT called!
|
|
sl@0
|
156 |
*/
|
|
sl@0
|
157 |
virtual void Picture(TInt aPos, TPictureHeader& aPictureOut) const = 0;
|
|
sl@0
|
158 |
};
|
|
sl@0
|
159 |
|
|
sl@0
|
160 |
/**
|
|
sl@0
|
161 |
An optional interface to support clipboard operations
|
|
sl@0
|
162 |
@internalComponent
|
|
sl@0
|
163 |
*/
|
|
sl@0
|
164 |
class MClipboardSupport : public MTmOptionalInterface
|
|
sl@0
|
165 |
|
|
sl@0
|
166 |
{
|
|
sl@0
|
167 |
public:
|
|
sl@0
|
168 |
/**
|
|
sl@0
|
169 |
* Copy the text and formatting specified to the stream, updating
|
|
sl@0
|
170 |
* the dictionary as appropriate.
|
|
sl@0
|
171 |
*/
|
|
sl@0
|
172 |
virtual void CopyToStoreL(CStreamStore& aStore, CStreamDictionary& aDictionary,
|
|
sl@0
|
173 |
TInt aPos, TInt aLength) const = 0;
|
|
sl@0
|
174 |
/**
|
|
sl@0
|
175 |
* Insert text and formatting from the stream at aPos.
|
|
sl@0
|
176 |
*/
|
|
sl@0
|
177 |
virtual void PasteFromStoreL(const CStreamStore& aStore,
|
|
sl@0
|
178 |
const CStreamDictionary& aDictionary, TInt aPos) = 0;
|
|
sl@0
|
179 |
};
|
|
sl@0
|
180 |
|
|
sl@0
|
181 |
// VIRTUAL FUNCTIONS
|
|
sl@0
|
182 |
|
|
sl@0
|
183 |
// getters
|
|
sl@0
|
184 |
|
|
sl@0
|
185 |
/**
|
|
sl@0
|
186 |
* Returns the optional interface with the specified UID, or 0 if it is not
|
|
sl@0
|
187 |
* supported.
|
|
sl@0
|
188 |
*/
|
|
sl@0
|
189 |
virtual MTmOptionalInterface* Interface(TUint /*aId*/) { return NULL; }
|
|
sl@0
|
190 |
/**
|
|
sl@0
|
191 |
* Returns the length of the document in characters, not including any
|
|
sl@0
|
192 |
* notional final paragraph separator.
|
|
sl@0
|
193 |
*/
|
|
sl@0
|
194 |
virtual TInt DocumentLength() const = 0;
|
|
sl@0
|
195 |
/**
|
|
sl@0
|
196 |
* Gets some text starting at aPos. The amount of text returned may be as
|
|
sl@0
|
197 |
* much or as little as is convenient to the implementation, but must be
|
|
sl@0
|
198 |
* at least one character. The text is raw Unicode text including any
|
|
sl@0
|
199 |
* paragraph separators.
|
|
sl@0
|
200 |
*/
|
|
sl@0
|
201 |
virtual void GetText(TInt aPos,TPtrC& aText) const = 0;
|
|
sl@0
|
202 |
/**
|
|
sl@0
|
203 |
* Gets the base character and paragraph formats
|
|
sl@0
|
204 |
*/
|
|
sl@0
|
205 |
virtual void GetBaseFormatL(TTmCharFormat& aCharFormat,RTmParFormat& aParFormat) const = 0;
|
|
sl@0
|
206 |
/**
|
|
sl@0
|
207 |
* Gets the specific or effective character format and the run over which
|
|
sl@0
|
208 |
* that format applies.
|
|
sl@0
|
209 |
*/
|
|
sl@0
|
210 |
virtual void GetCharFormat(TInt aPos,TFormatLevel aLevel,
|
|
sl@0
|
211 |
TTmCharFormatLayer& aFormat,TInt& aRunLength) const = 0;
|
|
sl@0
|
212 |
/**
|
|
sl@0
|
213 |
* Gets the specific or effective paragraph format and the run over which
|
|
sl@0
|
214 |
* that format applies.
|
|
sl@0
|
215 |
*/
|
|
sl@0
|
216 |
virtual void GetParFormatL(TInt aPos,TFormatLevel aLevel,
|
|
sl@0
|
217 |
RTmParFormatLayer& aFormat,TInt& aRunLength) const = 0;
|
|
sl@0
|
218 |
|
|
sl@0
|
219 |
// setters
|
|
sl@0
|
220 |
|
|
sl@0
|
221 |
/**
|
|
sl@0
|
222 |
* Inserts text at aPos, optionally applying the specified character and
|
|
sl@0
|
223 |
* paragraph formats. Unspecified attributes take the format at the
|
|
sl@0
|
224 |
* insertion point; what this means in detail is implementation-dependent.
|
|
sl@0
|
225 |
*/
|
|
sl@0
|
226 |
virtual void InsertTextL(TInt aPos,const TDesC& aText,
|
|
sl@0
|
227 |
const TDesC* aStyle = NULL,
|
|
sl@0
|
228 |
const TTmCharFormatLayer* aCharFormat = NULL,
|
|
sl@0
|
229 |
const RTmParFormatLayer* aParFormat = NULL) = 0;
|
|
sl@0
|
230 |
/**
|
|
sl@0
|
231 |
* Deletes aLength characters starting at aPos.
|
|
sl@0
|
232 |
*/
|
|
sl@0
|
233 |
virtual void DeleteTextL(TInt aPos,TInt aLength) = 0;
|
|
sl@0
|
234 |
/**
|
|
sl@0
|
235 |
* Sets the base character and paragraph formats
|
|
sl@0
|
236 |
*/
|
|
sl@0
|
237 |
virtual void SetBaseFormatL(const TTmCharFormat& aCharFormat,const RTmParFormat& aParFormat) = 0;
|
|
sl@0
|
238 |
/**
|
|
sl@0
|
239 |
* Sets specific character attributes beginning at aPos for aLength characters.
|
|
sl@0
|
240 |
*/
|
|
sl@0
|
241 |
virtual void SetCharFormatL(TInt aPos,TInt aLength,const TTmCharFormatLayer& aFormat) = 0;
|
|
sl@0
|
242 |
/**
|
|
sl@0
|
243 |
* Sets specific paragraph attributes beginning at aPos for aLength characters.
|
|
sl@0
|
244 |
*/
|
|
sl@0
|
245 |
virtual void SetParFormatL(TInt aPos,TInt aLength,const RTmParFormatLayer& aFormat) = 0;
|
|
sl@0
|
246 |
/**
|
|
sl@0
|
247 |
* Deletes specific character attributes beginning at aPos for aLength characters.
|
|
sl@0
|
248 |
*/
|
|
sl@0
|
249 |
virtual void DeleteCharFormatL(TInt aPos,TInt aLength) = 0;
|
|
sl@0
|
250 |
/**
|
|
sl@0
|
251 |
* Deletes specific paragraph attributes beginning at aPos for aLength characters.
|
|
sl@0
|
252 |
*/
|
|
sl@0
|
253 |
virtual void DeleteParFormatL(TInt aPos,TInt aLength) = 0;
|
|
sl@0
|
254 |
|
|
sl@0
|
255 |
// NON-VIRTUAL FUNCTIONS
|
|
sl@0
|
256 |
/**
|
|
sl@0
|
257 |
* Reads text into a writable descriptor.
|
|
sl@0
|
258 |
*
|
|
sl@0
|
259 |
* @see GetText(TInt, TPtrC) const
|
|
sl@0
|
260 |
*/
|
|
sl@0
|
261 |
IMPORT_C void GetText(TInt aPos, TDes& aText) const;
|
|
sl@0
|
262 |
/**
|
|
sl@0
|
263 |
* Returns the interface for manipulating styles, if applicable.
|
|
sl@0
|
264 |
*/
|
|
sl@0
|
265 |
inline MStyleSupport* StyleSupport();
|
|
sl@0
|
266 |
inline const MStyleSupport* StyleSupport() const;
|
|
sl@0
|
267 |
/**
|
|
sl@0
|
268 |
* Returns the interface for manipulating pictures, if applicable.
|
|
sl@0
|
269 |
*/
|
|
sl@0
|
270 |
inline MPictureSupport* PictureSupport();
|
|
sl@0
|
271 |
inline const MPictureSupport* PictureSupport() const;
|
|
sl@0
|
272 |
/**
|
|
sl@0
|
273 |
* Returns the interface for clipboard operations, if applicable.
|
|
sl@0
|
274 |
*/
|
|
sl@0
|
275 |
inline MClipboardSupport* ClipboardSupport();
|
|
sl@0
|
276 |
inline const MClipboardSupport* ClipboardSupport() const;
|
|
sl@0
|
277 |
};
|
|
sl@0
|
278 |
|
|
sl@0
|
279 |
// inline functions
|
|
sl@0
|
280 |
|
|
sl@0
|
281 |
MUnifiedEditor::MStyleSupport* MUnifiedEditor::StyleSupport()
|
|
sl@0
|
282 |
{
|
|
sl@0
|
283 |
return static_cast<MStyleSupport*>(Interface(KUidMUnifiedEditorStyleSupport));
|
|
sl@0
|
284 |
}
|
|
sl@0
|
285 |
|
|
sl@0
|
286 |
const MUnifiedEditor::MStyleSupport* MUnifiedEditor::StyleSupport() const
|
|
sl@0
|
287 |
{
|
|
sl@0
|
288 |
return static_cast<MStyleSupport*>(
|
|
sl@0
|
289 |
const_cast<MUnifiedEditor*>(this)->Interface(KUidMUnifiedEditorStyleSupport));
|
|
sl@0
|
290 |
}
|
|
sl@0
|
291 |
|
|
sl@0
|
292 |
MUnifiedEditor::MPictureSupport* MUnifiedEditor::PictureSupport()
|
|
sl@0
|
293 |
{
|
|
sl@0
|
294 |
return static_cast<MPictureSupport*>(Interface(KUidMUnifiedEditorPictureSupport));
|
|
sl@0
|
295 |
}
|
|
sl@0
|
296 |
|
|
sl@0
|
297 |
const MUnifiedEditor::MPictureSupport* MUnifiedEditor::PictureSupport() const
|
|
sl@0
|
298 |
{
|
|
sl@0
|
299 |
return static_cast<MPictureSupport*>(
|
|
sl@0
|
300 |
const_cast<MUnifiedEditor*>(this)->Interface(KUidMUnifiedEditorPictureSupport));
|
|
sl@0
|
301 |
}
|
|
sl@0
|
302 |
|
|
sl@0
|
303 |
MUnifiedEditor::MClipboardSupport* MUnifiedEditor::ClipboardSupport()
|
|
sl@0
|
304 |
{
|
|
sl@0
|
305 |
return static_cast<MClipboardSupport*>(Interface(KUidMUnifiedEditorClipboardSupport));
|
|
sl@0
|
306 |
}
|
|
sl@0
|
307 |
|
|
sl@0
|
308 |
const MUnifiedEditor::MClipboardSupport* MUnifiedEditor::ClipboardSupport() const
|
|
sl@0
|
309 |
{
|
|
sl@0
|
310 |
return static_cast<MClipboardSupport*>(
|
|
sl@0
|
311 |
const_cast<MUnifiedEditor*>(this)->Interface(KUidMUnifiedEditorClipboardSupport));
|
|
sl@0
|
312 |
}
|
|
sl@0
|
313 |
|
|
sl@0
|
314 |
#endif // __UNIFIED_EDITOR_H__
|