|
sl@0
|
1 |
<G>
|
|
sl@0
|
2 |
<P Alignment=center KeepTogether KeepWithNext>
|
|
sl@0
|
3 |
<C Bold Underline FontHeight=400>Overview
|
|
sl@0
|
4 |
<P Alignment=left SpaceAfter=250 !KeepWithNext>
|
|
sl@0
|
5 |
<C FontHeight=200 !Bold !Underline>The EditableText class hierarchy provides
|
|
sl@0
|
6 |
instantiable classes for editing and storing text. The choice of which
|
|
sl@0
|
7 |
class to use depends on your requirements of text editing.
|
|
sl@0
|
8 |
<P SpaceBefore=250 Alignment=Left Indent=1440 KeepWithNext>
|
|
sl@0
|
9 |
<C Bold StrikeThrough FontHeight=350>Usage
|
|
sl@0
|
10 |
<P Indent=0>
|
|
sl@0
|
11 |
<C !Bold !Strikethrough FontHeight=200>
|
|
sl@0
|
12 |
Two instantiable editable text classes are supplied:
|
|
sl@0
|
13 |
<P Indent=700 SpaceBefore=240 SpaceAfter=240>
|
|
sl@0
|
14 |
GlobalText
|
|
sl@0
|
15 |
<P>
|
|
sl@0
|
16 |
RichText
|
|
sl@0
|
17 |
<P Indent=0>
|
|
sl@0
|
18 |
and each case, there is a choice of physical implementation:
|
|
sl@0
|
19 |
<P Indent=700>Flat storage
|
|
sl@0
|
20 |
<P>Segemented storage.
|
|
sl@0
|
21 |
<P Indent=0>Flat storage is most efficient when there is little text to be stored, or in the case where little or no editing will take place on the stored text.
|
|
sl@0
|
22 |
<P>Segmented storage is most efficient where large quantities of text are to be stored, or where the text has a large dynamic content.
|
|
sl@0
|
23 |
<P>The rich text class supports:
|
|
sl@0
|
24 |
<P Indent=700>paragraph styles
|
|
sl@0
|
25 |
<P>character styles
|
|
sl@0
|
26 |
<P>explicit paragraph & character formatting
|
|
sl@0
|
27 |
<P>embedded pictures etc... (See the spec).
|
|
sl@0
|
28 |
<P Indent=0>In contrast, global text applies a<C Bold Italic> single <C !Bold !Italic>paragraph/character style to the entire contents of the document.
|
|
sl@0
|
29 |
<P>Global text is best used for edit boxes, whereas rich text applications include the word processor and agenda entries, to name but two.
|
|
sl@0
|
30 |
<P Alignment=right SpaceBefore=1440>
|
|
sl@0
|
31 |
<C Bold Underline FontHeight=450>CEditableText Methods<C !Bold !Underline>
|
|
sl@0
|
32 |
<P Alignment=justified SpaceBefore=240 SpaceAfter=300>
|
|
sl@0
|
33 |
<C Bold>ConstructL Phase2 construction<C !Bold>
|
|
sl@0
|
34 |
<P Alignment=left KeepWithNext KeepTogether>
|
|
sl@0
|
35 |
<C Bold>void ConstructL(TDocumentStorage aStorage);<C !Bold>
|
|
sl@0
|
36 |
<P !KeepWithNext !KeepTogether>
|
|
sl@0
|
37 |
All calls to a document constructor must be followed by an explicit call to the<C Underline> ConstructL <C !Underline>method. This method completes the 2 phase object construction favoured by Epoc. The parameter<C Italic Underline> aStorage <C !Ita
|
|
sl@0
|
38 |
lic !Underline>defines which implementation to use. The type<C Underline> TDocumentStorage <C !Underline>is defined in<C Underline> EDITTEXT.H <C !Underline>as follows:
|
|
sl@0
|
39 |
<P Alignment=center>
|
|
sl@0
|
40 |
<C Bold>enum TDocumentStorage {EFlat,ESegmented};<C !Bold>
|
|
sl@0
|
41 |
<P Alignment=justified>
|
|
sl@0
|
42 |
This method may leave. A complete example of document construction is provided below:
|
|
sl@0
|
43 |
<P Indent=1460>
|
|
sl@0
|
44 |
<C Bold>CEditableText* document=new(ELeave) CGlobalText;
|
|
sl@0
|
45 |
<P>
|
|
sl@0
|
46 |
document->ConstructL(ESegmented); // Leaves if construction fails.<C !Bold>
|
|
sl@0
|
47 |
<P Indent=0 Alignment=justified>
|
|
sl@0
|
48 |
A mandatory part of the ConstructL method inserts an end-of-document character into the document. This character is not included in the DocumentLength method.
|