|
1 /* |
|
2 * Copyright (c) 2005-2006 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: Inline function for virtual keyboard controls |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 //class CVirtualKeyboard |
|
20 |
|
21 // --------------------------------------------------------------------------- |
|
22 // Set fading parameter |
|
23 // --------------------------------------------------------------------------- |
|
24 // |
|
25 inline void CVirtualKeyboard::SetFadingParameters(TUint8 aBlackMap, |
|
26 TUint8 aWhiteMap) |
|
27 { |
|
28 iFadingParamBlack = aBlackMap; |
|
29 iFadingParamWhite = aWhiteMap; |
|
30 }; |
|
31 |
|
32 // --------------------------------------------------------------------------- |
|
33 // Get key array |
|
34 // --------------------------------------------------------------------------- |
|
35 // |
|
36 inline const RPointerArray<CVirtualKey>& CVirtualKeyboard::KeyArray() |
|
37 { |
|
38 return iKeyArray; |
|
39 } |
|
40 |
|
41 // --------------------------------------------------------------------------- |
|
42 // Get key highlight bitmap array |
|
43 // --------------------------------------------------------------------------- |
|
44 // |
|
45 inline const RPointerArray<CFbsBitmap>& CVirtualKeyboard::KeyHighlightBmpList() |
|
46 { |
|
47 return iKeyHighLightBmpList; |
|
48 } |
|
49 |
|
50 // --------------------------------------------------------------------------- |
|
51 // Get key highlight mask bitmap array |
|
52 // --------------------------------------------------------------------------- |
|
53 // |
|
54 inline const RPointerArray<CFbsBitmap>& CVirtualKeyboard::KeyHighlightMaskBmpList() |
|
55 { |
|
56 return iKeyHighLightMaskBmpList; |
|
57 } |
|
58 |
|
59 // --------------------------------------------------------------------------- |
|
60 // CVirtualKeyboard::SetDimKeyBmp |
|
61 // Set key dim bitmap |
|
62 // (other items were commented in a header). |
|
63 // --------------------------------------------------------------------------- |
|
64 // |
|
65 inline void CVirtualKeyboard::SetDimKeyBmp(CFbsBitmap* aBitmap) |
|
66 { |
|
67 iDimKeyBmp = aBitmap; |
|
68 } |
|
69 |
|
70 // --------------------------------------------------------------------------- |
|
71 // CVirtualKeyboard::SetDimKeyMaskBmp |
|
72 // Set key dim maks bitmap |
|
73 // (other items were commented in a header). |
|
74 // --------------------------------------------------------------------------- |
|
75 // |
|
76 inline void CVirtualKeyboard::SetDimKeyMaskBmp(CFbsBitmap* aBitmap) |
|
77 { |
|
78 iDimKeyMaskBmp = aBitmap; |
|
79 } |
|
80 |
|
81 // --------------------------------------------------------------------------- |
|
82 // CVirtualKeyboard::RemoveKey |
|
83 // Remove a key by index. Index is not checked. |
|
84 // --------------------------------------------------------------------------- |
|
85 // |
|
86 inline void CVirtualKeyboard::RemoveKey(TInt aIndex) |
|
87 { |
|
88 RemoveKey(iKeyArray[aIndex]); |
|
89 } |
|
90 |
|
91 inline void CVirtualKeyboard::SetKeySkinId(TVirtualKeyBmpType aBmpType, |
|
92 TAknsItemID aSkinId) |
|
93 { |
|
94 switch (aBmpType) |
|
95 { |
|
96 case EKeyBmpNormal: |
|
97 { |
|
98 iKeyNormalSkinId = aSkinId; |
|
99 } |
|
100 break; |
|
101 case EKeyBmpHighlight: |
|
102 { |
|
103 iKeyHighlightSkinId = aSkinId; |
|
104 } |
|
105 break; |
|
106 case EKeyBmpDim: |
|
107 { |
|
108 iKeyDimSkinId = aSkinId; |
|
109 } |
|
110 break; |
|
111 default: |
|
112 break; |
|
113 } |
|
114 } |
|
115 |
|
116 inline TAknsItemID CVirtualKeyboard::KeySkinId(TVirtualKeyBmpType aBmpType) |
|
117 { |
|
118 switch (aBmpType) |
|
119 { |
|
120 case EKeyBmpNormal: |
|
121 { |
|
122 return iKeyNormalSkinId; |
|
123 } |
|
124 break; |
|
125 case EKeyBmpHighlight: |
|
126 { |
|
127 return iKeyHighlightSkinId; |
|
128 } |
|
129 break; |
|
130 case EKeyBmpDim: |
|
131 { |
|
132 return iKeyDimSkinId; |
|
133 } |
|
134 break; |
|
135 default: |
|
136 break; |
|
137 } |
|
138 |
|
139 return KAknsIIDNone; |
|
140 } |
|
141 |
|
142 inline void CVirtualKeyboard::SetTextLineLayout(TAknTextLineLayout aTextLine, TVirtualKeyTextPos aPos) |
|
143 { |
|
144 if (aPos >= 0 && aPos <= EPosLast) |
|
145 { |
|
146 iTextLineLayout[aPos] = aTextLine; |
|
147 iTextLineSet[aPos] = ETrue; |
|
148 } |
|
149 } |
|
150 |
|
151 inline TAknTextLineLayout CVirtualKeyboard::TextLineLayout(TVirtualKeyTextPos aPos) |
|
152 { |
|
153 if (aPos >= 0 && aPos <= EPosLast) |
|
154 { |
|
155 return iTextLineLayout[aPos]; |
|
156 } |
|
157 |
|
158 return iTextLineLayout[0]; |
|
159 } |
|
160 |
|
161 inline void CVirtualKeyboard::SetTextLineLayout(TAknTextLineLayout aTextLine) |
|
162 { |
|
163 iVKBTextLineLayout = aTextLine; |
|
164 } |
|
165 |
|
166 inline TAknTextLineLayout CVirtualKeyboard::TextLineLayout() |
|
167 { |
|
168 return iVKBTextLineLayout; |
|
169 } |
|
170 |
|
171 inline TBool CVirtualKeyboard::TextLineLayoutSet(TVirtualKeyTextPos aPos) |
|
172 { |
|
173 if (aPos >= 0 && aPos <= EPosLast) |
|
174 { |
|
175 return iTextLineSet[aPos]; |
|
176 } |
|
177 |
|
178 return EFalse; |
|
179 } |
|
180 |
|
181 inline void CVirtualKeyboard::SetDrawOpaqueBackground(TBool aNeedDraw) |
|
182 { |
|
183 iNeedDrawBackground = aNeedDraw; |
|
184 } |
|
185 |
|
186 inline CPenInputColorIcon* CVirtualKeyboard::ShiftIcon() |
|
187 { |
|
188 return iShiftIcon; |
|
189 } |
|
190 |
|
191 //class CVirtualKey |
|
192 |
|
193 |
|
194 // --------------------------------------------------------------------------- |
|
195 //Return key position |
|
196 // --------------------------------------------------------------------------- |
|
197 // |
|
198 inline const TRect& CVirtualKey::Rect() const |
|
199 { |
|
200 return iRect; |
|
201 } |
|
202 |
|
203 // --------------------------------------------------------------------------- |
|
204 //Return key code |
|
205 // --------------------------------------------------------------------------- |
|
206 // |
|
207 inline TUint CVirtualKey::KeyCode() const |
|
208 { |
|
209 return iCode; |
|
210 } |
|
211 |
|
212 // --------------------------------------------------------------------------- |
|
213 // CVirtualKey::KeyUnicodes |
|
214 //Return key unicodes -- support for multi language |
|
215 // --------------------------------------------------------------------------- |
|
216 inline const TDesC& CVirtualKey::KeyUnicodes() const |
|
217 { |
|
218 return *iCodeData; |
|
219 } |
|
220 |
|
221 |
|
222 // --------------------------------------------------------------------------- |
|
223 //Return key scancode |
|
224 // --------------------------------------------------------------------------- |
|
225 // |
|
226 inline TInt CVirtualKey::ScanCode() const |
|
227 { |
|
228 return iScanCode; |
|
229 } |
|
230 |
|
231 // --------------------------------------------------------------------------- |
|
232 //get highlight bmp index |
|
233 // --------------------------------------------------------------------------- |
|
234 // |
|
235 inline TInt CVirtualKey::HighlightBmpIndex() |
|
236 { |
|
237 return iHighlightBmpIndex; |
|
238 } |
|
239 |
|
240 // --------------------------------------------------------------------------- |
|
241 //get highlight bmp index |
|
242 // --------------------------------------------------------------------------- |
|
243 // |
|
244 inline TInt CVirtualKey::HighlightMaskBmpIndex() |
|
245 { |
|
246 return iHighlightMaskBmpIndex; |
|
247 } |
|
248 |
|
249 // --------------------------------------------------------------------------- |
|
250 // set key dimmed |
|
251 // --------------------------------------------------------------------------- |
|
252 // |
|
253 inline void CVirtualKey::SetDimmed(TBool aFlag) |
|
254 { |
|
255 iDimmed = aFlag; |
|
256 } |
|
257 |
|
258 // --------------------------------------------------------------------------- |
|
259 // set key dimmed |
|
260 // --------------------------------------------------------------------------- |
|
261 // |
|
262 inline TBool CVirtualKey::Dimmed() const |
|
263 { |
|
264 return iDimmed; |
|
265 } |
|
266 |
|
267 // --------------------------------------------------------------------------- |
|
268 // set key to be a latch key |
|
269 // --------------------------------------------------------------------------- |
|
270 // |
|
271 inline void CVirtualKey::SetLatchKey(TBool aFlag) |
|
272 { |
|
273 iIsLatchKey = aFlag; |
|
274 } |
|
275 |
|
276 // --------------------------------------------------------------------------- |
|
277 // get latch latch style flag |
|
278 // --------------------------------------------------------------------------- |
|
279 // |
|
280 inline TBool CVirtualKey::IsLatchKey() |
|
281 { |
|
282 return iIsLatchKey; |
|
283 } |
|
284 |
|
285 // --------------------------------------------------------------------------- |
|
286 // get latch state |
|
287 // --------------------------------------------------------------------------- |
|
288 // |
|
289 inline TBool CVirtualKey::Latched() |
|
290 { |
|
291 return iLatched; |
|
292 } |
|
293 |
|
294 inline void CVirtualKey::SetInnerRect(const TRect& aRect) |
|
295 { |
|
296 innerRect = aRect; |
|
297 } |
|
298 |
|
299 inline TRect CVirtualKey::InnerRect() |
|
300 { |
|
301 return innerRect; |
|
302 } |
|
303 |
|
304 inline void CVirtualKeyboard::SetKeyTextColorGroup(TInt aColorGroup) |
|
305 { |
|
306 iKeyTextColorGroup = aColorGroup; |
|
307 } |
|
308 inline TInt CVirtualKeyboard::KeyTextColorGroup() const |
|
309 { |
|
310 return iKeyTextColorGroup; |
|
311 } |
|
312 |
|
313 inline TDesC* CVirtualKey::DisplayUnicode() const |
|
314 { |
|
315 return iDisplayCodeData; |
|
316 } |
|
317 |
|
318 inline void CVirtualKey::SetKeyData( const TDesC& aKeyData ) |
|
319 { |
|
320 if ( iCodeData ) |
|
321 { |
|
322 delete iCodeData; |
|
323 } |
|
324 iCodeData = aKeyData.AllocL(); |
|
325 } |
|
326 |
|
327 inline void CVirtualKey::SetKeyScancode( TInt aScancode ) |
|
328 { |
|
329 iScanCode = aScancode; |
|
330 } |
|
331 |
|
332 //end of class CVritualKeyboard |