|
1 /* |
|
2 * Copyright (c) 2002-2005 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: vkb layout |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef M_AKNFEPVKBLAYOUTCONTEXT_H |
|
20 #define M_AKNFEPVKBLAYOUTCONTEXT_H |
|
21 |
|
22 // INCLUDES |
|
23 #include "peninputvkbdataprovider.h" |
|
24 |
|
25 /** class forward decalaration */ |
|
26 class CFepUiBaseCtrl; |
|
27 |
|
28 /** |
|
29 * peninputvkbcn layout interface implemtation |
|
30 * |
|
31 * @lib peninputvkbcn.lib |
|
32 * @since S60 v3.2 |
|
33 */ |
|
34 class MAknFepVkbLayoutContext |
|
35 { |
|
36 public: |
|
37 |
|
38 /** |
|
39 * Send event to vkb window |
|
40 * |
|
41 * @since S60 v3.2 |
|
42 * @param aEventType The event type |
|
43 * @param aCtrl The sender |
|
44 * @param aEventData The event data. |
|
45 * @return None |
|
46 */ |
|
47 virtual void SendEventToVkbControl(TInt aEventType, CFepUiBaseCtrl* aCtrl, |
|
48 const TDesC& aEventData = KNullDesC) = 0; |
|
49 |
|
50 |
|
51 /** |
|
52 * Sendkey to fep |
|
53 * |
|
54 * @since S60 v3.2 |
|
55 * @param aEventType Event type |
|
56 * @param aEventData Event data |
|
57 * @return None. |
|
58 */ |
|
59 virtual void Sendkey(TInt aEventType,const TDesC& aEventData = KNullDesC) = 0; |
|
60 |
|
61 /** |
|
62 * Request data from data provider |
|
63 * |
|
64 * @since S60 v3.2 |
|
65 * @param aDataType The data request |
|
66 * @return The data you request |
|
67 */ |
|
68 virtual TInt RequestData(TAknFepDataType aDataType) = 0; |
|
69 |
|
70 /** |
|
71 * Get resource utils |
|
72 * |
|
73 * @since S60 v3.2 |
|
74 * @param aEventType Event type |
|
75 * @param aData Event data |
|
76 * @return The resource utils |
|
77 */ |
|
78 virtual void SetData(TAknFepDataType aDataType,TInt aData) = 0; |
|
79 |
|
80 /** |
|
81 * Force edit gain focus |
|
82 * |
|
83 * @since S60 v3.2 |
|
84 * @param aWhichEdit The control id which will get focus |
|
85 * @return None. |
|
86 */ |
|
87 virtual void ForceEditGainFocus(TInt aWhichEdit) = 0; |
|
88 |
|
89 /** |
|
90 * Reset all status in layout |
|
91 * |
|
92 * @since S60 v3.2 |
|
93 * @return None. |
|
94 */ |
|
95 virtual void Reset() = 0; |
|
96 |
|
97 /** |
|
98 * Get the length in composition field |
|
99 * |
|
100 * @since S60 v3.2 |
|
101 * @return The string length in composition field |
|
102 */ |
|
103 virtual TInt CompositionFieldStringLength() = 0; |
|
104 |
|
105 /** |
|
106 * Get candidates |
|
107 * |
|
108 * @since S60 v3.2 |
|
109 * @param aInputString the input string sent to engine |
|
110 * @param aIsPredictive The flag showing predictive or not |
|
111 * @param aForNextPage Is this for next page candidate |
|
112 * @return The canidates count |
|
113 */ |
|
114 virtual TInt GetCandidatesL(const TDesC& aInputString, |
|
115 const TBool aIsPredictive = 0, |
|
116 TBool aForNextPage = EFalse) = 0; |
|
117 |
|
118 /** |
|
119 * Clear trigger string |
|
120 * |
|
121 * @since S60 v3.2 |
|
122 * @return None |
|
123 */ |
|
124 virtual void ClearTriggerString() = 0; |
|
125 |
|
126 /** |
|
127 * Set current range |
|
128 * |
|
129 * @since S60 v3.2 |
|
130 * @param aRange The range need to set |
|
131 * @param aNeedSave The flag need to save or not |
|
132 * @return None. |
|
133 */ |
|
134 virtual void SetCurrentRange(TInt aRange, TBool aNeedSave = EFalse, |
|
135 TBool aNotify = EFalse) = 0; |
|
136 }; |
|
137 |
|
138 #endif // End of M_AKNFEPVKBLAYOUTCONTEXT_H |
|
139 |
|
140 //End Of File |