|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2007 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 the License "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 |
* Base classes used for holding inline text for the Form MTmInlineTextSource interface.
|
|
sl@0
|
16 |
*
|
|
sl@0
|
17 |
*/
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
#ifndef INLINETEXTBASE_H
|
|
sl@0
|
21 |
#define INLINETEXTBASE_H
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
// INCLUDES
|
|
sl@0
|
24 |
#include <e32std.h>
|
|
sl@0
|
25 |
#include <e32base.h>
|
|
sl@0
|
26 |
#include <medobsrv.h>
|
|
sl@0
|
27 |
#include <inlinetext.h>
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
// CONSTANTS
|
|
sl@0
|
30 |
enum TInlineTextPanic
|
|
sl@0
|
31 |
{
|
|
sl@0
|
32 |
EInlineTextBadInlineTextFetch,
|
|
sl@0
|
33 |
EInlineTextStoreCorrupted
|
|
sl@0
|
34 |
};
|
|
sl@0
|
35 |
|
|
sl@0
|
36 |
#define KInlineTextParagraphDelimiter 0x2029
|
|
sl@0
|
37 |
|
|
sl@0
|
38 |
GLREF_C void Panic(TInlineTextPanic aPanic);
|
|
sl@0
|
39 |
|
|
sl@0
|
40 |
// CLASS DECLARATION
|
|
sl@0
|
41 |
|
|
sl@0
|
42 |
class TTmDocPos;
|
|
sl@0
|
43 |
|
|
sl@0
|
44 |
/**
|
|
sl@0
|
45 |
* This class is used to hold text that is being formatted into text via the inline text
|
|
sl@0
|
46 |
* interface.
|
|
sl@0
|
47 |
*
|
|
sl@0
|
48 |
* @lib InlineText
|
|
sl@0
|
49 |
* @since 3.2
|
|
sl@0
|
50 |
*/
|
|
sl@0
|
51 |
NONSHARABLE_CLASS(CInlineTextPositionedText): public CBase
|
|
sl@0
|
52 |
{
|
|
sl@0
|
53 |
public: // 2stage constructor and descructor
|
|
sl@0
|
54 |
/**
|
|
sl@0
|
55 |
* Fully constructs the object given position and text. A copy of the passed-in text is made
|
|
sl@0
|
56 |
* on the heap, owned by the constructed object.
|
|
sl@0
|
57 |
*
|
|
sl@0
|
58 |
* @param aPosition TTmDocPos at which text is to be reported
|
|
sl@0
|
59 |
* @param aInlineText Text to be returned at this position
|
|
sl@0
|
60 |
*
|
|
sl@0
|
61 |
* @return pointer to fully constructed object
|
|
sl@0
|
62 |
*/
|
|
sl@0
|
63 |
static CInlineTextPositionedText* NewL( const TTmDocPos& aPosition, const TDesC& aInlineText );
|
|
sl@0
|
64 |
|
|
sl@0
|
65 |
/**
|
|
sl@0
|
66 |
* Destructor
|
|
sl@0
|
67 |
*/
|
|
sl@0
|
68 |
~CInlineTextPositionedText();
|
|
sl@0
|
69 |
|
|
sl@0
|
70 |
public:
|
|
sl@0
|
71 |
|
|
sl@0
|
72 |
/**
|
|
sl@0
|
73 |
* Access method to the position in the document of the inline text
|
|
sl@0
|
74 |
* @return TTmDocPos of the inline text
|
|
sl@0
|
75 |
*/
|
|
sl@0
|
76 |
const TTmDocPos& DocPos() const;
|
|
sl@0
|
77 |
|
|
sl@0
|
78 |
/**
|
|
sl@0
|
79 |
* Access method to the text for the inline edit
|
|
sl@0
|
80 |
* @return reference to an unmodifiable descriptor for the text held in this object
|
|
sl@0
|
81 |
*/
|
|
sl@0
|
82 |
const TDesC& InlineText() const;
|
|
sl@0
|
83 |
|
|
sl@0
|
84 |
private:
|
|
sl@0
|
85 |
/**
|
|
sl@0
|
86 |
* C++ constructor
|
|
sl@0
|
87 |
*/
|
|
sl@0
|
88 |
CInlineTextPositionedText( const TTmDocPos& aPosition );
|
|
sl@0
|
89 |
|
|
sl@0
|
90 |
/**
|
|
sl@0
|
91 |
* This method completes the construction by allocating the text storage..
|
|
sl@0
|
92 |
*/
|
|
sl@0
|
93 |
void ConstructL( const TDesC& aInlineText );
|
|
sl@0
|
94 |
|
|
sl@0
|
95 |
private:
|
|
sl@0
|
96 |
TTmDocPos iDocPos;
|
|
sl@0
|
97 |
HBufC* iText; // owned
|
|
sl@0
|
98 |
};
|
|
sl@0
|
99 |
|
|
sl@0
|
100 |
/**
|
|
sl@0
|
101 |
* Class to hold an array of inline texts for access
|
|
sl@0
|
102 |
*
|
|
sl@0
|
103 |
* @lib InlineText
|
|
sl@0
|
104 |
* @since 3.2
|
|
sl@0
|
105 |
*/
|
|
sl@0
|
106 |
NONSHARABLE_CLASS(CInlineTextStore) : public CArrayPtrFlat<CInlineTextPositionedText>
|
|
sl@0
|
107 |
{
|
|
sl@0
|
108 |
public: // 2-stage constructor and destructor
|
|
sl@0
|
109 |
static CInlineTextStore* NewL();
|
|
sl@0
|
110 |
~CInlineTextStore();
|
|
sl@0
|
111 |
|
|
sl@0
|
112 |
public:
|
|
sl@0
|
113 |
/**
|
|
sl@0
|
114 |
* Clears and destroys all inline texts
|
|
sl@0
|
115 |
*/
|
|
sl@0
|
116 |
void Clear();
|
|
sl@0
|
117 |
|
|
sl@0
|
118 |
/**
|
|
sl@0
|
119 |
* Clears and destroys inline texts in a range of document positions. Range is taken
|
|
sl@0
|
120 |
* to be inclusive.
|
|
sl@0
|
121 |
* @param aStart First position from which and including inline texts are removed
|
|
sl@0
|
122 |
* @param aEnd Final position up to which and including inline texts are removed
|
|
sl@0
|
123 |
*/
|
|
sl@0
|
124 |
void ClearRange( const TTmDocPos& aStart, const TTmDocPos& aEnd );
|
|
sl@0
|
125 |
|
|
sl@0
|
126 |
/**
|
|
sl@0
|
127 |
* Insert the inline text object into the store
|
|
sl@0
|
128 |
* @param aInlineText object to add
|
|
sl@0
|
129 |
*/
|
|
sl@0
|
130 |
void InsertInlineTextL( CInlineTextPositionedText* aInlineText );
|
|
sl@0
|
131 |
|
|
sl@0
|
132 |
/**
|
|
sl@0
|
133 |
* Returns the pointer to the document position closest after or including the passed-in
|
|
sl@0
|
134 |
* position.
|
|
sl@0
|
135 |
* @param aDocPos position from which to look for inline texts
|
|
sl@0
|
136 |
* @return pointer to document position at or closest after input position
|
|
sl@0
|
137 |
* NULL if none is found
|
|
sl@0
|
138 |
*/
|
|
sl@0
|
139 |
const TTmDocPos* NextInlineTextDocPos( const TTmDocPos& aDocPos ) const;
|
|
sl@0
|
140 |
|
|
sl@0
|
141 |
/**
|
|
sl@0
|
142 |
* Searches for the input document position and returns the index in the Store
|
|
sl@0
|
143 |
* @param aDocPos input document position
|
|
sl@0
|
144 |
* @return index at which the input position is found
|
|
sl@0
|
145 |
* -1 if the document position is not in the store
|
|
sl@0
|
146 |
*/
|
|
sl@0
|
147 |
TInt IndexFromDocPos( const TTmDocPos& aDocPos ) const;
|
|
sl@0
|
148 |
|
|
sl@0
|
149 |
private:
|
|
sl@0
|
150 |
/**
|
|
sl@0
|
151 |
* Private constructor; no derivation permitted
|
|
sl@0
|
152 |
*/
|
|
sl@0
|
153 |
CInlineTextStore();
|
|
sl@0
|
154 |
|
|
sl@0
|
155 |
/**
|
|
sl@0
|
156 |
* Internal method for determining index of the position later or including
|
|
sl@0
|
157 |
* the passed-in position
|
|
sl@0
|
158 |
*/
|
|
sl@0
|
159 |
TInt NextIndexStartingAtDocPos( const TTmDocPos& aDocPos ) const;
|
|
sl@0
|
160 |
|
|
sl@0
|
161 |
private: // data members
|
|
sl@0
|
162 |
|
|
sl@0
|
163 |
};
|
|
sl@0
|
164 |
|
|
sl@0
|
165 |
/**
|
|
sl@0
|
166 |
* Concrete implementation of MTmInlineTextSource, adding an edit observation interface
|
|
sl@0
|
167 |
* and common infrastructure for managing inline texts
|
|
sl@0
|
168 |
*
|
|
sl@0
|
169 |
* @lib InlineText
|
|
sl@0
|
170 |
* @since 3.2
|
|
sl@0
|
171 |
*/
|
|
sl@0
|
172 |
NONSHARABLE_CLASS(CInlineTextSource) : public CBase, public MTmInlineTextSource, public MEditObserver
|
|
sl@0
|
173 |
{
|
|
sl@0
|
174 |
public: // C++ constructor and destructor
|
|
sl@0
|
175 |
CInlineTextSource(); // Class is intended for derivation
|
|
sl@0
|
176 |
~CInlineTextSource();
|
|
sl@0
|
177 |
|
|
sl@0
|
178 |
/**
|
|
sl@0
|
179 |
* 2nd state constructor
|
|
sl@0
|
180 |
*/
|
|
sl@0
|
181 |
void ConstructL();
|
|
sl@0
|
182 |
|
|
sl@0
|
183 |
public: // From MTmInlineTextSource
|
|
sl@0
|
184 |
|
|
sl@0
|
185 |
/**
|
|
sl@0
|
186 |
* Reports the next position into which inline text should be inserted
|
|
sl@0
|
187 |
*
|
|
sl@0
|
188 |
* See inlinetext.h
|
|
sl@0
|
189 |
*/
|
|
sl@0
|
190 |
virtual TInt GetNextInlineTextPosition(const TTmDocPos& aFrom, TInt aMaxLength, TTmDocPos& aNext);
|
|
sl@0
|
191 |
|
|
sl@0
|
192 |
/**
|
|
sl@0
|
193 |
* Gets a view of the text to be inserted at aAt.
|
|
sl@0
|
194 |
*
|
|
sl@0
|
195 |
* See inlinetext.h
|
|
sl@0
|
196 |
*/
|
|
sl@0
|
197 |
virtual TPtrC GetInlineText(const TTmDocPos& aAt);
|
|
sl@0
|
198 |
|
|
sl@0
|
199 |
public: // From MEditObserver
|
|
sl@0
|
200 |
|
|
sl@0
|
201 |
/**
|
|
sl@0
|
202 |
* See medobsrv.h
|
|
sl@0
|
203 |
*
|
|
sl@0
|
204 |
* This class implements an empty implementation of this method. Implement in subclass only if
|
|
sl@0
|
205 |
* action is to be taken upon edit - and if edit event is actually going to be supplied, which
|
|
sl@0
|
206 |
* is only available in the context of CEikRichTextEditor
|
|
sl@0
|
207 |
*/
|
|
sl@0
|
208 |
virtual void EditObserver(TInt aStart, TInt aExtent);
|
|
sl@0
|
209 |
|
|
sl@0
|
210 |
public:
|
|
sl@0
|
211 |
// New methods
|
|
sl@0
|
212 |
|
|
sl@0
|
213 |
/**
|
|
sl@0
|
214 |
* Framework method to inform subclasses what part of the document is currently being interrogated
|
|
sl@0
|
215 |
* for inline edits.
|
|
sl@0
|
216 |
* Currently this will be where formatting is performed and the store of inline texts updated.
|
|
sl@0
|
217 |
* (In future, an edit observer interface of some kind will be used to trigger that)
|
|
sl@0
|
218 |
*
|
|
sl@0
|
219 |
* @param aFrom position from which to re-consider the formatting
|
|
sl@0
|
220 |
* @param aTo position up to which to re-consider the formatting
|
|
sl@0
|
221 |
*/
|
|
sl@0
|
222 |
virtual void CheckFormattingL(const TTmDocPos& aFrom, const TTmDocPos& aTo );
|
|
sl@0
|
223 |
|
|
sl@0
|
224 |
/**
|
|
sl@0
|
225 |
* Non-virtual method for checking for inline text. Similar behaviour to GetInlineText, except
|
|
sl@0
|
226 |
* that is it const, and will not panic (but just return EFalse) if there is no inline text
|
|
sl@0
|
227 |
* at the input TTmDocPos.
|
|
sl@0
|
228 |
*
|
|
sl@0
|
229 |
* @param aAt Position at which to access inline text
|
|
sl@0
|
230 |
* @param aPtrFound This contains the inline text if ETrue is returned
|
|
sl@0
|
231 |
* @return EFalse if there is no inline text at the input position
|
|
sl@0
|
232 |
*/
|
|
sl@0
|
233 |
TBool HasInlineTextAt( const TTmDocPos& aAt, TPtrC& aPtrFound ) const;
|
|
sl@0
|
234 |
|
|
sl@0
|
235 |
protected:
|
|
sl@0
|
236 |
|
|
sl@0
|
237 |
/**
|
|
sl@0
|
238 |
* Access to the inline text store for derived classes
|
|
sl@0
|
239 |
*/
|
|
sl@0
|
240 |
CInlineTextStore* InlineTextStore() const;
|
|
sl@0
|
241 |
|
|
sl@0
|
242 |
private:
|
|
sl@0
|
243 |
CInlineTextStore* iInlineTextStore; // owned
|
|
sl@0
|
244 |
};
|
|
sl@0
|
245 |
|
|
sl@0
|
246 |
#endif
|
|
sl@0
|
247 |
|
|
sl@0
|
248 |
// End of File
|