[Inputmethod] Add new APIs to update input panel event (#582)
[platform/core/csapi/tizenfx.git] / src / Tizen.Uix.InputMethod / Tizen.Uix.InputMethod / InputMethodEditor.cs
1 /*
2 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3 *
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17
18 using System;
19 using System.Collections.Generic;
20 using System.Runtime.InteropServices;
21 using System.ComponentModel;
22 using static Interop.InputMethod;
23
24 namespace Tizen.Uix.InputMethod
25 {
26     /// <summary>
27     /// Enumeration for the key codes.
28     /// If keycode &amp; 0xff000000 == 0x01000000 then this key code is directly encoded to 24-bit UCS character. The UCS value is keycode &amp; 0x00ffffff.
29     /// Defines the list of keys supported by the system. Note that certain keys may not be available on all the devices.
30     /// </summary>
31     /// <since_tizen> 4 </since_tizen>
32     public enum KeyCode
33     {
34         /// <summary>
35         /// The Backspace key.
36         /// </summary>
37         BackSpace = 0xFF08,
38         /// <summary>
39         /// The Tab key.
40         /// </summary>
41         Tab = 0xFF09,
42         /// <summary>
43         /// The Linefeed key.
44         /// </summary>
45         Linefeed = 0xFF0A,
46         /// <summary>
47         /// The Clear key.
48         /// </summary>
49         Clear = 0xFF0B,
50         /// <summary>
51         /// The Return key.
52         /// </summary>
53         Return = 0xFF0D,
54         /// <summary>
55         /// The Pause key.
56         /// </summary>
57         Pause = 0xFF13,
58         /// <summary>
59         /// The Scroll lock key.
60         /// </summary>
61         ScrollLock = 0xFF14,
62         /// <summary>
63         /// The System Request key.
64         /// </summary>
65         SysReq = 0xFF15,
66         /// <summary>
67         /// The Escape key.
68         /// </summary>
69         Escape = 0xFF1B,
70         /// <summary>
71         /// The Delete key.
72         /// </summary>
73         Delete = 0xFFFF,
74
75         /* Cursor control & motion */
76         /// <summary>
77         /// The Home key.
78         /// </summary>
79         Home = 0xFF50,
80         /// <summary>
81         /// The Left directional key.
82         /// </summary>
83         Left = 0xFF51,
84         /// <summary>
85         /// The Up directional key.
86         /// </summary>
87         Up = 0xFF52,
88         /// <summary>
89         /// The Right directional key.
90         /// </summary>
91         Right = 0xFF53,
92         /// <summary>
93         /// The Down directional key.
94         /// </summary>
95         Down = 0xFF54,
96         /// <summary>
97         /// The Prior, Previous key.
98         /// </summary>
99         Prior = 0xFF55,
100         /// <summary>
101         /// The Page Up key.
102         /// </summary>
103         Page_Up = 0xFF55,
104         /// <summary>
105         /// The Next key.
106         /// </summary>
107         Next = 0xFF56,
108         /// <summary>
109         /// The Page Down key.
110         /// </summary>
111         Page_Down = 0xFF56,
112         /// <summary>
113         /// The End key.
114         /// </summary>
115         End = 0xFF57,
116         /// <summary>
117         /// The Begin key.
118         /// </summary>
119         Begin = 0xFF58,
120
121         /* Misc Functions */
122         /// <summary>
123         /// The Select key.
124         /// </summary>
125         Select = 0xFF60,
126         /// <summary>
127         /// The Print key.
128         /// </summary>
129         Print = 0xFF61,
130         /// <summary>
131         /// The Execute, Run, Do key.
132         /// </summary>
133         Execute = 0xFF62,
134         /// <summary>
135         /// The Insert key.
136         /// </summary>
137         Insert = 0xFF63,
138         /// <summary>
139         /// The Undo key.
140         /// </summary>
141         Undo = 0xFF65,
142         /// <summary>
143         /// The Redo key.
144         /// </summary>
145         Redo = 0xFF66,
146         /// <summary>
147         /// The Menu key.
148         /// </summary>
149         Menu = 0xFF67,
150         /// <summary>
151         /// The Find key.
152         /// </summary>
153         Find = 0xFF68,
154         /// <summary>
155         /// The Cancel, Stop, Abort, Exit key.
156         /// </summary>
157         Cancel = 0xFF69,
158         /// <summary>
159         /// The Help key.
160         /// </summary>
161         Help = 0xFF6A,
162         /// <summary>
163         /// The Break key.
164         /// </summary>
165         Break = 0xFF6B,
166         /// <summary>
167         /// The character set switch key.
168         /// </summary>
169         Mode_switch = 0xFF7E,
170         /// <summary>
171         /// The Number Lock key.
172         /// </summary>
173         Num_Lock = 0xFF7F,
174
175         /* Keypad */
176         /// <summary>
177         /// The Numpad Space key.
178         /// </summary>
179         KPSpace = 0xFF80,
180         /// <summary>
181         /// The Numpad Tab key.
182         /// </summary>
183         KPTab = 0xFF89,
184         /// <summary>
185         /// The Numpad Enter key.
186         /// </summary>
187         KPEnter = 0xFF8D,
188         /// <summary>
189         /// The Numpad Function 1 key.
190         /// </summary>
191         KPF1 = 0xFF91,
192         /// <summary>
193         /// The Numpad Function 2 key.
194         /// </summary>
195         KPF2 = 0xFF92,
196         /// <summary>
197         /// The Numpad Function 3 key.
198         /// </summary>
199         KPF3 = 0xFF93,
200         /// <summary>
201         /// The Numpad Function 4 key.
202         /// </summary>
203         KPF4 = 0xFF94,
204         /// <summary>
205         /// The Numpad Home key.
206         /// </summary>
207         KPHome = 0xFF95,
208         /// <summary>
209         /// The Numpad Left key.
210         /// </summary>
211         KPLeft = 0xFF96,
212         /// <summary>
213         /// The Numpad Up key.
214         /// </summary>
215         KPUp = 0xFF97,
216         /// <summary>
217         /// The Numpad Right key.
218         /// </summary>
219         KPRight = 0xFF98,
220         /// <summary>
221         /// The Numpad Down key.
222         /// </summary>
223         KPDown = 0xFF99,
224         /// <summary>
225         /// The Numpad Prior, Previous key.
226         /// </summary>
227         KPPrior = 0xFF9A,
228         /// <summary>
229         /// The Numpad Page Up key.
230         /// </summary>
231         KPPage_Up = 0xFF9A,
232         /// <summary>
233         /// The Numpad Next key.
234         /// </summary>
235         KPNext = 0xFF9B,
236         /// <summary>
237         /// The Numpad Page Down key.
238         /// </summary>
239         KPPage_Down = 0xFF9B,
240         /// <summary>
241         /// The Numpad End key.
242         /// </summary>
243         KPEnd = 0xFF9C,
244         /// <summary>
245         /// The Numpad Begin key.
246         /// </summary>
247         KPBegin = 0xFF9D,
248         /// <summary>
249         /// The Numpad Insert key.
250         /// </summary>
251         KPInsert = 0xFF9E,
252         /// <summary>
253         /// The Numpad Delete key.
254         /// </summary>
255         KPDelete = 0xFF9F,
256         /// <summary>
257         /// The Numpad Equal key.
258         /// </summary>
259         KPEqual = 0xFFBD,
260         /// <summary>
261         /// The Numpad Multiply key.
262         /// </summary>
263         KPMultiply = 0xFFAA,
264         /// <summary>
265         /// The Numpad Add key.
266         /// </summary>
267         KPAdd = 0xFFAB,
268         /// <summary>
269         /// The Numpad Separator key.
270         /// </summary>
271         KPSeparator = 0xFFAC,
272         /// <summary>
273         /// The Numpad Subtract key.
274         /// </summary>
275         KPSubtract = 0xFFAD,
276         /// <summary>
277         /// The Numpad Decimal key.
278         /// </summary>
279         KPDecimal = 0xFFAE,
280         /// <summary>
281         /// The Numpad Divide key.
282         /// </summary>
283         KPDivide = 0xFFAF,
284         /// <summary>
285         /// The Numpad 0 key.
286         /// </summary>
287         KP0 = 0xFFB0,
288         /// <summary>
289         /// The Numpad 1 key.
290         /// </summary>
291         KP1 = 0xFFB1,
292         /// <summary>
293         /// The Numpad 2 key.
294         /// </summary>
295         KP2 = 0xFFB2,
296         /// <summary>
297         /// The Numpad 3 key.
298         /// </summary>
299         KP3 = 0xFFB3,
300         /// <summary>
301         /// The Numpad 4 key.
302         /// </summary>
303         KP4 = 0xFFB4,
304         /// <summary>
305         /// The Numpad 5 key.
306         /// </summary>
307         KP5 = 0xFFB5,
308         /// <summary>
309         /// The Numpad 6 key.
310         /// </summary>
311         KP6 = 0xFFB6,
312         /// <summary>
313         /// The Numpad 7 key.
314         /// </summary>
315         KP7 = 0xFFB7,
316         /// <summary>
317         /// The Numpad 8 key.
318         /// </summary>
319         KP8 = 0xFFB8,
320         /// <summary>
321         /// The Numpad 9 key.
322         /// </summary>
323         KP9 = 0xFFB9,
324
325         /* Auxiliary Functions */
326         /// <summary>
327         /// The Function 1 key.
328         /// </summary>
329         F1 = 0xFFBE,
330         /// <summary>
331         /// The Function 2 key.
332         /// </summary>
333         F2 = 0xFFBF,
334         /// <summary>
335         /// The Function 3 key.
336         /// </summary>
337         F3 = 0xFFC0,
338         /// <summary>
339         /// The Function 4 key.
340         /// </summary>
341         F4 = 0xFFC1,
342         /// <summary>
343         /// The Function 5 key.
344         /// </summary>
345         F5 = 0xFFC2,
346         /// <summary>
347         /// The Function 6 key.
348         /// </summary>
349         F6 = 0xFFC3,
350         /// <summary>
351         /// The Function 7 key.
352         /// </summary>
353         F7 = 0xFFC4,
354         /// <summary>
355         /// The Function 8 key.
356         /// </summary>
357         F8 = 0xFFC5,
358         /// <summary>
359         /// The Function 9 key.
360         /// </summary>
361         F9 = 0xFFC6,
362         /// <summary>
363         /// The Function 10 key.
364         /// </summary>
365         F10 = 0xFFC7,
366         /// <summary>
367         /// The Function 11 key.
368         /// </summary>
369         F11 = 0xFFC8,
370         /// <summary>
371         /// The Function 12 key.
372         /// </summary>
373         F12 = 0xFFC9,
374         /// <summary>
375         /// The Function 13 key.
376         /// </summary>
377         F13 = 0xFFCA,
378         /// <summary>
379         /// The Function 14 key.
380         /// </summary>
381         F14 = 0xFFCB,
382         /// <summary>
383         /// The Function 15 key.
384         /// </summary>
385         F15 = 0xFFCC,
386         /// <summary>
387         /// The Function 16 key.
388         /// </summary>
389         F16 = 0xFFCD,
390         /// <summary>
391         /// The Function 17 key.
392         /// </summary>
393         F17 = 0xFFCE,
394         /// <summary>
395         /// The Function 18 key.
396         /// </summary>
397         F18 = 0xFFCF,
398         /// <summary>
399         /// The Function 19 key.
400         /// </summary>
401         F19 = 0xFFD0,
402         /// <summary>
403         /// The Function 20 key.
404         /// </summary>
405         F20 = 0xFFD1,
406         /// <summary>
407         /// The Function 21 key.
408         /// </summary>
409         F21 = 0xFFD2,
410         /// <summary>
411         /// The Function 22 key.
412         /// </summary>
413         F22 = 0xFFD3,
414         /// <summary>
415         /// The Function 23 key.
416         /// </summary>
417         F23 = 0xFFD4,
418         /// <summary>
419         /// The Function 24 key.
420         /// </summary>
421         F24 = 0xFFD5,
422         /// <summary>
423         /// The Function 25 key.
424         /// </summary>
425         F25 = 0xFFD6,
426         /// <summary>
427         /// The Function 26 key.
428         /// </summary>
429         F26 = 0xFFD7,
430         /// <summary>
431         /// The Function 27 key.
432         /// </summary>
433         F27 = 0xFFD8,
434         /// <summary>
435         /// The Function 28 key.
436         /// </summary>
437         F28 = 0xFFD9,
438         /// <summary>
439         /// The Function 29 key.
440         /// </summary>
441         F29 = 0xFFDA,
442         /// <summary>
443         /// The Function 30 key.
444         /// </summary>
445         F30 = 0xFFDB,
446         /// <summary>
447         /// The Function 31 key.
448         /// </summary>
449         F31 = 0xFFDC,
450         /// <summary>
451         /// The Function 32 key.
452         /// </summary>
453         F32 = 0xFFDD,
454         /// <summary>
455         /// The Function 33 key.
456         /// </summary>
457         F33 = 0xFFDE,
458         /// <summary>
459         /// The Function 34 key.
460         /// </summary>
461         F34 = 0xFFDF,
462         /// <summary>
463         /// The Function 35 key.
464         /// </summary>
465         F35 = 0xFFE0,
466
467         /* Modifier keys */
468         /// <summary>
469         /// The Left Shift key.
470         /// </summary>
471         ShiftL = 0xFFE1,
472         /// <summary>
473         /// The Right Shift key.
474         /// </summary>
475         ShiftR = 0xFFE2,
476         /// <summary>
477         /// The Left Control key.
478         /// </summary>
479         ControlL = 0xFFE3,
480         /// <summary>
481         /// The Right Control key.
482         /// </summary>
483         ControlR = 0xFFE4,
484         /// <summary>
485         /// The Caps Lock key.
486         /// </summary>
487         CapsLock = 0xFFE5,
488         /// <summary>
489         /// The Shift Lock key.
490         /// </summary>
491         ShiftLock = 0xFFE6,
492         /// <summary>
493         /// The Left Meta key.
494         /// </summary>
495         MetaL = 0xFFE7,
496         /// <summary>
497         /// The Right Meta key.
498         /// </summary>
499         MetaR = 0xFFE8,
500         /// <summary>
501         /// The Left Alt key.
502         /// </summary>
503         AltL = 0xFFE9,
504         /// <summary>
505         /// The Right Alt key.
506         /// </summary>
507         AltR = 0xFFEA,
508         /// <summary>
509         /// The Left Super key.
510         /// </summary>
511         SuperL = 0xFFEB,
512         /// <summary>
513         /// The Right Super key.
514         /// </summary>
515         SuperR = 0xFFEC,
516         /// <summary>
517         /// The Left Hyper key.
518         /// </summary>
519         HyperL = 0xFFED,
520         /// <summary>
521         /// The Right Hyper key.
522         /// </summary>
523         HyperR = 0xFFEE,
524
525         /* Latin 1 */
526         /// <summary>
527         /// The Space key.
528         /// </summary>
529         Space = 0x020,
530         /// <summary>
531         /// The Exclamation key.
532         /// </summary>
533         Exclam = 0x021,
534         /// <summary>
535         /// The Quotedbl key.
536         /// </summary>
537         Quotedbl = 0x022,
538         /// <summary>
539         /// The Number Sign key.
540         /// </summary>
541         NumberSign = 0x023,
542         /// <summary>
543         /// The Dollar key.
544         /// </summary>
545         Dollar = 0x024,
546         /// <summary>
547         /// The Percent key.
548         /// </summary>
549         Percent = 0x025,
550         /// <summary>
551         /// The Ampersand key.
552         /// </summary>
553         Ampersand = 0x026,
554         /// <summary>
555         /// The Apostrophe key.
556         /// </summary>
557         Apostrophe = 0x027,
558         /// <summary>
559         /// The Parenleft key.
560         /// </summary>
561         Parenleft = 0x028,
562         /// <summary>
563         /// The Parenright key.
564         /// </summary>
565         Parenright = 0x029,
566         /// <summary>
567         /// The Asterisk key.
568         /// </summary>
569         Asterisk = 0x02a,
570         /// <summary>
571         /// The Plus key.
572         /// </summary>
573         Plus = 0x02b,
574         /// <summary>
575         /// The Comma key.
576         /// </summary>
577         Comma = 0x02c,
578         /// <summary>
579         /// The Minus key.
580         /// </summary>
581         Minus = 0x02d,
582         /// <summary>
583         /// The Period key.
584         /// </summary>
585         Period = 0x02e,
586         /// <summary>
587         /// The Slash key.
588         /// </summary>
589         Slash = 0x02f,
590         /// <summary>
591         /// The 0 key.
592         /// </summary>
593         Keypad0 = 0x030,
594         /// <summary>
595         /// The 1 key.
596         /// </summary>
597         Keypad1 = 0x031,
598         /// <summary>
599         /// The 2 key.
600         /// </summary>
601         Keypad2 = 0x032,
602         /// <summary>
603         /// The 3 key.
604         /// </summary>
605         Keypad3 = 0x033,
606         /// <summary>
607         /// The 4 key.
608         /// </summary>
609         Keypad4 = 0x034,
610         /// <summary>
611         /// The 5 key.
612         /// </summary>
613         Keypad5 = 0x035,
614         /// <summary>
615         /// The 6 key.
616         /// </summary>
617         Keypad6 = 0x036,
618         /// <summary>
619         /// The 7 key.
620         /// </summary>
621         Keypad7 = 0x037,
622         /// <summary>
623         /// The 8 key.
624         /// </summary>
625         Keypad8 = 0x038,
626         /// <summary>
627         /// The 9 key.
628         /// </summary>
629         Keypad9 = 0x039,
630         /// <summary>
631         /// The Colon key.
632         /// </summary>
633         Colon = 0x03a,
634         /// <summary>
635         /// The Semicolon key.
636         /// </summary>
637         Semicolon = 0x03b,
638         /// <summary>
639         /// The Less key.
640         /// </summary>
641         Less = 0x03c,
642         /// <summary>
643         /// The Equal key.
644         /// </summary>
645         Equal = 0x03d,
646         /// <summary>
647         /// The Greater key.
648         /// </summary>
649         Greater = 0x03e,
650         /// <summary>
651         /// The Question key.
652         /// </summary>
653         Question = 0x03f,
654         /// <summary>
655         /// The At key.
656         /// </summary>
657         At = 0x040,
658         /// <summary>
659         /// The A key.
660         /// </summary>
661         KeypadA = 0x041,
662         /// <summary>
663         /// The B key.
664         /// </summary>
665         KeypadB = 0x042,
666         /// <summary>
667         /// The C key.
668         /// </summary>
669         KeypadC = 0x043,
670         /// <summary>
671         /// The D key.
672         /// </summary>
673         KeypadD = 0x044,
674         /// <summary>
675         /// The E key.
676         /// </summary>
677         KeypadE = 0x045,
678         /// <summary>
679         /// The F key.
680         /// </summary>
681         KeypadF = 0x046,
682         /// <summary>
683         /// The G key.
684         /// </summary>
685         KeypadG = 0x047,
686         /// <summary>
687         /// The H key.
688         /// </summary>
689         KeypadH = 0x048,
690         /// <summary>
691         /// The I key.
692         /// </summary>
693         KeypadI = 0x049,
694         /// <summary>
695         /// The J key.
696         /// </summary>
697         KeypadJ = 0x04a,
698         /// <summary>
699         /// The K key.
700         /// </summary>
701         KeypadK = 0x04b,
702         /// <summary>
703         /// The L key.
704         /// </summary>
705         KeypadL = 0x04c,
706         /// <summary>
707         /// The M key.
708         /// </summary>
709         KeypadM = 0x04d,
710         /// <summary>
711         /// The N key.
712         /// </summary>
713         KeypadN = 0x04e,
714         /// <summary>
715         /// The O key.
716         /// </summary>
717         KeypadO = 0x04f,
718         /// <summary>
719         /// The P key.
720         /// </summary>
721         KeypadP = 0x050,
722         /// <summary>
723         /// The Q key.
724         /// </summary>
725         KeypadQ = 0x051,
726         /// <summary>
727         /// The R key.
728         /// </summary>
729         KeypadR = 0x052,
730         /// <summary>
731         /// The S key.
732         /// </summary>
733         KeypadS = 0x053,
734         /// <summary>
735         /// The T key.
736         /// </summary>
737         KeypadT = 0x054,
738         /// <summary>
739         /// The U key.
740         /// </summary>
741         KeypadU = 0x055,
742         /// <summary>
743         /// The V key.
744         /// </summary>
745         KeypadV = 0x056,
746         /// <summary>
747         /// The W key.
748         /// </summary>
749         KeypadW = 0x057,
750         /// <summary>
751         /// The X key.
752         /// </summary>
753         KeypadX = 0x058,
754         /// <summary>
755         /// The Y key.
756         /// </summary>
757         KeypadY = 0x059,
758         /// <summary>
759         /// The Z key.
760         /// </summary>
761         KeypadZ = 0x05a,
762         /// <summary>
763         /// The Left Bracket key.
764         /// </summary>
765         BracketLeft = 0x05b,
766         /// <summary>
767         /// The Backslash key.
768         /// </summary>
769         Backslash = 0x05c,
770         /// <summary>
771         /// The Right Bracket key.
772         /// </summary>
773         BracketRight = 0x05d,
774         /// <summary>
775         /// The Circumflex key.
776         /// </summary>
777         AsciiCircum = 0x05e,
778         /// <summary>
779         /// The Underscore key.
780         /// </summary>
781         Underscore = 0x05f,
782         /// <summary>
783         /// The Grave key.
784         /// </summary>
785         Grave = 0x060,
786         /// <summary>
787         /// The a key.
788         /// </summary>
789         Keypada = 0x061,
790         /// <summary>
791         /// The b key.
792         /// </summary>
793         Keypadb = 0x062,
794         /// <summary>
795         /// The c key.
796         /// </summary>
797         Keypadc = 0x063,
798         /// <summary>
799         /// The d key.
800         /// </summary>
801         Keypadd = 0x064,
802         /// <summary>
803         /// The e key.
804         /// </summary>
805         Keypade = 0x065,
806         /// <summary>
807         /// The f key.
808         /// </summary>
809         Keypadf = 0x066,
810         /// <summary>
811         /// The g key.
812         /// </summary>
813         Keypadg = 0x067,
814         /// <summary>
815         /// The h key.
816         /// </summary>
817         Keypadh = 0x068,
818         /// <summary>
819         /// The i key.
820         /// </summary>
821         Keypadi = 0x069,
822         /// <summary>
823         /// The j key.
824         /// </summary>
825         Keypadj = 0x06a,
826         /// <summary>
827         /// The k key.
828         /// </summary>
829         Keypadk = 0x06b,
830         /// <summary>
831         /// The l key.
832         /// </summary>
833         Keypadl = 0x06c,
834         /// <summary>
835         /// The m key.
836         /// </summary>
837         Keypadm = 0x06d,
838         /// <summary>
839         /// The n key.
840         /// </summary>
841         Keypadn = 0x06e,
842         /// <summary>
843         /// The o key.
844         /// </summary>
845         Keypado = 0x06f,
846         /// <summary>
847         /// The p key.
848         /// </summary>
849         Keypadp = 0x070,
850         /// <summary>
851         /// The q key.
852         /// </summary>
853         Keypadq = 0x071,
854         /// <summary>
855         /// The r key.
856         /// </summary>
857         Keypadr = 0x072,
858         /// <summary>
859         /// The s key.
860         /// </summary>
861         Keypads = 0x073,
862         /// <summary>
863         /// The t key.
864         /// </summary>
865         Keypadt = 0x074,
866         /// <summary>
867         /// The u key.
868         /// </summary>
869         Keypadu = 0x075,
870         /// <summary>
871         /// The v key.
872         /// </summary>
873         Keypadv = 0x076,
874         /// <summary>
875         /// The w key.
876         /// </summary>
877         Keypadw = 0x077,
878         /// <summary>
879         /// The x key.
880         /// </summary>
881         Keypadx = 0x078,
882         /// <summary>
883         /// The y key.
884         /// </summary>
885         Keypady = 0x079,
886         /// <summary>
887         /// The z key.
888         /// </summary>
889         Keypadz = 0x07a,
890         /// <summary>
891         /// The Left Brace key.
892         /// </summary>
893         BraceLeft = 0x07b,
894         /// <summary>
895         /// The Bar key.
896         /// </summary>
897         Bar = 0x07c,
898         /// <summary>
899         /// The Right Brace key.
900         /// </summary>
901         BraceRight = 0x07d,
902         /// <summary>
903         /// The Tilde key.
904         /// </summary>
905         AsciiTilde = 0x07e,
906     };
907
908     /// <summary>
909     /// Enumeration for the key masks.
910     /// The key masks indicate which modifier keys are pressed down during the keyboard hit. The special MASK_RELEASED indicates the key release event.
911     /// </summary>
912     /// <since_tizen> 4 </since_tizen>
913     public enum KeyMask
914     {
915         /// <summary>
916         /// Key press event without the modifier key.
917         /// </summary>
918         Pressed = 0,
919         /// <summary>
920         /// The Shift key is pressed down.
921         /// </summary>
922         Shift = (1 << 0),
923         /// <summary>
924         /// The CapsLock key is pressed down.
925         /// </summary>
926         CapsLock = (1 << 1),
927         /// <summary>
928         /// The Control key is pressed down.
929         /// </summary>
930         Control = (1 << 2),
931         /// <summary>
932         /// The Alt key is pressed down.
933         /// </summary>
934         Alt = (1 << 3),
935         /// <summary>
936         /// The Meta key is pressed down.
937         /// </summary>
938         Meta = (1 << 4),
939         /// <summary>
940         /// The Win key (between Control and Alt) is pressed down.
941         /// </summary>
942         Win = (1 << 5),
943         /// <summary>
944         /// The Hyper key is pressed down.
945         /// </summary>
946         Hyper = (1 << 6),
947         /// <summary>
948         /// The NumLock key is pressed down.
949         /// </summary>
950         NumLock = (1 << 7),
951         /// <summary>
952         /// Key release event.
953         /// </summary>
954         Released = (1 << 15),
955     }
956
957     /// <summary>
958     /// This class contains the API's related to the IME (Input method editor).
959     /// </summary>
960     /// <since_tizen> 4 </since_tizen>
961     public static class InputMethodEditor
962     {
963         private static Object thisLock = new Object();
964         private static ImeCallbackStructGCHandle _imeCallbackStructGCHandle = new ImeCallbackStructGCHandle();
965         private static event EventHandler<FocusedInEventArgs> _focusIn;
966         private static ImeFocusedInCb _imeFocusedInDelegate;
967         private static event EventHandler<FocusedOutEventArgs> _focusOut;
968         private static ImeFocusedOutCb _imeFocusedOutDelegate;
969         private static event EventHandler<SurroundingTextUpdatedEventArgs> _surroundingTextUpdated;
970         private static ImeSurroundingTextUpdatedCb _imeSurroundingTextUpdatedDelegate;
971         private static event EventHandler<EventArgs> _inputContextReset;
972         private static ImeInputContextResetCb _imeInputContextResetDelegate;
973         private static event EventHandler<CursorPositionUpdatedEventArgs> _cursorPositionUpdated;
974         private static ImeCursorPositionUpdatedCb _imeCursorPositionUpdatedDelegate;
975         private static event EventHandler<LanguageSetEventArgs> _langaugeSet;
976         private static ImeLanguageSetCb _imeLanguageSetDelegate;
977         private static event EventHandler<SetDataEventArgs> _imDataSet;
978         private static ImeImdataSetCb _imeDataSetDelegate;
979         private static event EventHandler<LayoutSetEventArgs> _layoutSet;
980         private static ImeLayoutSetCb _imeLayoutSetDelegate;
981         private static event EventHandler<ReturnKeySetEventArgs> _returnKeyTypeSet;
982         private static ImeReturnKeySetCb _imeReturnKeySetDelegate;
983         private static event EventHandler<ReturnKeyStateSetEventArgs> _returnKeyStateSet;
984         private static ImeReturnKeyStateSetCb _imeReturnKeyStateSetDelegate;
985         private static ImeProcessKeyEventCb _imeProcessKeyDelegate;
986         private static event EventHandler<DisplayLanguageChangedEventArgs> _displayLanguageChanged;
987         private static ImeDisplayLanguageChangedCb _imeDisplayLanguageChangedDelegate;
988         private static event EventHandler<RotationChangedEventArgs> _rotationDegreeChanged;
989         private static ImeRotationChangedCb _imeRotationChangedDelegate;
990         private static event EventHandler<AccessibilityStateChangedEventArgs> _accessibilityStateChanged;
991         private static ImeAccessibilityStateChangedCb _imeAccessibilityStateChangedDelegate;
992         private static ImeLanguageRequestedCb _imeLanguageRequestedDelegate;
993         private static OutAction<string> _languageRequestedDelegate;
994         private static BoolAction<KeyCode, KeyMask, InputMethodDeviceInformation> _processKeyDelagate;
995         private static ImeImdataRequestedCb _imeImDataRequestedDelegate;
996         private static OutArrayAction<byte> _imDataRequestedDelegate;
997         private static ImeGeometryRequestedCb _imeGeometryRequestedDelegate;
998         private static OutAction<Rect> _geometryRequestedDelegate;
999         private static Action _userCreate;
1000         private static Action _userTerminate;
1001         private static Action<ContextId, InputMethodContext> _userShow;
1002         private static Action<ContextId> _userHide;
1003         private static ImeCreateCb _create = (IntPtr userData) =>
1004         {
1005             Log.Info(LogTag, "In Create Delegate");
1006             _userCreate?.Invoke();
1007         };
1008         private static ImeTerminateCb _terminate = (IntPtr userData) =>
1009         {
1010             Log.Info(LogTag, "In terminate Delegate");
1011             _userTerminate?.Invoke();
1012             _imeCallbackStructGCHandle.Dispose();
1013         };
1014         private static ImeShowCb _show = (int contextId, IntPtr context, IntPtr userData) =>
1015         {
1016             Log.Info(LogTag, "In Show Delegate");
1017             _userShow?.Invoke(new ContextId(contextId), new InputMethodContext(context));
1018         };
1019         private static ImeHideCb _hide = (int contextId, IntPtr userData) =>
1020         {
1021             Log.Info(LogTag, "In Hide Delegate");
1022             _userHide?.Invoke(new ContextId(contextId));
1023         };
1024
1025         /// <summary>
1026         /// Structure representing the ContextId.
1027         /// </summary>
1028         /// <since_tizen> 4 </since_tizen>
1029         public struct ContextId : IEquatable<ContextId>
1030         {
1031             internal ContextId(int id)
1032             {
1033                 Id = id;
1034             }
1035
1036             internal int Id
1037             {
1038                 get;
1039                 private set;
1040             }
1041
1042             /// <summary>
1043             /// Compares whether the ContextIds are equal.
1044             /// </summary>
1045             /// <param name="other">The ContextIds to test for equality.</param>
1046             /// <returns>true if the ContextIds is the same; otherwise, false.</returns>
1047             /// <since_tizen> 4 </since_tizen>
1048             public bool Equals(ContextId other)
1049             {
1050                 return this.Id == other.Id;
1051             }
1052         }
1053
1054         /// <summary>
1055         /// Rectangle representing the position and size of the UI control.
1056         /// </summary>
1057         /// <since_tizen> 4 </since_tizen>
1058         public struct Rect
1059         {
1060             /// <summary>
1061             /// The X position in the screen.
1062             /// </summary>
1063             /// <since_tizen> 4 </since_tizen>
1064             public int x;
1065
1066             /// <summary>
1067             /// The Y position in the screen.
1068             /// </summary>
1069             /// <since_tizen> 4 </since_tizen>
1070             public int y;
1071
1072             /// <summary>
1073             /// The window width.
1074             /// </summary>
1075             /// <since_tizen> 4 </since_tizen>
1076             public int w;
1077
1078             /// <summary>
1079             /// The window height.
1080             /// </summary>
1081             /// <since_tizen> 4 </since_tizen>
1082             public int h;
1083         }
1084
1085         /// <summary>
1086         /// An action with 1 out parameter.
1087         /// </summary>
1088         /// <typeparam name="T">Generic Type.</typeparam>
1089         /// <param name="a">The out parameter.</param>
1090         /// <since_tizen> 4 </since_tizen>
1091         public delegate void OutAction<T>(out T a);
1092
1093         /// <summary>
1094         /// An action with an array out parameter.
1095         /// </summary>
1096         /// <typeparam name="T">Generic Type.</typeparam>
1097         /// <param name="a">The out parameter 1.</param>
1098         /// <since_tizen> 4 </since_tizen>
1099         public delegate void OutArrayAction<T>(out T[] a);
1100
1101         /// <summary>
1102         /// An action with 3 input parameters returning a bool.
1103         /// </summary>
1104         /// <typeparam name="T">Generic type for parameter 1.</typeparam>
1105         /// <typeparam name="T1">Generic type for parameter 2.</typeparam>
1106         /// <typeparam name="T2">Generic type for parameter 3.</typeparam>
1107         /// <param name="a">The input parameter 1.</param>
1108         /// <param name="b">The input parameter 2.</param>
1109         /// <param name="c">The input parameter 3.</param>
1110         /// <returns></returns>
1111         /// <since_tizen> 4 </since_tizen>
1112         public delegate bool BoolAction<T, T1, T2>(T a, T1 b, T2 c);
1113
1114         /// <summary>
1115         /// Called when an associated text input UI control has focus.
1116         /// </summary>
1117         /// <since_tizen> 4 </since_tizen>
1118         public static event EventHandler<FocusedInEventArgs> FocusedIn
1119         {
1120             add
1121             {
1122                 lock (thisLock)
1123                 {
1124                     _imeFocusedInDelegate = (int contextId, IntPtr userData) =>
1125                     {
1126                         FocusedInEventArgs args = new FocusedInEventArgs(contextId);
1127                         _focusIn?.Invoke(null, args);
1128                     };
1129                     ErrorCode error = ImeEventSetFocusedInCb(_imeFocusedInDelegate, IntPtr.Zero);
1130                     if (error != ErrorCode.None)
1131                     {
1132                         Log.Error(LogTag, "Add FocusedIn Failed with error " + error);
1133                     }
1134                     else
1135                     {
1136                         _focusIn += value;
1137                     }
1138                 }
1139             }
1140             remove
1141             {
1142                 lock (thisLock)
1143                 {
1144                     _focusIn -= value;
1145                 }
1146             }
1147         }
1148
1149         /// <summary>
1150         /// Called when an associated text input UI control loses focus.
1151         /// </summary>
1152         /// <since_tizen> 4 </since_tizen>
1153         public static event EventHandler<FocusedOutEventArgs> FocusedOut
1154         {
1155             add
1156             {
1157                 lock (thisLock)
1158                 {
1159                     _imeFocusedOutDelegate = (int contextId, IntPtr userData) =>
1160                     {
1161                         FocusedOutEventArgs args = new FocusedOutEventArgs(contextId);
1162                         _focusOut?.Invoke(null, args);
1163                     };
1164                     ErrorCode error = ImeEventSetFocusedOutCb(_imeFocusedOutDelegate, IntPtr.Zero);
1165                     if (error != ErrorCode.None)
1166                     {
1167                         Log.Error(LogTag, "Add FocusedOut Failed with error " + error);
1168                     }
1169                     else
1170                     {
1171                         _focusOut += value;
1172                     }
1173                 }
1174             }
1175             remove
1176             {
1177                 lock (thisLock)
1178                 {
1179                     _focusOut -= value;
1180                 }
1181             }
1182         }
1183
1184         /// <summary>
1185         /// Called when an associated text input UI control responds to a request with the surrounding text.
1186         /// </summary>
1187         /// <since_tizen> 4 </since_tizen>
1188         public static event EventHandler<SurroundingTextUpdatedEventArgs> SurroundingTextUpdated
1189         {
1190             add
1191             {
1192                 lock (thisLock)
1193                 {
1194                     _imeSurroundingTextUpdatedDelegate = (int contextId, IntPtr text, int cursorPos, IntPtr userData) =>
1195                     {
1196                         SurroundingTextUpdatedEventArgs args = new SurroundingTextUpdatedEventArgs(contextId, Marshal.PtrToStringAnsi(text), cursorPos);
1197                         _surroundingTextUpdated?.Invoke(null, args);
1198                     };
1199                     ErrorCode error = ImeEventSetSurroundingTextUpdatedCb(_imeSurroundingTextUpdatedDelegate, IntPtr.Zero);
1200                     if (error != ErrorCode.None)
1201                     {
1202                         Log.Error(LogTag, "Add SurroundingTextUpdated Failed with error " + error);
1203                     }
1204                     else
1205                     {
1206                         _surroundingTextUpdated += value;
1207                     }
1208                 }
1209             }
1210             remove
1211             {
1212                 lock (thisLock)
1213                 {
1214                     _surroundingTextUpdated -= value;
1215                 }
1216             }
1217         }
1218
1219         /// <summary>
1220         /// Called to reset the input context of an associated text input UI control.
1221         /// </summary>
1222         /// <since_tizen> 4 </since_tizen>
1223         public static event EventHandler<EventArgs> InputContextReset
1224         {
1225             add
1226             {
1227                 lock (thisLock)
1228                 {
1229                     _imeInputContextResetDelegate = (IntPtr userData) =>
1230                     {
1231                         _inputContextReset?.Invoke(null, EventArgs.Empty);
1232                     };
1233                     ErrorCode error = ImeEventSetInputContextResetCb(_imeInputContextResetDelegate, IntPtr.Zero);
1234                     if (error != ErrorCode.None)
1235                     {
1236                         Log.Error(LogTag, "Add InputContextReset Failed with error " + error);
1237                     }
1238                     else
1239                     {
1240                         _inputContextReset += value;
1241                     }
1242                 }
1243             }
1244             remove
1245             {
1246                 lock (thisLock)
1247                 {
1248                     _inputContextReset -= value;
1249                 }
1250             }
1251         }
1252
1253         /// <summary>
1254         /// Called when the position of the cursor in an associated text input UI control changes.
1255         /// </summary>
1256         /// <since_tizen> 4 </since_tizen>
1257         public static event EventHandler<CursorPositionUpdatedEventArgs> CursorPositionUpdated
1258         {
1259             add
1260             {
1261                 lock (thisLock)
1262                 {
1263                     _imeCursorPositionUpdatedDelegate = (int cursorPos, IntPtr userData) =>
1264                     {
1265                         CursorPositionUpdatedEventArgs args = new CursorPositionUpdatedEventArgs(cursorPos);
1266                         _cursorPositionUpdated?.Invoke(null, args);
1267                     };
1268                     ErrorCode error = ImeEventSetCursorPositionUpdatedCb(_imeCursorPositionUpdatedDelegate, IntPtr.Zero);
1269                     if (error != ErrorCode.None)
1270                     {
1271                         Log.Error(LogTag, "Add CursorPositionUpdated Failed with error " + error);
1272                     }
1273                     else
1274                     {
1275                         _cursorPositionUpdated += value;
1276                     }
1277                 }
1278             }
1279             remove
1280             {
1281                 lock (thisLock)
1282                 {
1283                     _cursorPositionUpdated -= value;
1284                 }
1285             }
1286         }
1287
1288         /// <summary>
1289         /// Called to set the preferred language to the input panel.
1290         /// It will only be called when the client application changes the edit field's language attribute after the input panel is shown.
1291         /// </summary>
1292         /// <since_tizen> 4 </since_tizen>
1293         public static event EventHandler<LanguageSetEventArgs> LanguageSet
1294         {
1295             add
1296             {
1297                 lock (thisLock)
1298                 {
1299                     _imeLanguageSetDelegate = (InputPanelLanguage language, IntPtr userData) =>
1300                     {
1301                         LanguageSetEventArgs args = new LanguageSetEventArgs(language);
1302                         _langaugeSet?.Invoke(null, args);
1303                     };
1304                     ErrorCode error = ImeEventSetLanguageSetCb(_imeLanguageSetDelegate, IntPtr.Zero);
1305                     if (error != ErrorCode.None)
1306                     {
1307                         Log.Error(LogTag, "Add LanguageSet Failed with error " + error);
1308                     }
1309                     else
1310                     {
1311                         _langaugeSet += value;
1312                     }
1313                 }
1314             }
1315             remove
1316             {
1317                 lock (thisLock)
1318                 {
1319                     _langaugeSet -= value;
1320                 }
1321             }
1322         }
1323
1324         /// <summary>
1325         /// Called to set the application specific data to deliver to the input panel.
1326         /// </summary>
1327         /// <since_tizen> 4 </since_tizen>
1328         public static event EventHandler<SetDataEventArgs> DataSet
1329         {
1330             add
1331             {
1332                 lock (thisLock)
1333                 {
1334                     _imeDataSetDelegate = (IntPtr data, uint dataLength, IntPtr userData) =>
1335                     {
1336                         byte[] destination = new byte[dataLength];
1337                         Marshal.Copy(data, destination, 0, (int)dataLength);
1338                         SetDataEventArgs args = new SetDataEventArgs(destination, dataLength);
1339                         _imDataSet?.Invoke(null, args);
1340                     };
1341                     ErrorCode error = ImeEventSetImdataSetCb(_imeDataSetDelegate, IntPtr.Zero);
1342                     if (error != ErrorCode.None)
1343                     {
1344                         Log.Error(LogTag, "Add DataSet Failed with error " + error);
1345                     }
1346                     else
1347                     {
1348                         _imDataSet += value;
1349                     }
1350                 }
1351             }
1352             remove
1353             {
1354                 lock (thisLock)
1355                 {
1356                     _imDataSet -= value;
1357                 }
1358             }
1359         }
1360
1361         /// <summary>
1362         /// Called when an associated text input UI control requests the input panel to set its layout.
1363         /// It will only be called when the client application changes the edit field's layout attribute after the input panel is shown.
1364         /// </summary>
1365         /// <since_tizen> 4 </since_tizen>
1366         public static event EventHandler<LayoutSetEventArgs> LayoutSet
1367         {
1368             add
1369             {
1370                 lock (thisLock)
1371                 {
1372                     _imeLayoutSetDelegate = (InputPanelLayout layout, IntPtr userData) =>
1373                     {
1374                         LayoutSetEventArgs args = new LayoutSetEventArgs(layout);
1375                         _layoutSet?.Invoke(null, args);
1376                     };
1377                     ErrorCode error = ImeEventSetLayoutSetCb(_imeLayoutSetDelegate, IntPtr.Zero);
1378                     if (error != ErrorCode.None)
1379                     {
1380                         Log.Error(LogTag, "Add LayoutSet Failed with error " + error);
1381                     }
1382                     else
1383                     {
1384                         _layoutSet += value;
1385                     }
1386                 }
1387             }
1388             remove
1389             {
1390                 lock (thisLock)
1391                 {
1392                     _layoutSet -= value;
1393                 }
1394             }
1395         }
1396
1397         /// <summary>
1398         /// Called when an associated text input UI control requests the input panel to set the Return key label.
1399         /// The input panel can show the text or an image on the Return button, according to the Return key action.
1400         /// </summary>
1401         /// <since_tizen> 4 </since_tizen>
1402         public static event EventHandler<ReturnKeySetEventArgs> ReturnKeySet
1403         {
1404             add
1405             {
1406                 lock (thisLock)
1407                 {
1408                     _imeReturnKeySetDelegate = (InputPanelReturnKey type, IntPtr userData) =>
1409                     {
1410                         ReturnKeySetEventArgs args = new ReturnKeySetEventArgs(type);
1411                         _returnKeyTypeSet?.Invoke(null, args);
1412                     };
1413                     ErrorCode error = ImeEventSetReturnKeySetCb(_imeReturnKeySetDelegate, IntPtr.Zero);
1414                     if (error != ErrorCode.None)
1415                     {
1416                         Log.Error(LogTag, "Add ReturnKeySet Failed with error " + error);
1417                     }
1418                     else
1419                     {
1420                         _returnKeyTypeSet += value;
1421                     }
1422                 }
1423             }
1424             remove
1425             {
1426                 lock (thisLock)
1427                 {
1428                     _returnKeyTypeSet -= value;
1429                 }
1430             }
1431         }
1432
1433         /// <summary>
1434         /// Called when an associated text input UI control requests the input panel to enable or disable the Return key state.
1435         /// </summary>
1436         /// <since_tizen> 4 </since_tizen>
1437         public static event EventHandler<ReturnKeyStateSetEventArgs> ReturnKeyStateSet
1438         {
1439             add
1440             {
1441                 lock (thisLock)
1442                 {
1443                     _imeReturnKeyStateSetDelegate = (bool state, IntPtr userData) =>
1444                     {
1445                         ReturnKeyStateSetEventArgs args = new ReturnKeyStateSetEventArgs(state);
1446                         _returnKeyStateSet?.Invoke(null, args);
1447                     };
1448                     ErrorCode error = ImeEventSetReturnKeyStateSetCb(_imeReturnKeyStateSetDelegate, IntPtr.Zero);
1449                     if (error != ErrorCode.None)
1450                     {
1451                         Log.Error(LogTag, "Add ReturnKeyStateSet Failed with error " + error);
1452                     }
1453                     else
1454                     {
1455                         _returnKeyStateSet += value;
1456                     }
1457                 }
1458             }
1459             remove
1460             {
1461                 lock (thisLock)
1462                 {
1463                     _returnKeyStateSet -= value;
1464                 }
1465             }
1466         }
1467
1468         /// <summary>
1469         /// Called when the system display language is changed.
1470         /// </summary>
1471         /// <since_tizen> 4 </since_tizen>
1472         public static event EventHandler<DisplayLanguageChangedEventArgs> DisplayLanguageChanged
1473         {
1474             add
1475             {
1476                 lock (thisLock)
1477                 {
1478                     _imeDisplayLanguageChangedDelegate = (IntPtr language, IntPtr userData) =>
1479                     {
1480                         DisplayLanguageChangedEventArgs args = new DisplayLanguageChangedEventArgs(Marshal.PtrToStringAnsi(language));
1481                         _displayLanguageChanged?.Invoke(null, args);
1482                     };
1483                     ErrorCode error = ImeEventSetDisplayLanguageChangedCb(_imeDisplayLanguageChangedDelegate, IntPtr.Zero);
1484                     if (error != ErrorCode.None)
1485                     {
1486                         Log.Error(LogTag, "Add DisplayLanguageChanged Failed with error " + error);
1487                     }
1488                     else
1489                     {
1490                         _displayLanguageChanged += value;
1491                     }
1492                 }
1493             }
1494             remove
1495             {
1496                 lock (thisLock)
1497                 {
1498                     _displayLanguageChanged -= value;
1499                 }
1500             }
1501         }
1502
1503         /// <summary>
1504         /// Called when the device is rotated.
1505         /// </summary>
1506         /// <since_tizen> 4 </since_tizen>
1507         public static event EventHandler<RotationChangedEventArgs> RotationChanged
1508         {
1509             add
1510             {
1511                 lock (thisLock)
1512                 {
1513                     _imeRotationChangedDelegate = (int degree, IntPtr userData) =>
1514                     {
1515                         RotationChangedEventArgs args = new RotationChangedEventArgs(degree);
1516                         _rotationDegreeChanged?.Invoke(null, args);
1517                     };
1518                     ErrorCode error = ImeEventSetRotationChangedCb(_imeRotationChangedDelegate, IntPtr.Zero);
1519                     if (error != ErrorCode.None)
1520                     {
1521                         Log.Error(LogTag, "Add RotationChanged Failed with error " + error);
1522                     }
1523                     else
1524                     {
1525                         _rotationDegreeChanged += value;
1526                     }
1527                 }
1528             }
1529             remove
1530             {
1531                 lock (thisLock)
1532                 {
1533                     _rotationDegreeChanged -= value;
1534                 }
1535             }
1536         }
1537
1538         /// <summary>
1539         /// Called when Accessibility in settings application is on or off.
1540         /// </summary>
1541         /// <since_tizen> 4 </since_tizen>
1542         public static event EventHandler<AccessibilityStateChangedEventArgs> AccessibilityStateChanged
1543         {
1544             add
1545             {
1546                 lock (thisLock)
1547                 {
1548                     _imeAccessibilityStateChangedDelegate = (bool state, IntPtr userData) =>
1549                     {
1550                         AccessibilityStateChangedEventArgs args = new AccessibilityStateChangedEventArgs(state);
1551                         _accessibilityStateChanged?.Invoke(null, args);
1552                     };
1553                     ErrorCode error = ImeEventSetAccessibilityStateChangedCb(_imeAccessibilityStateChangedDelegate, IntPtr.Zero);
1554                     if (error != ErrorCode.None)
1555                     {
1556                         Log.Error(LogTag, "Add AccessibilityStateChanged Failed with error " + error);
1557                     }
1558                     else
1559                     {
1560                         _accessibilityStateChanged += value;
1561                     }
1562                 }
1563             }
1564             remove
1565             {
1566                 lock (thisLock)
1567                 {
1568                     _accessibilityStateChanged -= value;
1569                 }
1570             }
1571         }
1572
1573         /// <summary>
1574         /// Sets the languageRequested action.
1575         /// </summary>
1576         /// <param name="languageRequested">
1577         /// Called when an associated text input UI control requests the language from the input panel, requesting for language code.
1578         /// </param>
1579         /// <since_tizen> 4 </since_tizen>
1580         public static void SetLanguageRequestedCallback(OutAction<string> languageRequested)
1581         {
1582             _imeLanguageRequestedDelegate = (IntPtr userData, out IntPtr langCode) =>
1583             {
1584                 string langauage;
1585                 _languageRequestedDelegate(out langauage);
1586                 char[] languageArray = langauage.ToCharArray();
1587                 langCode = new IntPtr();
1588                 Marshal.Copy(languageArray, 0, langCode, languageArray.Length);
1589             };
1590             ErrorCode error = ImeEventSetLanguageRequestedCallbackCb(_imeLanguageRequestedDelegate, IntPtr.Zero);
1591             if (error != ErrorCode.None)
1592             {
1593                 Log.Error(LogTag, "Add SetLanguageRequestedCallback Failed with error " + error);
1594             }
1595             _languageRequestedDelegate = languageRequested;
1596         }
1597
1598         /// <summary>
1599         /// Sets the processKey action.
1600         /// If the key event is from the external device, DeviceInfo will have its name, class, and subclass information.
1601         /// </summary>
1602         /// <param name="processKey">
1603         /// The action is called when the key event is received from the external devices or the SendKey function.
1604         /// This Event processes the key event before an associated text input UI control does.
1605         /// </param>
1606         /// <since_tizen> 4 </since_tizen>
1607         public static void SetProcessKeyCallback(BoolAction<KeyCode, KeyMask, InputMethodDeviceInformation> processKey)
1608         {
1609             _imeProcessKeyDelegate = (KeyCode keyCode, KeyMask keyMask, IntPtr devInfo, IntPtr userData) =>
1610             {
1611                 return _processKeyDelagate(keyCode, keyMask, new InputMethodDeviceInformation(devInfo));
1612             };
1613             ErrorCode error = ImeEventSetProcessKeyEventCb(_imeProcessKeyDelegate, IntPtr.Zero);
1614             if (error != ErrorCode.None)
1615             {
1616                 Log.Error(LogTag, "Add ProcessKey Failed with error " + error);
1617             }
1618             _processKeyDelagate = processKey;
1619         }
1620
1621         /// <summary>
1622         /// Sets the imDataRequested action.
1623         /// </summary>
1624         /// <param name="imDataRequested">
1625         /// Called when an associated text input UI control requests the application specific data from the input panel, requesting for data array and it's length.
1626         /// </param>
1627         /// <since_tizen> 4 </since_tizen>
1628         public static void SetDataRequestedCallback(OutArrayAction<byte> imDataRequested)
1629         {
1630             _imeImDataRequestedDelegate = (IntPtr userData, out IntPtr data, out uint dataLength) =>
1631             {
1632                 byte[] dataArr;
1633                 _imDataRequestedDelegate(out dataArr);
1634                 data = new IntPtr();
1635                 Marshal.Copy(dataArr, 0, data, dataArr.Length);
1636                 dataLength = (uint)dataArr.Length;
1637             };
1638             ErrorCode error = ImeEventSetImdataRequestedCb(_imeImDataRequestedDelegate, IntPtr.Zero);
1639             if (error != ErrorCode.None)
1640             {
1641                 Log.Error(LogTag, "Add SetDataRequestedCallback Failed with error " + error);
1642             }
1643             _imDataRequestedDelegate = imDataRequested;
1644         }
1645
1646         /// <summary>
1647         /// Sets the GeometryRequested action.
1648         /// </summary>
1649         /// <param name="geometryRequested">
1650         /// Called when an associated text input UI control requests the position and size from the input panel, requesting for x, y, w, h values.
1651         /// </param>
1652         /// <since_tizen> 4 </since_tizen>
1653         public static void SetGeometryRequestedCallback(OutAction<Rect> geometryRequested)
1654         {
1655             _imeGeometryRequestedDelegate = (IntPtr userData, out int x, out int y, out int w, out int h) =>
1656             {
1657                 Rect rect = new Rect();
1658                 _geometryRequestedDelegate(out rect);
1659                 x = rect.x;
1660                 y = rect.y;
1661                 w = rect.w;
1662                 h = rect.h;
1663             };
1664             ErrorCode error = ImeEventSetGeometryRequestedCallbackCb(_imeGeometryRequestedDelegate, IntPtr.Zero);
1665             if (error != ErrorCode.None)
1666             {
1667                 Log.Error(LogTag, "Add SetGeometryRequestedCallback Failed with error " + error);
1668             }
1669             _geometryRequestedDelegate = geometryRequested;
1670         }
1671
1672         /// <summary>
1673         /// Runs the main loop of the IME application.
1674         /// This function starts to run the IME application's main loop.
1675         /// </summary>
1676         /// <privilege>
1677         /// http://tizen.org/privilege/ime
1678         /// </privilege>
1679         /// <remarks>
1680         /// This API is a blocking call, as it starts the main loop of the application.
1681         /// </remarks>
1682         /// <param name="create">This is called to initialize the IME application before the main loop starts up.</param>
1683         /// <param name="terminate">This is called when the IME application is terminated.</param>
1684         /// <param name="show">
1685         /// This is called when the IME application is shown.
1686         /// It provides the context information and the context ID.
1687         /// </param>
1688         /// <param name="hide">
1689         /// This is called when the IME application is hidden.
1690         /// It provides the context ID.
1691         /// </param>
1692         /// <exception cref="InvalidOperationException">
1693         /// This can occur due to the following reasons:
1694         /// 1) The application does not have the privilege to call this function.
1695         /// 2) Operation failed.
1696         /// </exception>
1697         /// <since_tizen> 4 </since_tizen>
1698         public static void Run(Action create, Action terminate, Action<ContextId, InputMethodContext> show, Action<ContextId> hide)
1699         {
1700             _userCreate = create;
1701             _userTerminate = terminate;
1702             _userShow = show;
1703             _userHide = hide;
1704             _imeCallbackStructGCHandle._imeCallbackStruct.create = _create;
1705             _imeCallbackStructGCHandle._imeCallbackStruct.terminate = _terminate;
1706             _imeCallbackStructGCHandle._imeCallbackStruct.hide = _hide;
1707             _imeCallbackStructGCHandle._imeCallbackStruct.show = _show;
1708
1709             ImeSetDotnetFlag(true);
1710             ErrorCode error = ImeRun(ref _imeCallbackStructGCHandle._imeCallbackStruct, IntPtr.Zero);
1711             if (error != ErrorCode.None)
1712             {
1713                 Log.Error(LogTag, "Run Failed with error " + error);
1714                 throw InputMethodExceptionFactory.CreateException(error);
1715             }
1716
1717         }
1718
1719         /// <summary>
1720         /// Sends a key event to the associated text input UI control.
1721         /// </summary>
1722         /// <remarks>
1723         /// This function sends a key down or up event with the key mask to the client application. If forwardKey is true, this key event goes to the edit filed directly.
1724         /// And if forwardKey is false, the ProcessKey event receives the key event before the edit field.
1725         /// </remarks>
1726         /// <privilege>
1727         /// http://tizen.org/privilege/ime
1728         /// </privilege>
1729         /// <param name="keyCode">The key code to be sent.</param>
1730         /// <param name="keyMask">The modifier key mask.</param>
1731         /// <param name="forwardKey">The flag to send the key event directly to the edit field.</param>
1732         /// <exception cref="InvalidOperationException">
1733         /// This can occur due to the following reasons:
1734         /// 1) The application does not have the privilege to call this function.
1735         /// 2) The IME main loop isn't started yet.
1736         /// </exception>
1737         /// <since_tizen> 4 </since_tizen>
1738         public static void SendKeyEvent(KeyCode keyCode, KeyMask keyMask, bool forwardKey = false)
1739         {
1740             ErrorCode error = ImeSendKeyEvent(keyCode, keyMask, forwardKey);
1741             if (error != ErrorCode.None)
1742             {
1743                 Log.Error(LogTag, "SendEvent Failed with error " + error);
1744                 throw InputMethodExceptionFactory.CreateException(error);
1745             }
1746         }
1747
1748         /// <summary>
1749         /// Sends the text to the associated text input UI control.
1750         /// </summary>
1751         /// <privilege>
1752         /// http://tizen.org/privilege/ime
1753         /// </privilege>
1754         /// <param name="str">The string to be committed.</param>
1755         /// <exception cref="InvalidOperationException">
1756         /// This can occur due to the following reasons:
1757         /// 1) The application does not have the privilege to call this function.
1758         /// 2) The IME main loop isn't started yet.
1759         /// </exception>
1760         /// <since_tizen> 4 </since_tizen>
1761         public static void CommitString(string str)
1762         {
1763             ErrorCode error = ImeCommitString(str);
1764             if (error != ErrorCode.None)
1765             {
1766                 Log.Error(LogTag, "CommitString Failed with error " + error);
1767                 throw InputMethodExceptionFactory.CreateException(error);
1768             }
1769         }
1770
1771         /// <summary>
1772         /// Requests to show the pre-edit string.
1773         /// </summary>
1774         /// <privilege>
1775         /// http://tizen.org/privilege/ime
1776         /// </privilege>
1777         /// <exception cref="InvalidOperationException">
1778         /// This can occur due to the following reasons:
1779         /// 1) The application does not have the privilege to call this function.
1780         /// 2) The IME main loop isn't started yet.
1781         /// </exception>
1782         /// <since_tizen> 4 </since_tizen>
1783         public static void ShowPreEditString()
1784         {
1785             ErrorCode error = ImeShowPreeditString();
1786             if (error != ErrorCode.None)
1787             {
1788                 Log.Error(LogTag, "ShowPreEditString Failed with error " + error);
1789                 throw InputMethodExceptionFactory.CreateException(error);
1790             }
1791         }
1792
1793         /// <summary>
1794         /// Requests to hide the pre-edit string.
1795         /// </summary>
1796         /// <privilege>
1797         /// http://tizen.org/privilege/ime
1798         /// </privilege>
1799         /// <exception cref="InvalidOperationException">
1800         /// This can occur due to the following reasons:
1801         /// 1) The application does not have the privilege to call this function.
1802         /// 2) The IME main loop isn't started yet.
1803         /// </exception>
1804         /// <since_tizen> 4 </since_tizen>
1805         public static void HidePreEditString()
1806         {
1807             ErrorCode error = ImeHidePreeditString();
1808             if (error != ErrorCode.None)
1809             {
1810                 Log.Error(LogTag, "HidePreEditString Failed with error " + error);
1811                 throw InputMethodExceptionFactory.CreateException(error);
1812             }
1813         }
1814
1815         /// <summary>
1816         /// Updates a new pre-edit string.
1817         /// </summary>
1818         /// <privilege>
1819         /// http://tizen.org/privilege/ime
1820         /// </privilege>
1821         /// <param name="str">The string to be updated in pre-edit.</param>
1822         /// <param name="attrs">
1823         /// The list which has ime_preedit_attribute lists, strings can be composed of multiple string attributes: underline, highlight color, and reversal color.
1824         /// The attrs list can be empty if no attributes to set.
1825         /// </param>
1826         /// <exception cref="InvalidOperationException">
1827         /// This can occur due to the following reasons:
1828         /// 1) The application does not have the privilege to call this function.
1829         /// 2) The IME main loop isn't started yet.
1830         /// 3) Invalid parameter.
1831         /// </exception>
1832         /// <since_tizen> 4 </since_tizen>
1833         public static void UpdatePreEditString(string str, IEnumerable<PreEditAttribute> attrs)
1834         {
1835             IntPtr einaList = IntPtr.Zero;
1836             List<GCHandle> attributeHandleList = new List<GCHandle>();
1837             foreach (PreEditAttribute attribute in attrs)
1838             {
1839                 ImePreEditAttributeStruct imePreEditAttribute = new ImePreEditAttributeStruct();
1840                 imePreEditAttribute.start = attribute.Start;
1841                 imePreEditAttribute.length = attribute.Length;
1842                 imePreEditAttribute.type = (int)attribute.Type;
1843                 imePreEditAttribute.value = attribute.Value;
1844                 GCHandle attributeHandle = GCHandle.Alloc(imePreEditAttribute, GCHandleType.Pinned);
1845                 attributeHandleList.Add(attributeHandle);
1846                 einaList = Interop.EinaList.EinaListAppend(einaList, attributeHandle.AddrOfPinnedObject());
1847             }
1848             ErrorCode error = ImeUpdatePreeditString(str, einaList);
1849             foreach (GCHandle handle in attributeHandleList)
1850             {
1851                 handle.Free();
1852             }
1853             if (error != ErrorCode.None)
1854             {
1855                 Log.Error(LogTag, "UpdatePreEditString Failed with error " + error);
1856                 throw InputMethodExceptionFactory.CreateException(error);
1857             }
1858         }
1859
1860         /// <summary>
1861         /// Requests the surrounding text from the position of the cursor, asynchronously.
1862         /// </summary>
1863         /// <privilege>
1864         /// http://tizen.org/privilege/ime
1865         /// </privilege>
1866         /// <param name="maxLenBefore">The maximum length of the string to be retrieved before the cursor, -1 means unlimited.</param>
1867         /// <param name="maxLenAfter">The maximum length of the string to be retrieved after the cursor, -1 means unlimited.</param>
1868         /// <exception cref="InvalidOperationException">
1869         /// This can occur due to the following reasons:
1870         /// 1) The application does not have the privilege to call this function.
1871         /// 2) The IME main loop isn't started yet.
1872         /// </exception>
1873         /// <postcondition>
1874         /// The requested surrounding text can be received using the SurroundingTextUpdated event, only if it is set.
1875         /// </postcondition>
1876         /// <since_tizen> 4 </since_tizen>
1877         public static void RequestSurroundingText(int maxLenBefore, int maxLenAfter)
1878         {
1879             ErrorCode error = ImeRequestSurroundingText(maxLenBefore, maxLenAfter);
1880             if (error != ErrorCode.None)
1881             {
1882                 Log.Error(LogTag, "RequestSurroundingText Failed with error " + error);
1883                 throw InputMethodExceptionFactory.CreateException(error);
1884             }
1885         }
1886
1887         /// <summary>
1888         /// Requests to delete the surrounding text.
1889         /// </summary>
1890         /// <privilege>
1891         /// http://tizen.org/privilege/ime
1892         /// </privilege>
1893         /// <param name="offset">The offset value from the cursor position.</param>
1894         /// <param name="len">The length of the text to delete.</param>
1895         /// <exception cref="InvalidOperationException">
1896         /// This can occur due to the following reasons:
1897         /// 1) The application does not have the privilege to call this function.
1898         /// 2) The IME main loop isn't started yet.
1899         /// 3) Invalid parameter.
1900         /// </exception>
1901         /// <since_tizen> 4 </since_tizen>
1902         public static void DeleteSurroundingText(int offset, int len)
1903         {
1904             ErrorCode error = ImeDeleteSurroundingText(offset, len);
1905             if (error != ErrorCode.None)
1906             {
1907                 Log.Error(LogTag, "DeleteSurroundingText Failed with error " + error);
1908                 throw InputMethodExceptionFactory.CreateException(error);
1909             }
1910         }
1911
1912         /// <summary>
1913         /// Gets the surrounding text from the position of the cursor, synchronously.
1914         /// </summary>
1915         /// <privilege>
1916         /// http://tizen.org/privilege/ime
1917         /// </privilege>
1918         /// <param name="maxLenBefore">The maximum length of the string to be retrieved before the cursor, -1 means unlimited.</param>
1919         /// <param name="maxLenAfter">The maximum length of the string to be retrieved after the cursor, -1 means unlimited.</param>
1920         /// <param name="text">The surrounding text.</param>
1921         /// <param name="cursorPosition">The cursor position.</param>
1922         /// <exception cref="InvalidOperationException">
1923         /// This can occur due to the following reasons:
1924         /// 1) The application does not have the privilege to call this function.
1925         /// 2) The IME main loop isn't started yet.
1926         /// 3) Invalid parameter.
1927         /// 4) Failed to obtain text due to out of memory.
1928         /// </exception>
1929         /// <since_tizen> 4 </since_tizen>
1930         public static void GetSurroundingText(int maxLenBefore, int maxLenAfter, out string text, out int cursorPosition)
1931         {
1932             IntPtr txt;
1933             ErrorCode error = ImeGetSurroundingText(maxLenBefore, maxLenAfter, out txt, out cursorPosition);
1934             if (error != ErrorCode.None)
1935             {
1936                 Log.Error(LogTag, "GetSurroundingText Failed with error " + error);
1937                 throw InputMethodExceptionFactory.CreateException(error);
1938             }
1939             text = Marshal.PtrToStringAnsi(txt);
1940         }
1941
1942         /// <summary>
1943         /// Requests to set the selection.
1944         /// </summary>
1945         /// <privilege>
1946         /// http://tizen.org/privilege/ime
1947         /// </privilege>
1948         /// <param name="start">The start cursor position in text (in characters not bytes).</param>
1949         /// <param name="end">The end cursor position in text (in characters not bytes).</param>
1950         /// <exception cref="InvalidOperationException">
1951         /// This can occur due to the following reasons:
1952         /// 1) The application does not have the privilege to call this function.
1953         /// 2) The IME main loop isn't started yet.
1954         /// 3) Invalid parameter.
1955         /// </exception>
1956         /// <since_tizen> 4 </since_tizen>
1957         public static void SetSelection(int start, int end)
1958         {
1959             ErrorCode error = ImeSetSelection(start, end);
1960             if (error != ErrorCode.None)
1961             {
1962                 Log.Error(LogTag, "SetSelection Failed with error " + error);
1963                 throw InputMethodExceptionFactory.CreateException(error);
1964             }
1965         }
1966
1967         /// <summary>
1968         /// This API returns the input panel main window.
1969         /// </summary>
1970         /// <privilege>
1971         /// http://tizen.org/privilege/ime
1972         /// </privilege>
1973         /// <returns>The input panel main window object on success, otherwise null.</returns>
1974         /// <exception cref="InvalidOperationException">
1975         /// This can occur due to the following reasons:
1976         /// 1) The application does not have the privilege to call this function.
1977         /// 2) The IME main loop isn't started yet.
1978         /// 3) Operation failed.
1979         /// </exception>
1980         /// <since_tizen> 4 </since_tizen>
1981         public static EditorWindow GetMainWindow()
1982         {
1983             EditorWindow._handle = ImeGetMainWindow();
1984             EditorWindow obj = new EditorWindow();
1985             ErrorCode error = (ErrorCode)Tizen.Internals.Errors.ErrorFacts.GetLastResult();
1986             if (error != ErrorCode.None)
1987             {
1988                 Log.Error(LogTag, "GetMainWindow Failed with error " + error);
1989                 throw InputMethodExceptionFactory.CreateException(error);
1990             }
1991             return obj;
1992         }
1993
1994         /// <summary>
1995         /// Sends the request to hide the IME.
1996         /// </summary>
1997         /// <privilege>
1998         /// http://tizen.org/privilege/ime
1999         /// </privilege>
2000         /// <exception cref="InvalidOperationException">
2001         /// This can occur due to the following reasons:
2002         /// 1) The application does not have the privilege to call this function.
2003         /// 2) The IME main loop has not yet started.
2004         /// </exception>
2005         /// <since_tizen> 5 </since_tizen>
2006         public static void RequestHide()
2007         {
2008             ErrorCode error = ImeRequestHide();
2009             if (error != ErrorCode.None)
2010             {
2011                 Log.Error(LogTag, "RequestHide Failed with error " + error);
2012                 throw InputMethodExceptionFactory.CreateException(error);
2013             }
2014         }
2015
2016         /// <summary>
2017         /// This API requests the InputMethodEditor to initialize.
2018         /// </summary>
2019         /// <privilege>
2020         /// http://tizen.org/privilege/ime
2021         /// </privilege>
2022         /// <exception cref="InvalidOperationException">
2023         /// This can occur due to the following reasons:
2024         /// 1) The application does not have the privilege to call this function.
2025         /// 2) Operation failed.
2026         /// </exception>
2027         /// <since_tizen> 4 </since_tizen>
2028         [EditorBrowsable(EditorBrowsableState.Never)]
2029         public static void Create()
2030         {
2031             ErrorCode error = ImeInitialize();
2032             Log.Info(LogTag, "ImeInitialize result : " + error);
2033             if (error != ErrorCode.None)
2034             {
2035                 Log.Error(LogTag, "ImeInitialize Failed with error " + error);
2036                 throw InputMethodExceptionFactory.CreateException(error);
2037             }
2038
2039             error = ImePrepare();
2040             Log.Info(LogTag, "ImePrepare result : " + error);
2041             if (error != ErrorCode.None)
2042             {
2043                 Log.Error(LogTag, "ImePrepare Failed with error " + error);
2044                 throw InputMethodExceptionFactory.CreateException(error);
2045             }
2046         }
2047
2048         /// <summary>
2049         /// This API requests the InputMethodEditor to finalize.
2050         /// </summary>
2051         /// <privilege>
2052         /// http://tizen.org/privilege/ime
2053         /// </privilege>
2054         /// <exception cref="InvalidOperationException">
2055         /// This can occur due to the following reasons:
2056         /// 1) The application does not have the privilege to call this function.
2057         /// 2) Operation failed.
2058         /// </exception>
2059         /// <since_tizen> 4 </since_tizen>
2060         [EditorBrowsable(EditorBrowsableState.Never)]
2061         public static void Destroy()
2062         {
2063             ErrorCode error = ImeFinalize();
2064             Log.Info(LogTag, "ImeFinalize result : " + error);
2065             if (error != ErrorCode.None)
2066             {
2067                 Log.Error(LogTag, "ImeFinalize Failed with error " + error);
2068                 throw InputMethodExceptionFactory.CreateException(error);
2069             }
2070         }
2071
2072         /// <summary>
2073         /// Sets the floating mode to on or off.
2074         /// </summary>
2075         /// <privilege>
2076         /// http://tizen.org/privilege/ime
2077         /// </privilege>
2078         /// <param name="floating_mode"><c>true</c> to set the floating mode to on and <c>false</c> to set it to off.</param>
2079         /// <exception cref="InvalidOperationException">
2080         /// This can occur due to the following reasons:
2081         /// 1) The application does not have the privilege to call this function.
2082         /// 2) The IME main loop has not yet started.
2083         /// </exception>
2084         /// <since_tizen> 5 </since_tizen>
2085         public static void SetFloatingMode(bool floating_mode)
2086         {
2087             ErrorCode error = ImeSetFloatingMode(floating_mode);
2088             if (error != ErrorCode.None)
2089             {
2090                 Log.Error(LogTag, "SetFloatingMode Failed with error " + error);
2091                 throw InputMethodExceptionFactory.CreateException(error);
2092             }
2093         }
2094
2095         /// <summary>
2096         /// Allows the floating input panel window to move along with the mouse pointer when the mouse is pressed.
2097         /// </summary>
2098         /// <privilege>
2099         /// http://tizen.org/privilege/ime
2100         /// </privilege>
2101         /// <remarks>
2102         /// This function can be used in floating mode. If the floating mode is deactivated, calling this function has no effect.
2103         /// </remarks>
2104         /// <exception cref="InvalidOperationException">
2105         /// This can occur due to the following reasons:
2106         /// 1) The application does not have the privilege to call this function.
2107         /// 2) The IME main loop has not yet started.
2108         /// </exception>
2109         /// <since_tizen> 5 </since_tizen>
2110         public static void SetFloatingDragStart()
2111         {
2112             ErrorCode error = ImeSetFloatingDragStart();
2113             if (error != ErrorCode.None)
2114             {
2115                 Log.Error(LogTag, "SetFloatingDragStart Failed with error " + error);
2116                 throw InputMethodExceptionFactory.CreateException(error);
2117             }
2118         }
2119
2120         /// <summary>
2121         /// Does not allow the movement of the floating input panel window with the mouse pointer when the mouse is pressed.
2122         /// </summary>
2123         /// <privilege>
2124         /// http://tizen.org/privilege/ime
2125         /// </privilege>
2126         /// <remarks>
2127         /// This function can be used in floating mode. If the floating mode is deactivated, calling this function has no effect.
2128         /// </remarks>
2129         /// <exception cref="InvalidOperationException">
2130         /// This can occur due to the following reasons:
2131         /// 1) The application does not have the privilege to call this function.
2132         /// 2) The IME main loop has not yet started.
2133         /// </exception>
2134         /// <since_tizen> 5 </since_tizen>
2135         public static void SetFloatingDragEnd()
2136         {
2137             ErrorCode error = ImeSetFloatingDragEnd();
2138             if (error != ErrorCode.None)
2139             {
2140                 Log.Error(LogTag, "SetFloatingDragEnd Failed with error " + error);
2141                 throw InputMethodExceptionFactory.CreateException(error);
2142             }
2143         }
2144
2145         /// <summary>
2146         /// Notifies the changed language of the input panel to the the associated text input UI control.
2147         /// </summary>
2148         /// <privilege>
2149         /// http://tizen.org/privilege/ime
2150         /// </privilege>
2151         /// <remarks>
2152         /// LanguageRequestedCallback is raised after this API is called when the App requests changed language information.
2153         /// </remarks>
2154         /// <exception cref="InvalidOperationException">
2155         /// This can occur due to the following reasons:
2156         /// 1) The application does not have the privilege to call this function.
2157         /// 2) The IME main loop has not yet started.
2158         /// </exception>
2159         /// <since_tizen> 6 </since_tizen>
2160         public static void SendLanguageUpdated()
2161         {
2162             ErrorCode error = ImeUpdateInputPanelEvent(ImeEventType.Language, 0);
2163             if (error != ErrorCode.None)
2164             {
2165                 Log.Error(LogTag, "SendLanguageUpdated Failed with error " + error);
2166                 throw InputMethodExceptionFactory.CreateException(error);
2167             }
2168         }
2169
2170         /// <summary>
2171         /// Sends the changed shift mode of the input panel to the the associated text input UI control.
2172         /// </summary>
2173         /// <privilege>
2174         /// http://tizen.org/privilege/ime
2175         /// </privilege>
2176         /// <param name="enable"><c>true</c> if shift button is clicked, otherwise <c>false</c>.</param>
2177         /// <exception cref="InvalidOperationException">
2178         /// This can occur due to the following reasons:
2179         /// 1) The application does not have the privilege to call this function.
2180         /// 2) The IME main loop has not yet started.
2181         /// </exception>
2182         /// <since_tizen> 6 </since_tizen>
2183         public static void SendShiftModeUpdated(bool enable)
2184         {
2185             ErrorCode error = ImeUpdateInputPanelEvent(ImeEventType.ShiftMode, enable ? (uint)ImeShiftMode.On : (uint)ImeShiftMode.Off);
2186             if (error != ErrorCode.None)
2187             {
2188                 Log.Error(LogTag, "SendInputPanelEvent Failed with error " + error);
2189                 throw InputMethodExceptionFactory.CreateException(error);
2190             }
2191         }
2192
2193         /// <summary>
2194         /// Notifies the changed geometry of input panel window to the associated text input UI control.
2195         /// </summary>
2196         /// <privilege>
2197         /// http://tizen.org/privilege/ime
2198         /// </privilege>
2199         /// <exception cref="InvalidOperationException">
2200         /// This can occur due to the following reasons:
2201         /// 1) The application does not have the privilege to call this function.
2202         /// 2) The IME main loop has not yet started.
2203         /// </exception>
2204         /// <since_tizen> 6 </since_tizen>
2205         public static void SendCustomGeometryUpdated()
2206         {
2207             ErrorCode error = ImeUpdateInputPanelEvent(ImeEventType.Geometry, 0);
2208             if (error != ErrorCode.None)
2209             {
2210                 Log.Error(LogTag, "SendCustomGeometryUpdated Failed with error " + error);
2211                 throw InputMethodExceptionFactory.CreateException(error);
2212             }
2213         }
2214     }
2215 }