1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/textandloc/textrendering/textformatting/inc/InlineText.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,97 @@
     1.4 +/*
     1.5 +* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description: 
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef INLINETEXT_H_
    1.23 +#define INLINETEXT_H_
    1.24 +
    1.25 +#include <e32std.h>
    1.26 +#include <tagma.h>
    1.27 +
    1.28 +/**
    1.29 +@publishedPartner
    1.30 +*/
    1.31 +const TUid KInlineTextApiExtensionUid = { 0x101FD03D };
    1.32 +
    1.33 +
    1.34 +/**
    1.35 +Class used to provide custom formatting functionality within Form
    1.36 +as an extended interface (via the GetExtendedInterface mechanism
    1.37 +supplied in MTmSource). Basically allows inline text insertion,
    1.38 +that is, insertion of non-backing store text into the CTmTextLayout 
    1.39 +formatting data used when drawing to the graphics device.
    1.40 +
    1.41 +Implementors of derived classes need to ensure that, in addition
    1.42 +to anything else it does, their overload of GetExtendedInterface
    1.43 +reacts to being prompted with the UID KInlineTextApiExtensionUid
    1.44 +by returning their class cast as an MTmInlineTextSource. It should
    1.45 +also invoke GetExtendedInterface on its other parent for any
    1.46 +unrecognised UIDs.
    1.47 +
    1.48 +@publishedPartner
    1.49 +@released
    1.50 +@see MTmSource::GetExtendedInterface
    1.51 +@see MFormCustomInterfaceProvider
    1.52 +*/
    1.53 +class MTmInlineTextSource
    1.54 +	{
    1.55 +public:
    1.56 +	/**
    1.57 +	Reports the next position into which inline text should be inserted
    1.58 +	@param aFrom
    1.59 +		The document position and character edge to start from.
    1.60 +	@param aMaxLength
    1.61 +		The maximum length within which to report inline text.
    1.62 +		It means that inline text at position X should be reported if
    1.63 +		aFrom <= X && X < aFrom + aMaxLength.
    1.64 +		Also report trailing inline text at position aFrom + aMaxLength
    1.65 +		because it is really attached to the preceding character.
    1.66 +		Always report only the first inline text position >= aFrom.
    1.67 +	@param aNext
    1.68 +		On exit the position of the next bit of inline text to be inserted.
    1.69 +		N.B. The position of trailing text following position N and the 
    1.70 +		position of leading text preceding position N+1 are both 
    1.71 +		considered to be N+1 - and the trailing text comes first so if
    1.72 +		aFrom specifies a leading edge do not report trailing edge
    1.73 +		inline text unless its position is greater than aFrom.
    1.74 +		A panic EBadReturnValue will result otherwise.
    1.75 +	@return
    1.76 +		KErrNone if a position is found within the specified range,
    1.77 +		KErrNotFound otherwise.
    1.78 +	@post
    1.79 +		if KErrNone returned then aFrom <= aNext
    1.80 +		&& GetInlineText(aNext).Length() != 0
    1.81 +		&& (GetInlineText(X).Length() == 0 for all
    1.82 +		TTmDocPos X such that aFrom < X && X < aNext)
    1.83 +		else if KErrNotFound returned
    1.84 +		GetInlineText(X).Length() == 0 for all
    1.85 +		TTmDocPos X such that aFrom <= X && X < aFrom + aMaxLength
    1.86 +	*/
    1.87 +	virtual TInt GetNextInlineTextPosition(const TTmDocPos& aFrom, TInt aMaxLength, TTmDocPos& aNext) = 0;
    1.88 +
    1.89 +	/**
    1.90 +	Gets a view of the text to be inserted at aAt.
    1.91 +	@param aAt
    1.92 +		Document position, including character edge, being queried.
    1.93 +	@return
    1.94 +		Any inline text that should be attached to the specified character edge at aAt.
    1.95 +	*/
    1.96 +	virtual TPtrC GetInlineText(const TTmDocPos& aAt) = 0;
    1.97 +	};
    1.98 +
    1.99 +#endif	// INLINETEXT_H_
   1.100 +