|
1 /* |
|
2 * Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
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". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: MPtiEngineCompositionDataInterface class definitions. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 |
|
21 |
|
22 |
|
23 |
|
24 |
|
25 |
|
26 |
|
27 |
|
28 |
|
29 |
|
30 |
|
31 |
|
32 #ifndef MPTIENGINECOMPOSITIONDATAINTERFACE_H |
|
33 #define MPTIENGINECOMPOSITIONDATAINTERFACE_H |
|
34 |
|
35 // INCLUDES |
|
36 #include <e32base.h> |
|
37 #include <badesca.h> |
|
38 |
|
39 // CLASS DECLARATION |
|
40 |
|
41 /** |
|
42 * MPtiEngineCompositionDataInterface class. |
|
43 * This is a class which returned by CPtiEngine::CompositionData() API. |
|
44 * |
|
45 * @lib PtiEngine.lib |
|
46 * @since 2.6 |
|
47 */ |
|
48 class MPtiEngineCompositionDataInterface |
|
49 { |
|
50 public: |
|
51 // the attribute of phrase |
|
52 enum TPtiAttributeOfPhrase |
|
53 { |
|
54 EPtiAttributeTransitoryInput, // transitory input(before converting) |
|
55 EPtiAttributeNonTargetConvert, // non-target phrase(while converting) |
|
56 EPtiAttributeTargetConvert // target phrase(while converting) |
|
57 }; |
|
58 |
|
59 public: |
|
60 /** |
|
61 * Gets a cursor position on converting string |
|
62 * @since 2.6 |
|
63 * @return TInt : The current cursor position |
|
64 * If the cursor is left side, the returned value is 0. |
|
65 */ |
|
66 IMPORT_C virtual TInt CursorPosition() const = 0; |
|
67 |
|
68 /** |
|
69 * Gets the number of phrases on converting string |
|
70 * @since 2.6 |
|
71 * @return TInt : the number of phrases |
|
72 */ |
|
73 IMPORT_C virtual TInt NumberOfPhrase() const = 0; |
|
74 |
|
75 /** |
|
76 * Gets the character count of each phrase |
|
77 * @since 2.6 |
|
78 * @return TPtrC8 : the arrary keeping the character count |
|
79 */ |
|
80 IMPORT_C virtual TPtrC8 LengthOfPhrase() const = 0; |
|
81 |
|
82 /** |
|
83 * Gets the attribute of each phrase |
|
84 * @since 2.6 |
|
85 * @return TPtrC8 : the arrary keeping the value of TPtiAttributeOfPhrase |
|
86 */ |
|
87 IMPORT_C virtual TPtrC8 AttributeOfPhrase() const = 0; |
|
88 |
|
89 /** |
|
90 * Gets the converting string |
|
91 * @since 2.6 |
|
92 * @return TPtrC : the converting string |
|
93 */ |
|
94 IMPORT_C virtual TPtrC ConvertingString() const = 0; |
|
95 |
|
96 /** |
|
97 * Gets the specified string |
|
98 * @since 2.6 |
|
99 * @return TPtrC : the completed string |
|
100 */ |
|
101 IMPORT_C virtual TPtrC CompletedString() const = 0; |
|
102 |
|
103 /** |
|
104 * Gets the reading string of the completed string |
|
105 * @since 2.6 |
|
106 * @return TPtrC : the reading string |
|
107 */ |
|
108 IMPORT_C virtual TPtrC ReadingString() const = 0; |
|
109 |
|
110 /** |
|
111 * Checking it whether a character in a current cursor position |
|
112 * is in modifiable character. |
|
113 * The modifiable character is diacritics and small characters. |
|
114 * There are two diacritics marks in Japanese: viced sound mark |
|
115 * and semi-voiced sound mark. |
|
116 * @since 2.6 |
|
117 * @return TBool : ETrue is modifiable character. |
|
118 */ |
|
119 IMPORT_C virtual TBool IsModifiableCharacter() const = 0; |
|
120 }; |
|
121 |
|
122 #endif // MPTIENGINECOMPOSITIONDATAINTERFACE_H |
|
123 |
|
124 // End of file |
|
125 |