|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 1997-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 |
* the class for inline-text format retrieval - in its own header file to prevent low-level
|
|
sl@0
|
16 |
* components dependent on this class from gaining unnecessary (and undesirable) dependencies
|
|
sl@0
|
17 |
* on high-level components
|
|
sl@0
|
18 |
*
|
|
sl@0
|
19 |
*/
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
#ifndef __FEPITFR_H__
|
|
sl@0
|
23 |
#define __FEPITFR_H__
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
#include <e32std.h>
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
class TCharFormat;
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
/** Specifies the mixin protocol for finding out the formatting to apply to inline
|
|
sl@0
|
31 |
text.
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
This class should be overridden by front end processors which support inline editing.
|
|
sl@0
|
34 |
|
|
sl@0
|
35 |
An instance of a class which implements this protocol should be passed to
|
|
sl@0
|
36 |
MCoeFepAwareTextEditor::StartFepInlineEditL().
|
|
sl@0
|
37 |
|
|
sl@0
|
38 |
@publishedAll
|
|
sl@0
|
39 |
@released */
|
|
sl@0
|
40 |
class MFepInlineTextFormatRetriever // to be overridden by inline-editing front-end processors
|
|
sl@0
|
41 |
{
|
|
sl@0
|
42 |
public:
|
|
sl@0
|
43 |
/** Gets the character formatting to apply to the inline text.
|
|
sl@0
|
44 |
|
|
sl@0
|
45 |
This function may be used to differentiate the formatting of the inline text
|
|
sl@0
|
46 |
from the surrounding text. The first parameter should be set to contain the
|
|
sl@0
|
47 |
character formatting values to use.
|
|
sl@0
|
48 |
|
|
sl@0
|
49 |
MCoeFepAwareTextEditor provides a member function for finding out the character
|
|
sl@0
|
50 |
formatting of the surrounding text - GetFormatForFep(). This can be called
|
|
sl@0
|
51 |
inside the implementation of this function to make any necessary adjustments
|
|
sl@0
|
52 |
to the format of the inline text to ensure that it is different from the surrounding
|
|
sl@0
|
53 |
text.
|
|
sl@0
|
54 |
|
|
sl@0
|
55 |
The second and third parameters enable different parts of the inline text
|
|
sl@0
|
56 |
to have different formatting.
|
|
sl@0
|
57 |
|
|
sl@0
|
58 |
All implementations of this function need to set the aNumberOfCharactersWithSameFormat
|
|
sl@0
|
59 |
parameter. If all of the inline text uses the same formatting then aNumberOfCharactersWithSameFormat
|
|
sl@0
|
60 |
should be set to the length of the inline text and the aPositionOfCharacter
|
|
sl@0
|
61 |
parameter can be ignored.
|
|
sl@0
|
62 |
|
|
sl@0
|
63 |
When the inline text does not all use the same formatting, the second parameter
|
|
sl@0
|
64 |
should be set to the number of characters starting at aPositionOfCharacter
|
|
sl@0
|
65 |
which have the same formatting: see the following example.
|
|
sl@0
|
66 |
|
|
sl@0
|
67 |
Example
|
|
sl@0
|
68 |
|
|
sl@0
|
69 |
If the inline text is 7 characters long, the first 4 characters are in format
|
|
sl@0
|
70 |
A, the next 2 characters are in format B, and the remaining character is in
|
|
sl@0
|
71 |
format C.
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
When the FEP framework (which knows that the inline text is 7 characters long)
|
|
sl@0
|
74 |
needs to find out the format of the inline text, it calls GetFormatOfFepInlineText()
|
|
sl@0
|
75 |
passing zero into aPositionOfCharacter (to signify the start of the inline
|
|
sl@0
|
76 |
text).
|
|
sl@0
|
77 |
|
|
sl@0
|
78 |
As the first 4 characters are all in format A, the function should set aFormat
|
|
sl@0
|
79 |
to A and it should set aNumberOfCharactersWithSameFormat to 4. As the FEP
|
|
sl@0
|
80 |
framework has only been told the format of the first 4 characters, it calls
|
|
sl@0
|
81 |
GetFormatOfFepInlineText() again passing 4 into aPositionOfCharacter. As the
|
|
sl@0
|
82 |
2 characters starting at position 4 are all in format B, the function should
|
|
sl@0
|
83 |
set aFormat to B and it should set aNumberOfCharactersWithSameFormat to 2.
|
|
sl@0
|
84 |
The FEP framework still does not know the format of the 7th character so it
|
|
sl@0
|
85 |
calls GetFormatOfFepInlineText() a third time passing 6 into aPositionOfCharacter.
|
|
sl@0
|
86 |
As the character at position 6 is in format C, the function should set aFormat
|
|
sl@0
|
87 |
to C and it should set aNumberOfCharactersWithSameFormat to 1. The FEP framework
|
|
sl@0
|
88 |
now knows the format of all of the inline text.
|
|
sl@0
|
89 |
|
|
sl@0
|
90 |
@param aFormat On return, contains the formatting to apply to the inline text
|
|
sl@0
|
91 |
(or to a portion of it).
|
|
sl@0
|
92 |
@param aNumberOfCharactersWithSameFormat On return, contains the number of
|
|
sl@0
|
93 |
characters in the inline text (starting at aPositionOfCharacter) which have
|
|
sl@0
|
94 |
the same formatting.
|
|
sl@0
|
95 |
@param aPositionOfCharacter Start position within the inline text. */
|
|
sl@0
|
96 |
virtual void GetFormatOfFepInlineText(TCharFormat& aFormat, TInt& aNumberOfCharactersWithSameFormat, TInt aPositionOfCharacter) const=0;
|
|
sl@0
|
97 |
private: // reserved. do not override!
|
|
sl@0
|
98 |
IMPORT_C virtual void MFepInlineTextFormatRetriever_Reserved_1();
|
|
sl@0
|
99 |
IMPORT_C virtual void MFepInlineTextFormatRetriever_Reserved_2();
|
|
sl@0
|
100 |
};
|
|
sl@0
|
101 |
|
|
sl@0
|
102 |
#endif // __FEPITFR_H__
|
|
sl@0
|
103 |
|