sl@0: /*
sl@0: * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description: 
sl@0: * the class for inline-text format retrieval - in its own header file to prevent low-level 
sl@0: * components dependent on this class from gaining unnecessary (and undesirable) dependencies 
sl@0: * on high-level components
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef __FEPITFR_H__
sl@0: #define __FEPITFR_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: 
sl@0: class TCharFormat;
sl@0: 
sl@0: 
sl@0: /** Specifies the mixin protocol for finding out the formatting to apply to inline 
sl@0: text. 
sl@0: 
sl@0: This class should be overridden by front end processors which support inline editing.
sl@0: 
sl@0: An instance of a class which implements this protocol should be passed to 
sl@0: MCoeFepAwareTextEditor::StartFepInlineEditL(). 
sl@0: 
sl@0: @publishedAll 
sl@0: @released */
sl@0: class MFepInlineTextFormatRetriever // to be overridden by inline-editing front-end processors
sl@0: 	{
sl@0: public:
sl@0: 	/** Gets the character formatting to apply to the inline text. 
sl@0: 	
sl@0: 	This function may be used to differentiate the formatting of the inline text 
sl@0: 	from the surrounding text. The first parameter should be set to contain the 
sl@0: 	character formatting values to use.
sl@0: 	
sl@0: 	MCoeFepAwareTextEditor provides a member function for finding out the character 
sl@0: 	formatting of the surrounding text - GetFormatForFep(). This can be called 
sl@0: 	inside the implementation of this function to make any necessary adjustments 
sl@0: 	to the format of the inline text to ensure that it is different from the surrounding 
sl@0: 	text.
sl@0: 	
sl@0: 	The second and third parameters enable different parts of the inline text 
sl@0: 	to have different formatting. 
sl@0: 	
sl@0: 	All implementations of this function need to set the aNumberOfCharactersWithSameFormat 
sl@0: 	parameter. If all of the inline text uses the same formatting then aNumberOfCharactersWithSameFormat 
sl@0: 	should be set to the length of the inline text and the aPositionOfCharacter 
sl@0: 	parameter can be ignored.
sl@0: 	
sl@0: 	When the inline text does not all use the same formatting, the second parameter 
sl@0: 	should be set to the number of characters starting at aPositionOfCharacter 
sl@0: 	which have the same formatting: see the following example.
sl@0: 	
sl@0: 	Example
sl@0: 	
sl@0: 	If the inline text is 7 characters long, the first 4 characters are in format 
sl@0: 	A, the next 2 characters are in format B, and the remaining character is in 
sl@0: 	format C.
sl@0: 	
sl@0: 	When the FEP framework (which knows that the inline text is 7 characters long) 
sl@0: 	needs to find out the format of the inline text, it calls GetFormatOfFepInlineText() 
sl@0: 	passing zero into aPositionOfCharacter (to signify the start of the inline 
sl@0: 	text). 
sl@0: 	
sl@0: 	As the first 4 characters are all in format A, the function should set aFormat 
sl@0: 	to A and it should set aNumberOfCharactersWithSameFormat to 4. As the FEP 
sl@0: 	framework has only been told the format of the first 4 characters, it calls 
sl@0: 	GetFormatOfFepInlineText() again passing 4 into aPositionOfCharacter. As the 
sl@0: 	2 characters starting at position 4 are all in format B, the function should 
sl@0: 	set aFormat to B and it should set aNumberOfCharactersWithSameFormat to 2. 
sl@0: 	The FEP framework still does not know the format of the 7th character so it 
sl@0: 	calls GetFormatOfFepInlineText() a third time passing 6 into aPositionOfCharacter. 
sl@0: 	As the character at position 6 is in format C, the function should set aFormat 
sl@0: 	to C and it should set aNumberOfCharactersWithSameFormat to 1. The FEP framework 
sl@0: 	now knows the format of all of the inline text.
sl@0: 	
sl@0: 	@param aFormat On return, contains the formatting to apply to the inline text 
sl@0: 	(or to a portion of it).
sl@0: 	@param aNumberOfCharactersWithSameFormat On return, contains the number of 
sl@0: 	characters in the inline text (starting at aPositionOfCharacter) which have 
sl@0: 	the same formatting.
sl@0: 	@param aPositionOfCharacter Start position within the inline text. */
sl@0: 	virtual void GetFormatOfFepInlineText(TCharFormat& aFormat, TInt& aNumberOfCharactersWithSameFormat, TInt aPositionOfCharacter) const=0;
sl@0: private: // reserved. do not override!
sl@0: 	IMPORT_C virtual void MFepInlineTextFormatRetriever_Reserved_1();
sl@0: 	IMPORT_C virtual void MFepInlineTextFormatRetriever_Reserved_2();
sl@0: 	};
sl@0: 
sl@0: #endif	// __FEPITFR_H__
sl@0: