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