sl@0: /*
sl@0: * Copyright (c) 2003-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: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef INLINETEXT_H_
sl@0: #define INLINETEXT_H_
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <tagma.h>
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: */
sl@0: const TUid KInlineTextApiExtensionUid = { 0x101FD03D };
sl@0: 
sl@0: 
sl@0: /**
sl@0: Class used to provide custom formatting functionality within Form
sl@0: as an extended interface (via the GetExtendedInterface mechanism
sl@0: supplied in MTmSource). Basically allows inline text insertion,
sl@0: that is, insertion of non-backing store text into the CTmTextLayout 
sl@0: formatting data used when drawing to the graphics device.
sl@0: 
sl@0: Implementors of derived classes need to ensure that, in addition
sl@0: to anything else it does, their overload of GetExtendedInterface
sl@0: reacts to being prompted with the UID KInlineTextApiExtensionUid
sl@0: by returning their class cast as an MTmInlineTextSource. It should
sl@0: also invoke GetExtendedInterface on its other parent for any
sl@0: unrecognised UIDs.
sl@0: 
sl@0: @publishedPartner
sl@0: @released
sl@0: @see MTmSource::GetExtendedInterface
sl@0: @see MFormCustomInterfaceProvider
sl@0: */
sl@0: class MTmInlineTextSource
sl@0: 	{
sl@0: public:
sl@0: 	/**
sl@0: 	Reports the next position into which inline text should be inserted
sl@0: 	@param aFrom
sl@0: 		The document position and character edge to start from.
sl@0: 	@param aMaxLength
sl@0: 		The maximum length within which to report inline text.
sl@0: 		It means that inline text at position X should be reported if
sl@0: 		aFrom <= X && X < aFrom + aMaxLength.
sl@0: 		Also report trailing inline text at position aFrom + aMaxLength
sl@0: 		because it is really attached to the preceding character.
sl@0: 		Always report only the first inline text position >= aFrom.
sl@0: 	@param aNext
sl@0: 		On exit the position of the next bit of inline text to be inserted.
sl@0: 		N.B. The position of trailing text following position N and the 
sl@0: 		position of leading text preceding position N+1 are both 
sl@0: 		considered to be N+1 - and the trailing text comes first so if
sl@0: 		aFrom specifies a leading edge do not report trailing edge
sl@0: 		inline text unless its position is greater than aFrom.
sl@0: 		A panic EBadReturnValue will result otherwise.
sl@0: 	@return
sl@0: 		KErrNone if a position is found within the specified range,
sl@0: 		KErrNotFound otherwise.
sl@0: 	@post
sl@0: 		if KErrNone returned then aFrom <= aNext
sl@0: 		&& GetInlineText(aNext).Length() != 0
sl@0: 		&& (GetInlineText(X).Length() == 0 for all
sl@0: 		TTmDocPos X such that aFrom < X && X < aNext)
sl@0: 		else if KErrNotFound returned
sl@0: 		GetInlineText(X).Length() == 0 for all
sl@0: 		TTmDocPos X such that aFrom <= X && X < aFrom + aMaxLength
sl@0: 	*/
sl@0: 	virtual TInt GetNextInlineTextPosition(const TTmDocPos& aFrom, TInt aMaxLength, TTmDocPos& aNext) = 0;
sl@0: 
sl@0: 	/**
sl@0: 	Gets a view of the text to be inserted at aAt.
sl@0: 	@param aAt
sl@0: 		Document position, including character edge, being queried.
sl@0: 	@return
sl@0: 		Any inline text that should be attached to the specified character edge at aAt.
sl@0: 	*/
sl@0: 	virtual TPtrC GetInlineText(const TTmDocPos& aAt) = 0;
sl@0: 	};
sl@0: 
sl@0: #endif	// INLINETEXT_H_
sl@0: