|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2003-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 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
#ifndef INLINETEXT_H_
|
|
sl@0
|
20 |
#define INLINETEXT_H_
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
#include <e32std.h>
|
|
sl@0
|
23 |
#include <tagma.h>
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
/**
|
|
sl@0
|
26 |
@publishedPartner
|
|
sl@0
|
27 |
*/
|
|
sl@0
|
28 |
const TUid KInlineTextApiExtensionUid = { 0x101FD03D };
|
|
sl@0
|
29 |
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
/**
|
|
sl@0
|
32 |
Class used to provide custom formatting functionality within Form
|
|
sl@0
|
33 |
as an extended interface (via the GetExtendedInterface mechanism
|
|
sl@0
|
34 |
supplied in MTmSource). Basically allows inline text insertion,
|
|
sl@0
|
35 |
that is, insertion of non-backing store text into the CTmTextLayout
|
|
sl@0
|
36 |
formatting data used when drawing to the graphics device.
|
|
sl@0
|
37 |
|
|
sl@0
|
38 |
Implementors of derived classes need to ensure that, in addition
|
|
sl@0
|
39 |
to anything else it does, their overload of GetExtendedInterface
|
|
sl@0
|
40 |
reacts to being prompted with the UID KInlineTextApiExtensionUid
|
|
sl@0
|
41 |
by returning their class cast as an MTmInlineTextSource. It should
|
|
sl@0
|
42 |
also invoke GetExtendedInterface on its other parent for any
|
|
sl@0
|
43 |
unrecognised UIDs.
|
|
sl@0
|
44 |
|
|
sl@0
|
45 |
@publishedPartner
|
|
sl@0
|
46 |
@released
|
|
sl@0
|
47 |
@see MTmSource::GetExtendedInterface
|
|
sl@0
|
48 |
@see MFormCustomInterfaceProvider
|
|
sl@0
|
49 |
*/
|
|
sl@0
|
50 |
class MTmInlineTextSource
|
|
sl@0
|
51 |
{
|
|
sl@0
|
52 |
public:
|
|
sl@0
|
53 |
/**
|
|
sl@0
|
54 |
Reports the next position into which inline text should be inserted
|
|
sl@0
|
55 |
@param aFrom
|
|
sl@0
|
56 |
The document position and character edge to start from.
|
|
sl@0
|
57 |
@param aMaxLength
|
|
sl@0
|
58 |
The maximum length within which to report inline text.
|
|
sl@0
|
59 |
It means that inline text at position X should be reported if
|
|
sl@0
|
60 |
aFrom <= X && X < aFrom + aMaxLength.
|
|
sl@0
|
61 |
Also report trailing inline text at position aFrom + aMaxLength
|
|
sl@0
|
62 |
because it is really attached to the preceding character.
|
|
sl@0
|
63 |
Always report only the first inline text position >= aFrom.
|
|
sl@0
|
64 |
@param aNext
|
|
sl@0
|
65 |
On exit the position of the next bit of inline text to be inserted.
|
|
sl@0
|
66 |
N.B. The position of trailing text following position N and the
|
|
sl@0
|
67 |
position of leading text preceding position N+1 are both
|
|
sl@0
|
68 |
considered to be N+1 - and the trailing text comes first so if
|
|
sl@0
|
69 |
aFrom specifies a leading edge do not report trailing edge
|
|
sl@0
|
70 |
inline text unless its position is greater than aFrom.
|
|
sl@0
|
71 |
A panic EBadReturnValue will result otherwise.
|
|
sl@0
|
72 |
@return
|
|
sl@0
|
73 |
KErrNone if a position is found within the specified range,
|
|
sl@0
|
74 |
KErrNotFound otherwise.
|
|
sl@0
|
75 |
@post
|
|
sl@0
|
76 |
if KErrNone returned then aFrom <= aNext
|
|
sl@0
|
77 |
&& GetInlineText(aNext).Length() != 0
|
|
sl@0
|
78 |
&& (GetInlineText(X).Length() == 0 for all
|
|
sl@0
|
79 |
TTmDocPos X such that aFrom < X && X < aNext)
|
|
sl@0
|
80 |
else if KErrNotFound returned
|
|
sl@0
|
81 |
GetInlineText(X).Length() == 0 for all
|
|
sl@0
|
82 |
TTmDocPos X such that aFrom <= X && X < aFrom + aMaxLength
|
|
sl@0
|
83 |
*/
|
|
sl@0
|
84 |
virtual TInt GetNextInlineTextPosition(const TTmDocPos& aFrom, TInt aMaxLength, TTmDocPos& aNext) = 0;
|
|
sl@0
|
85 |
|
|
sl@0
|
86 |
/**
|
|
sl@0
|
87 |
Gets a view of the text to be inserted at aAt.
|
|
sl@0
|
88 |
@param aAt
|
|
sl@0
|
89 |
Document position, including character edge, being queried.
|
|
sl@0
|
90 |
@return
|
|
sl@0
|
91 |
Any inline text that should be attached to the specified character edge at aAt.
|
|
sl@0
|
92 |
*/
|
|
sl@0
|
93 |
virtual TPtrC GetInlineText(const TTmDocPos& aAt) = 0;
|
|
sl@0
|
94 |
};
|
|
sl@0
|
95 |
|
|
sl@0
|
96 |
#endif // INLINETEXT_H_
|
|
sl@0
|
97 |
|