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 event EventHandler<PredictionHintUpdatedEventArgs> _predictionHintUpdated;
 993         private static ImePredictionHintSetCb _imePredictionHintSetDelegate;
 994         private static event EventHandler<PredictionHintDataUpdatedEventArgs> _predictionHintDataUpdated;
 995         private static ImePredictionHintDataSetCb _imePredictionHintDataSetDelegate;
 996         private static event EventHandler<MimeTypeUpdateRequestedEventArgs> _mimeTypeUpdateRequested;
 997         private static ImeMimeTypeSetRequestCb _imeMimeTypeSetRequestDelegate;
 998         private static ImeLanguageRequestedCb _imeLanguageRequestedDelegate;
 999         private static OutAction<string> _languageRequestedDelegate;
1000         private static BoolAction<KeyCode, KeyMask, InputMethodDeviceInformation> _processKeyDelagate;
1001         private static ImeImdataRequestedCb _imeImDataRequestedDelegate;
1002         private static OutArrayAction<byte> _imDataRequestedDelegate;
1003         private static ImeGeometryRequestedCb _imeGeometryRequestedDelegate;
1004         private static OutAction<Rect> _geometryRequestedDelegate;
1005         private static Action _userCreate;
1006         private static Action _userTerminate;
1007         private static Action<ContextId, InputMethodContext> _userShow;
1008         private static Action<ContextId> _userHide;
1009         private static ImeCreateCb _create = (IntPtr userData) =>
1010         {
1011             Log.Info(LogTag, "In Create Delegate");
1012             _userCreate?.Invoke();
1013         };
1014         private static ImeTerminateCb _terminate = (IntPtr userData) =>
1015         {
1016             Log.Info(LogTag, "In terminate Delegate");
1017             _userTerminate?.Invoke();
1018             _imeCallbackStructGCHandle.Dispose();
1019         };
1020         private static ImeShowCb _show = (int contextId, IntPtr context, IntPtr userData) =>
1021         {
1022             Log.Info(LogTag, "In Show Delegate");
1023             _userShow?.Invoke(new ContextId(contextId), new InputMethodContext(context));
1024         };
1025         private static ImeHideCb _hide = (int contextId, IntPtr userData) =>
1026         {
1027             Log.Info(LogTag, "In Hide Delegate");
1028             _userHide?.Invoke(new ContextId(contextId));
1029         };
1030
1031         /// <summary>
1032         /// Structure representing the ContextId.
1033         /// </summary>
1034         /// <since_tizen> 4 </since_tizen>
1035         public struct ContextId : IEquatable<ContextId>
1036         {
1037             internal ContextId(int id)
1038             {
1039                 Id = id;
1040             }
1041
1042             internal int Id
1043             {
1044                 get;
1045                 private set;
1046             }
1047
1048             /// <summary>
1049             /// Compares whether the ContextIds are equal.
1050             /// </summary>
1051             /// <param name="other">The ContextId to compare with this instance.</param>
1052             /// <returns>true if the ContextIds is the same; otherwise, false.</returns>
1053             /// <since_tizen> 4 </since_tizen>
1054             public bool Equals(ContextId other)
1055             {
1056                 return this.Id == other.Id;
1057             }
1058         }
1059
1060         /// <summary>
1061         /// Rectangle representing the position and size of the UI control.
1062         /// </summary>
1063         /// <since_tizen> 4 </since_tizen>
1064         public struct Rect
1065         {
1066             /// <summary>
1067             /// The X position in the screen.
1068             /// </summary>
1069             /// <since_tizen> 4 </since_tizen>
1070             public int x;
1071
1072             /// <summary>
1073             /// The Y position in the screen.
1074             /// </summary>
1075             /// <since_tizen> 4 </since_tizen>
1076             public int y;
1077
1078             /// <summary>
1079             /// The window width.
1080             /// </summary>
1081             /// <since_tizen> 4 </since_tizen>
1082             public int w;
1083
1084             /// <summary>
1085             /// The window height.
1086             /// </summary>
1087             /// <since_tizen> 4 </since_tizen>
1088             public int h;
1089         }
1090
1091         /// <summary>
1092         /// An action with 1 out parameter.
1093         /// </summary>
1094         /// <typeparam name="T">Generic Type.</typeparam>
1095         /// <param name="a">The out parameter.</param>
1096         /// <since_tizen> 4 </since_tizen>
1097         public delegate void OutAction<T>(out T a);
1098
1099         /// <summary>
1100         /// An action with an array out parameter.
1101         /// </summary>
1102         /// <typeparam name="T">Generic Type.</typeparam>
1103         /// <param name="a">The out parameter 1.</param>
1104         /// <since_tizen> 4 </since_tizen>
1105         public delegate void OutArrayAction<T>(out T[] a);
1106
1107         /// <summary>
1108         /// An action with 3 input parameters returning a bool.
1109         /// </summary>
1110         /// <typeparam name="T">Generic type for parameter 1.</typeparam>
1111         /// <typeparam name="T1">Generic type for parameter 2.</typeparam>
1112         /// <typeparam name="T2">Generic type for parameter 3.</typeparam>
1113         /// <param name="a">The input parameter 1.</param>
1114         /// <param name="b">The input parameter 2.</param>
1115         /// <param name="c">The input parameter 3.</param>
1116         /// <returns></returns>
1117         /// <since_tizen> 4 </since_tizen>
1118         public delegate bool BoolAction<T, T1, T2>(T a, T1 b, T2 c);
1119
1120         /// <summary>
1121         /// Called when an associated text input UI control has focus.
1122         /// </summary>
1123         /// <since_tizen> 4 </since_tizen>
1124         public static event EventHandler<FocusedInEventArgs> FocusedIn
1125         {
1126             add
1127             {
1128                 lock (thisLock)
1129                 {
1130                     _imeFocusedInDelegate = (int contextId, IntPtr userData) =>
1131                     {
1132                         FocusedInEventArgs args = new FocusedInEventArgs(contextId);
1133                         _focusIn?.Invoke(null, args);
1134                     };
1135                     ErrorCode error = ImeEventSetFocusedInCb(_imeFocusedInDelegate, IntPtr.Zero);
1136                     if (error != ErrorCode.None)
1137                     {
1138                         Log.Error(LogTag, "Add FocusedIn Failed with error " + error);
1139                     }
1140                     else
1141                     {
1142                         _focusIn += value;
1143                     }
1144                 }
1145             }
1146             remove
1147             {
1148                 lock (thisLock)
1149                 {
1150                     _focusIn -= value;
1151                 }
1152             }
1153         }
1154
1155         /// <summary>
1156         /// Called when an associated text input UI control loses focus.
1157         /// </summary>
1158         /// <since_tizen> 4 </since_tizen>
1159         public static event EventHandler<FocusedOutEventArgs> FocusedOut
1160         {
1161             add
1162             {
1163                 lock (thisLock)
1164                 {
1165                     _imeFocusedOutDelegate = (int contextId, IntPtr userData) =>
1166                     {
1167                         FocusedOutEventArgs args = new FocusedOutEventArgs(contextId);
1168                         _focusOut?.Invoke(null, args);
1169                     };
1170                     ErrorCode error = ImeEventSetFocusedOutCb(_imeFocusedOutDelegate, IntPtr.Zero);
1171                     if (error != ErrorCode.None)
1172                     {
1173                         Log.Error(LogTag, "Add FocusedOut Failed with error " + error);
1174                     }
1175                     else
1176                     {
1177                         _focusOut += value;
1178                     }
1179                 }
1180             }
1181             remove
1182             {
1183                 lock (thisLock)
1184                 {
1185                     _focusOut -= value;
1186                 }
1187             }
1188         }
1189
1190         /// <summary>
1191         /// Called when an associated text input UI control responds to a request with the surrounding text.
1192         /// </summary>
1193         /// <since_tizen> 4 </since_tizen>
1194         public static event EventHandler<SurroundingTextUpdatedEventArgs> SurroundingTextUpdated
1195         {
1196             add
1197             {
1198                 lock (thisLock)
1199                 {
1200                     _imeSurroundingTextUpdatedDelegate = (int contextId, IntPtr text, int cursorPos, IntPtr userData) =>
1201                     {
1202                         SurroundingTextUpdatedEventArgs args = new SurroundingTextUpdatedEventArgs(contextId, Marshal.PtrToStringAnsi(text), cursorPos);
1203                         _surroundingTextUpdated?.Invoke(null, args);
1204                     };
1205                     ErrorCode error = ImeEventSetSurroundingTextUpdatedCb(_imeSurroundingTextUpdatedDelegate, IntPtr.Zero);
1206                     if (error != ErrorCode.None)
1207                     {
1208                         Log.Error(LogTag, "Add SurroundingTextUpdated Failed with error " + error);
1209                     }
1210                     else
1211                     {
1212                         _surroundingTextUpdated += value;
1213                     }
1214                 }
1215             }
1216             remove
1217             {
1218                 lock (thisLock)
1219                 {
1220                     _surroundingTextUpdated -= value;
1221                 }
1222             }
1223         }
1224
1225         /// <summary>
1226         /// Called to reset the input context of an associated text input UI control.
1227         /// </summary>
1228         /// <since_tizen> 4 </since_tizen>
1229         public static event EventHandler<EventArgs> InputContextReset
1230         {
1231             add
1232             {
1233                 lock (thisLock)
1234                 {
1235                     _imeInputContextResetDelegate = (IntPtr userData) =>
1236                     {
1237                         _inputContextReset?.Invoke(null, EventArgs.Empty);
1238                     };
1239                     ErrorCode error = ImeEventSetInputContextResetCb(_imeInputContextResetDelegate, IntPtr.Zero);
1240                     if (error != ErrorCode.None)
1241                     {
1242                         Log.Error(LogTag, "Add InputContextReset Failed with error " + error);
1243                     }
1244                     else
1245                     {
1246                         _inputContextReset += value;
1247                     }
1248                 }
1249             }
1250             remove
1251             {
1252                 lock (thisLock)
1253                 {
1254                     _inputContextReset -= value;
1255                 }
1256             }
1257         }
1258
1259         /// <summary>
1260         /// Called when the position of the cursor in an associated text input UI control changes.
1261         /// </summary>
1262         /// <since_tizen> 4 </since_tizen>
1263         public static event EventHandler<CursorPositionUpdatedEventArgs> CursorPositionUpdated
1264         {
1265             add
1266             {
1267                 lock (thisLock)
1268                 {
1269                     _imeCursorPositionUpdatedDelegate = (int cursorPos, IntPtr userData) =>
1270                     {
1271                         CursorPositionUpdatedEventArgs args = new CursorPositionUpdatedEventArgs(cursorPos);
1272                         _cursorPositionUpdated?.Invoke(null, args);
1273                     };
1274                     ErrorCode error = ImeEventSetCursorPositionUpdatedCb(_imeCursorPositionUpdatedDelegate, IntPtr.Zero);
1275                     if (error != ErrorCode.None)
1276                     {
1277                         Log.Error(LogTag, "Add CursorPositionUpdated Failed with error " + error);
1278                     }
1279                     else
1280                     {
1281                         _cursorPositionUpdated += value;
1282                     }
1283                 }
1284             }
1285             remove
1286             {
1287                 lock (thisLock)
1288                 {
1289                     _cursorPositionUpdated -= value;
1290                 }
1291             }
1292         }
1293
1294         /// <summary>
1295         /// Called to set the preferred language to the input panel.
1296         /// It will only be called when the client application changes the edit field's language attribute after the input panel is shown.
1297         /// </summary>
1298         /// <since_tizen> 4 </since_tizen>
1299         public static event EventHandler<LanguageSetEventArgs> LanguageSet
1300         {
1301             add
1302             {
1303                 lock (thisLock)
1304                 {
1305                     _imeLanguageSetDelegate = (InputPanelLanguage language, IntPtr userData) =>
1306                     {
1307                         LanguageSetEventArgs args = new LanguageSetEventArgs(language);
1308                         _langaugeSet?.Invoke(null, args);
1309                     };
1310                     ErrorCode error = ImeEventSetLanguageSetCb(_imeLanguageSetDelegate, IntPtr.Zero);
1311                     if (error != ErrorCode.None)
1312                     {
1313                         Log.Error(LogTag, "Add LanguageSet Failed with error " + error);
1314                     }
1315                     else
1316                     {
1317                         _langaugeSet += value;
1318                     }
1319                 }
1320             }
1321             remove
1322             {
1323                 lock (thisLock)
1324                 {
1325                     _langaugeSet -= value;
1326                 }
1327             }
1328         }
1329
1330         /// <summary>
1331         /// Called to set the application specific data to deliver to the input panel.
1332         /// </summary>
1333         /// <since_tizen> 4 </since_tizen>
1334         public static event EventHandler<SetDataEventArgs> DataSet
1335         {
1336             add
1337             {
1338                 lock (thisLock)
1339                 {
1340                     _imeDataSetDelegate = (IntPtr data, uint dataLength, IntPtr userData) =>
1341                     {
1342                         byte[] destination = new byte[dataLength];
1343                         Marshal.Copy(data, destination, 0, (int)dataLength);
1344                         SetDataEventArgs args = new SetDataEventArgs(destination, dataLength);
1345                         _imDataSet?.Invoke(null, args);
1346                     };
1347                     ErrorCode error = ImeEventSetImdataSetCb(_imeDataSetDelegate, IntPtr.Zero);
1348                     if (error != ErrorCode.None)
1349                     {
1350                         Log.Error(LogTag, "Add DataSet Failed with error " + error);
1351                     }
1352                     else
1353                     {
1354                         _imDataSet += value;
1355                     }
1356                 }
1357             }
1358             remove
1359             {
1360                 lock (thisLock)
1361                 {
1362                     _imDataSet -= value;
1363                 }
1364             }
1365         }
1366
1367         /// <summary>
1368         /// Called when an associated text input UI control requests the input panel to set its layout.
1369         /// It will only be called when the client application changes the edit field's layout attribute after the input panel is shown.
1370         /// </summary>
1371         /// <since_tizen> 4 </since_tizen>
1372         public static event EventHandler<LayoutSetEventArgs> LayoutSet
1373         {
1374             add
1375             {
1376                 lock (thisLock)
1377                 {
1378                     _imeLayoutSetDelegate = (InputPanelLayout layout, IntPtr userData) =>
1379                     {
1380                         LayoutSetEventArgs args = new LayoutSetEventArgs(layout);
1381                         _layoutSet?.Invoke(null, args);
1382                     };
1383                     ErrorCode error = ImeEventSetLayoutSetCb(_imeLayoutSetDelegate, IntPtr.Zero);
1384                     if (error != ErrorCode.None)
1385                     {
1386                         Log.Error(LogTag, "Add LayoutSet Failed with error " + error);
1387                     }
1388                     else
1389                     {
1390                         _layoutSet += value;
1391                     }
1392                 }
1393             }
1394             remove
1395             {
1396                 lock (thisLock)
1397                 {
1398                     _layoutSet -= value;
1399                 }
1400             }
1401         }
1402
1403         /// <summary>
1404         /// Called when an associated text input UI control requests the input panel to set the Return key label.
1405         /// The input panel can show the text or an image on the Return button, according to the Return key action.
1406         /// </summary>
1407         /// <since_tizen> 4 </since_tizen>
1408         public static event EventHandler<ReturnKeySetEventArgs> ReturnKeySet
1409         {
1410             add
1411             {
1412                 lock (thisLock)
1413                 {
1414                     _imeReturnKeySetDelegate = (InputPanelReturnKey type, IntPtr userData) =>
1415                     {
1416                         ReturnKeySetEventArgs args = new ReturnKeySetEventArgs(type);
1417                         _returnKeyTypeSet?.Invoke(null, args);
1418                     };
1419                     ErrorCode error = ImeEventSetReturnKeySetCb(_imeReturnKeySetDelegate, IntPtr.Zero);
1420                     if (error != ErrorCode.None)
1421                     {
1422                         Log.Error(LogTag, "Add ReturnKeySet Failed with error " + error);
1423                     }
1424                     else
1425                     {
1426                         _returnKeyTypeSet += value;
1427                     }
1428                 }
1429             }
1430             remove
1431             {
1432                 lock (thisLock)
1433                 {
1434                     _returnKeyTypeSet -= value;
1435                 }
1436             }
1437         }
1438
1439         /// <summary>
1440         /// Called when an associated text input UI control requests the input panel to enable or disable the Return key state.
1441         /// </summary>
1442         /// <since_tizen> 4 </since_tizen>
1443         public static event EventHandler<ReturnKeyStateSetEventArgs> ReturnKeyStateSet
1444         {
1445             add
1446             {
1447                 lock (thisLock)
1448                 {
1449                     _imeReturnKeyStateSetDelegate = (bool state, IntPtr userData) =>
1450                     {
1451                         ReturnKeyStateSetEventArgs args = new ReturnKeyStateSetEventArgs(state);
1452                         _returnKeyStateSet?.Invoke(null, args);
1453                     };
1454                     ErrorCode error = ImeEventSetReturnKeyStateSetCb(_imeReturnKeyStateSetDelegate, IntPtr.Zero);
1455                     if (error != ErrorCode.None)
1456                     {
1457                         Log.Error(LogTag, "Add ReturnKeyStateSet Failed with error " + error);
1458                     }
1459                     else
1460                     {
1461                         _returnKeyStateSet += value;
1462                     }
1463                 }
1464             }
1465             remove
1466             {
1467                 lock (thisLock)
1468                 {
1469                     _returnKeyStateSet -= value;
1470                 }
1471             }
1472         }
1473
1474         /// <summary>
1475         /// Called when the system display language is changed.
1476         /// </summary>
1477         /// <since_tizen> 4 </since_tizen>
1478         public static event EventHandler<DisplayLanguageChangedEventArgs> DisplayLanguageChanged
1479         {
1480             add
1481             {
1482                 lock (thisLock)
1483                 {
1484                     _imeDisplayLanguageChangedDelegate = (IntPtr language, IntPtr userData) =>
1485                     {
1486                         DisplayLanguageChangedEventArgs args = new DisplayLanguageChangedEventArgs(Marshal.PtrToStringAnsi(language));
1487                         _displayLanguageChanged?.Invoke(null, args);
1488                     };
1489                     ErrorCode error = ImeEventSetDisplayLanguageChangedCb(_imeDisplayLanguageChangedDelegate, IntPtr.Zero);
1490                     if (error != ErrorCode.None)
1491                     {
1492                         Log.Error(LogTag, "Add DisplayLanguageChanged Failed with error " + error);
1493                     }
1494                     else
1495                     {
1496                         _displayLanguageChanged += value;
1497                     }
1498                 }
1499             }
1500             remove
1501             {
1502                 lock (thisLock)
1503                 {
1504                     _displayLanguageChanged -= value;
1505                 }
1506             }
1507         }
1508
1509         /// <summary>
1510         /// Called when the device is rotated.
1511         /// </summary>
1512         /// <since_tizen> 4 </since_tizen>
1513         public static event EventHandler<RotationChangedEventArgs> RotationChanged
1514         {
1515             add
1516             {
1517                 lock (thisLock)
1518                 {
1519                     _imeRotationChangedDelegate = (int degree, IntPtr userData) =>
1520                     {
1521                         RotationChangedEventArgs args = new RotationChangedEventArgs(degree);
1522                         _rotationDegreeChanged?.Invoke(null, args);
1523                     };
1524                     ErrorCode error = ImeEventSetRotationChangedCb(_imeRotationChangedDelegate, IntPtr.Zero);
1525                     if (error != ErrorCode.None)
1526                     {
1527                         Log.Error(LogTag, "Add RotationChanged Failed with error " + error);
1528                     }
1529                     else
1530                     {
1531                         _rotationDegreeChanged += value;
1532                     }
1533                 }
1534             }
1535             remove
1536             {
1537                 lock (thisLock)
1538                 {
1539                     _rotationDegreeChanged -= value;
1540                 }
1541             }
1542         }
1543
1544         /// <summary>
1545         /// Called when Accessibility in settings application is on or off.
1546         /// </summary>
1547         /// <since_tizen> 4 </since_tizen>
1548         public static event EventHandler<AccessibilityStateChangedEventArgs> AccessibilityStateChanged
1549         {
1550             add
1551             {
1552                 lock (thisLock)
1553                 {
1554                     _imeAccessibilityStateChangedDelegate = (bool state, IntPtr userData) =>
1555                     {
1556                         AccessibilityStateChangedEventArgs args = new AccessibilityStateChangedEventArgs(state);
1557                         _accessibilityStateChanged?.Invoke(null, args);
1558                     };
1559                     ErrorCode error = ImeEventSetAccessibilityStateChangedCb(_imeAccessibilityStateChangedDelegate, IntPtr.Zero);
1560                     if (error != ErrorCode.None)
1561                     {
1562                         Log.Error(LogTag, "Add AccessibilityStateChanged Failed with error " + error);
1563                     }
1564                     else
1565                     {
1566                         _accessibilityStateChanged += value;
1567                     }
1568                 }
1569             }
1570             remove
1571             {
1572                 lock (thisLock)
1573                 {
1574                     _accessibilityStateChanged -= value;
1575                 }
1576             }
1577         }
1578
1579         /// <summary>
1580         /// Sets the languageRequested action.
1581         /// </summary>
1582         /// <param name="languageRequested">
1583         /// Called when an associated text input UI control requests the language from the input panel, requesting for language code.
1584         /// </param>
1585         /// <since_tizen> 4 </since_tizen>
1586         public static void SetLanguageRequestedCallback(OutAction<string> languageRequested)
1587         {
1588             _imeLanguageRequestedDelegate = (IntPtr userData, out IntPtr langCode) =>
1589             {
1590                 string langauage;
1591                 _languageRequestedDelegate(out langauage);
1592                 langCode = (IntPtr)Marshal.StringToHGlobalAnsi(langauage);
1593             };
1594             ErrorCode error = ImeEventSetLanguageRequestedCallbackCb(_imeLanguageRequestedDelegate, IntPtr.Zero);
1595             if (error != ErrorCode.None)
1596             {
1597                 Log.Error(LogTag, "Add SetLanguageRequestedCallback Failed with error " + error);
1598             }
1599             _languageRequestedDelegate = languageRequested;
1600         }
1601
1602         /// <summary>
1603         /// Sets the processKey action.
1604         /// If the key event is from the external device, DeviceInfo will have its name, class, and subclass information.
1605         /// </summary>
1606         /// <param name="processKey">
1607         /// The action is called when the key event is received from the external devices or the SendKey function.
1608         /// This Event processes the key event before an associated text input UI control does.
1609         /// </param>
1610         /// <since_tizen> 4 </since_tizen>
1611         public static void SetProcessKeyCallback(BoolAction<KeyCode, KeyMask, InputMethodDeviceInformation> processKey)
1612         {
1613             _imeProcessKeyDelegate = (KeyCode keyCode, KeyMask keyMask, IntPtr devInfo, IntPtr userData) =>
1614             {
1615                 return _processKeyDelagate(keyCode, keyMask, new InputMethodDeviceInformation(devInfo));
1616             };
1617             ErrorCode error = ImeEventSetProcessKeyEventCb(_imeProcessKeyDelegate, IntPtr.Zero);
1618             if (error != ErrorCode.None)
1619             {
1620                 Log.Error(LogTag, "Add ProcessKey Failed with error " + error);
1621             }
1622             _processKeyDelagate = processKey;
1623         }
1624
1625         /// <summary>
1626         /// Sets the imDataRequested action.
1627         /// </summary>
1628         /// <param name="imDataRequested">
1629         /// 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.
1630         /// </param>
1631         /// <since_tizen> 4 </since_tizen>
1632         public static void SetDataRequestedCallback(OutArrayAction<byte> imDataRequested)
1633         {
1634             _imeImDataRequestedDelegate = (IntPtr userData, out IntPtr data, out uint dataLength) =>
1635             {
1636                 byte[] dataArr;
1637                 _imDataRequestedDelegate(out dataArr);
1638                 data = Marshal.AllocHGlobal(dataArr.Length);
1639                 Marshal.Copy(dataArr, 0, data, dataArr.Length);
1640                 dataLength = (uint)dataArr.Length;
1641             };
1642             ErrorCode error = ImeEventSetImdataRequestedCb(_imeImDataRequestedDelegate, IntPtr.Zero);
1643             if (error != ErrorCode.None)
1644             {
1645                 Log.Error(LogTag, "Add SetDataRequestedCallback Failed with error " + error);
1646             }
1647             _imDataRequestedDelegate = imDataRequested;
1648         }
1649
1650         /// <summary>
1651         /// Sets the GeometryRequested action.
1652         /// </summary>
1653         /// <param name="geometryRequested">
1654         /// Called when an associated text input UI control requests the position and size from the input panel, requesting for x, y, w, h values.
1655         /// </param>
1656         /// <since_tizen> 4 </since_tizen>
1657         public static void SetGeometryRequestedCallback(OutAction<Rect> geometryRequested)
1658         {
1659             _imeGeometryRequestedDelegate = (IntPtr userData, out int x, out int y, out int w, out int h) =>
1660             {
1661                 Rect rect = new Rect();
1662                 _geometryRequestedDelegate(out rect);
1663                 x = rect.x;
1664                 y = rect.y;
1665                 w = rect.w;
1666                 h = rect.h;
1667             };
1668             ErrorCode error = ImeEventSetGeometryRequestedCallbackCb(_imeGeometryRequestedDelegate, IntPtr.Zero);
1669             if (error != ErrorCode.None)
1670             {
1671                 Log.Error(LogTag, "Add SetGeometryRequestedCallback Failed with error " + error);
1672             }
1673             _geometryRequestedDelegate = geometryRequested;
1674         }
1675
1676         /// <summary>
1677         /// Runs the main loop of the IME application.
1678         /// This function starts to run the IME application's main loop.
1679         /// </summary>
1680         /// <privilege>
1681         /// http://tizen.org/privilege/ime
1682         /// </privilege>
1683         /// <remarks>
1684         /// This API is a blocking call, as it starts the main loop of the application.
1685         /// </remarks>
1686         /// <param name="create">This is called to initialize the IME application before the main loop starts up.</param>
1687         /// <param name="terminate">This is called when the IME application is terminated.</param>
1688         /// <param name="show">
1689         /// This is called when the IME application is shown.
1690         /// It provides the context information and the context ID.
1691         /// </param>
1692         /// <param name="hide">
1693         /// This is called when the IME application is hidden.
1694         /// It provides the context ID.
1695         /// </param>
1696         /// <exception cref="InvalidOperationException">
1697         /// This can occur due to the following reasons:
1698         /// 1) The application does not have the privilege to call this function.
1699         /// 2) Operation failed.
1700         /// </exception>
1701         /// <since_tizen> 4 </since_tizen>
1702         public static void Run(Action create, Action terminate, Action<ContextId, InputMethodContext> show, Action<ContextId> hide)
1703         {
1704             _userCreate = create;
1705             _userTerminate = terminate;
1706             _userShow = show;
1707             _userHide = hide;
1708             _imeCallbackStructGCHandle._imeCallbackStruct.create = _create;
1709             _imeCallbackStructGCHandle._imeCallbackStruct.terminate = _terminate;
1710             _imeCallbackStructGCHandle._imeCallbackStruct.hide = _hide;
1711             _imeCallbackStructGCHandle._imeCallbackStruct.show = _show;
1712
1713             ImeSetDotnetFlag(true);
1714             ErrorCode error = ImeRun(ref _imeCallbackStructGCHandle._imeCallbackStruct, IntPtr.Zero);
1715             if (error != ErrorCode.None)
1716             {
1717                 Log.Error(LogTag, "Run Failed with error " + error);
1718                 throw InputMethodExceptionFactory.CreateException(error);
1719             }
1720
1721         }
1722
1723         /// <summary>
1724         /// Sends a key event to the associated text input UI control.
1725         /// </summary>
1726         /// <remarks>
1727         /// 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.
1728         /// And if forwardKey is false, the ProcessKey event receives the key event before the edit field.
1729         /// </remarks>
1730         /// <privilege>
1731         /// http://tizen.org/privilege/ime
1732         /// </privilege>
1733         /// <param name="keyCode">The key code to be sent.</param>
1734         /// <param name="keyMask">The modifier key mask.</param>
1735         /// <param name="forwardKey">The flag to send the key event directly to the edit field.</param>
1736         /// <exception cref="InvalidOperationException">
1737         /// This can occur due to the following reasons:
1738         /// 1) The application does not have the privilege to call this function.
1739         /// 2) The IME main loop has not started yet.
1740         /// </exception>
1741         /// <since_tizen> 4 </since_tizen>
1742         public static void SendKeyEvent(KeyCode keyCode, KeyMask keyMask, bool forwardKey = false)
1743         {
1744             ErrorCode error = ImeSendKeyEvent(keyCode, keyMask, forwardKey);
1745             if (error != ErrorCode.None)
1746             {
1747                 Log.Error(LogTag, "SendEvent Failed with error " + error);
1748                 throw InputMethodExceptionFactory.CreateException(error);
1749             }
1750         }
1751
1752         /// <summary>
1753         /// Sends the text to the associated text input UI control.
1754         /// </summary>
1755         /// <privilege>
1756         /// http://tizen.org/privilege/ime
1757         /// </privilege>
1758         /// <param name="str">The string to be committed.</param>
1759         /// <exception cref="InvalidOperationException">
1760         /// This can occur due to the following reasons:
1761         /// 1) The application does not have the privilege to call this function.
1762         /// 2) The IME main loop has not started yet.
1763         /// </exception>
1764         /// <since_tizen> 4 </since_tizen>
1765         public static void CommitString(string str)
1766         {
1767             ErrorCode error = ImeCommitString(str);
1768             if (error != ErrorCode.None)
1769             {
1770                 Log.Error(LogTag, "CommitString Failed with error " + error);
1771                 throw InputMethodExceptionFactory.CreateException(error);
1772             }
1773         }
1774
1775         /// <summary>
1776         /// Requests to show the pre-edit string.
1777         /// </summary>
1778         /// <privilege>
1779         /// http://tizen.org/privilege/ime
1780         /// </privilege>
1781         /// <exception cref="InvalidOperationException">
1782         /// This can occur due to the following reasons:
1783         /// 1) The application does not have the privilege to call this function.
1784         /// 2) The IME main loop has not started yet.
1785         /// </exception>
1786         /// <since_tizen> 4 </since_tizen>
1787         public static void ShowPreEditString()
1788         {
1789             ErrorCode error = ImeShowPreeditString();
1790             if (error != ErrorCode.None)
1791             {
1792                 Log.Error(LogTag, "ShowPreEditString Failed with error " + error);
1793                 throw InputMethodExceptionFactory.CreateException(error);
1794             }
1795         }
1796
1797         /// <summary>
1798         /// Requests to hide the pre-edit string.
1799         /// </summary>
1800         /// <privilege>
1801         /// http://tizen.org/privilege/ime
1802         /// </privilege>
1803         /// <exception cref="InvalidOperationException">
1804         /// This can occur due to the following reasons:
1805         /// 1) The application does not have the privilege to call this function.
1806         /// 2) The IME main loop has not started yet.
1807         /// </exception>
1808         /// <since_tizen> 4 </since_tizen>
1809         public static void HidePreEditString()
1810         {
1811             ErrorCode error = ImeHidePreeditString();
1812             if (error != ErrorCode.None)
1813             {
1814                 Log.Error(LogTag, "HidePreEditString Failed with error " + error);
1815                 throw InputMethodExceptionFactory.CreateException(error);
1816             }
1817         }
1818
1819         /// <summary>
1820         /// Updates a new pre-edit string.
1821         /// </summary>
1822         /// <privilege>
1823         /// http://tizen.org/privilege/ime
1824         /// </privilege>
1825         /// <param name="str">The string to be updated in pre-edit.</param>
1826         /// <param name="attrs">
1827         /// The list which has ime_preedit_attribute lists, strings can be composed of multiple string attributes: underline, highlight color, and reversal color.
1828         /// The attrs list can be empty if no attributes to set.
1829         /// </param>
1830         /// <exception cref="InvalidOperationException">
1831         /// This can occur due to the following reasons:
1832         /// 1) The application does not have the privilege to call this function.
1833         /// 2) The IME main loop has not started yet.
1834         /// 3) Invalid parameter.
1835         /// </exception>
1836         /// <since_tizen> 4 </since_tizen>
1837         public static void UpdatePreEditString(string str, IEnumerable<PreEditAttribute> attrs)
1838         {
1839             IntPtr einaList = IntPtr.Zero;
1840             List<GCHandle> attributeHandleList = new List<GCHandle>();
1841             foreach (PreEditAttribute attribute in attrs)
1842             {
1843                 ImePreEditAttributeStruct imePreEditAttribute = new ImePreEditAttributeStruct();
1844                 imePreEditAttribute.start = attribute.Start;
1845                 imePreEditAttribute.length = attribute.Length;
1846                 imePreEditAttribute.type = (int)attribute.Type;
1847                 imePreEditAttribute.value = attribute.Value;
1848                 GCHandle attributeHandle = GCHandle.Alloc(imePreEditAttribute, GCHandleType.Pinned);
1849                 attributeHandleList.Add(attributeHandle);
1850                 einaList = Interop.EinaList.EinaListAppend(einaList, attributeHandle.AddrOfPinnedObject());
1851             }
1852             ErrorCode error = ImeUpdatePreeditString(str, einaList);
1853             foreach (GCHandle handle in attributeHandleList)
1854             {
1855                 handle.Free();
1856             }
1857             if (error != ErrorCode.None)
1858             {
1859                 Log.Error(LogTag, "UpdatePreEditString Failed with error " + error);
1860                 throw InputMethodExceptionFactory.CreateException(error);
1861             }
1862         }
1863
1864         /// <summary>
1865         /// Requests the surrounding text from the position of the cursor, asynchronously.
1866         /// </summary>
1867         /// <privilege>
1868         /// http://tizen.org/privilege/ime
1869         /// </privilege>
1870         /// <param name="maxLenBefore">The maximum length of the string to be retrieved before the cursor, -1 means unlimited.</param>
1871         /// <param name="maxLenAfter">The maximum length of the string to be retrieved after the cursor, -1 means unlimited.</param>
1872         /// <exception cref="InvalidOperationException">
1873         /// This can occur due to the following reasons:
1874         /// 1) The application does not have the privilege to call this function.
1875         /// 2) The IME main loop has not started yet.
1876         /// </exception>
1877         /// <postcondition>
1878         /// The requested surrounding text can be received using the SurroundingTextUpdated event, only if it is set.
1879         /// </postcondition>
1880         /// <since_tizen> 4 </since_tizen>
1881         public static void RequestSurroundingText(int maxLenBefore, int maxLenAfter)
1882         {
1883             ErrorCode error = ImeRequestSurroundingText(maxLenBefore, maxLenAfter);
1884             if (error != ErrorCode.None)
1885             {
1886                 Log.Error(LogTag, "RequestSurroundingText Failed with error " + error);
1887                 throw InputMethodExceptionFactory.CreateException(error);
1888             }
1889         }
1890
1891         /// <summary>
1892         /// Requests to delete the surrounding text.
1893         /// </summary>
1894         /// <privilege>
1895         /// http://tizen.org/privilege/ime
1896         /// </privilege>
1897         /// <param name="offset">The offset value from the cursor position.</param>
1898         /// <param name="len">The length of the text to delete.</param>
1899         /// <exception cref="InvalidOperationException">
1900         /// This can occur due to the following reasons:
1901         /// 1) The application does not have the privilege to call this function.
1902         /// 2) The IME main loop has not started yet.
1903         /// 3) Invalid parameter.
1904         /// </exception>
1905         /// <since_tizen> 4 </since_tizen>
1906         public static void DeleteSurroundingText(int offset, int len)
1907         {
1908             ErrorCode error = ImeDeleteSurroundingText(offset, len);
1909             if (error != ErrorCode.None)
1910             {
1911                 Log.Error(LogTag, "DeleteSurroundingText Failed with error " + error);
1912                 throw InputMethodExceptionFactory.CreateException(error);
1913             }
1914         }
1915
1916         /// <summary>
1917         /// Gets the surrounding text from the position of the cursor, synchronously.
1918         /// </summary>
1919         /// <privilege>
1920         /// http://tizen.org/privilege/ime
1921         /// </privilege>
1922         /// <param name="maxLenBefore">The maximum length of the string to be retrieved before the cursor, -1 means unlimited.</param>
1923         /// <param name="maxLenAfter">The maximum length of the string to be retrieved after the cursor, -1 means unlimited.</param>
1924         /// <param name="text">The surrounding text.</param>
1925         /// <param name="cursorPosition">The cursor position.</param>
1926         /// <exception cref="InvalidOperationException">
1927         /// This can occur due to the following reasons:
1928         /// 1) The application does not have the privilege to call this function.
1929         /// 2) The IME main loop has not started yet.
1930         /// 3) Invalid parameter.
1931         /// 4) Failed to obtain text due to out of memory.
1932         /// </exception>
1933         /// <since_tizen> 4 </since_tizen>
1934         public static void GetSurroundingText(int maxLenBefore, int maxLenAfter, out string text, out int cursorPosition)
1935         {
1936             IntPtr txt;
1937             ErrorCode error = ImeGetSurroundingText(maxLenBefore, maxLenAfter, out txt, out cursorPosition);
1938             if (error != ErrorCode.None)
1939             {
1940                 Log.Error(LogTag, "GetSurroundingText Failed with error " + error);
1941                 throw InputMethodExceptionFactory.CreateException(error);
1942             }
1943             text = Marshal.PtrToStringAnsi(txt);
1944         }
1945
1946         /// <summary>
1947         /// Requests to set the selection.
1948         /// </summary>
1949         /// <privilege>
1950         /// http://tizen.org/privilege/ime
1951         /// </privilege>
1952         /// <param name="start">The start cursor position in text (in characters not bytes).</param>
1953         /// <param name="end">The end cursor position in text (in characters not bytes).</param>
1954         /// <exception cref="InvalidOperationException">
1955         /// This can occur due to the following reasons:
1956         /// 1) The application does not have the privilege to call this function.
1957         /// 2) The IME main loop has not started yet.
1958         /// 3) Invalid parameter.
1959         /// </exception>
1960         /// <since_tizen> 4 </since_tizen>
1961         public static void SetSelection(int start, int end)
1962         {
1963             ErrorCode error = ImeSetSelection(start, end);
1964             if (error != ErrorCode.None)
1965             {
1966                 Log.Error(LogTag, "SetSelection Failed with error " + error);
1967                 throw InputMethodExceptionFactory.CreateException(error);
1968             }
1969         }
1970
1971         /// <summary>
1972         /// This API returns the input panel main window.
1973         /// </summary>
1974         /// <privilege>
1975         /// http://tizen.org/privilege/ime
1976         /// </privilege>
1977         /// <returns>The input panel main window object on success, otherwise null.</returns>
1978         /// <exception cref="InvalidOperationException">
1979         /// This can occur due to the following reasons:
1980         /// 1) The application does not have the privilege to call this function.
1981         /// 2) The IME main loop has not started yet.
1982         /// 3) Operation failed.
1983         /// </exception>
1984         /// <since_tizen> 4 </since_tizen>
1985         public static EditorWindow GetMainWindow()
1986         {
1987             EditorWindow._handle = ImeGetMainWindow();
1988             EditorWindow obj = new EditorWindow();
1989             ErrorCode error = (ErrorCode)Tizen.Internals.Errors.ErrorFacts.GetLastResult();
1990             if (error != ErrorCode.None)
1991             {
1992                 Log.Error(LogTag, "GetMainWindow Failed with error " + error);
1993                 throw InputMethodExceptionFactory.CreateException(error);
1994             }
1995             return obj;
1996         }
1997
1998         /// <summary>
1999         /// Sends the request to hide the IME.
2000         /// </summary>
2001         /// <privilege>
2002         /// http://tizen.org/privilege/ime
2003         /// </privilege>
2004         /// <exception cref="InvalidOperationException">
2005         /// This can occur due to the following reasons:
2006         /// 1) The application does not have the privilege to call this function.
2007         /// 2) The IME main loop has not started yet.
2008         /// </exception>
2009         /// <since_tizen> 5 </since_tizen>
2010         public static void RequestHide()
2011         {
2012             ErrorCode error = ImeRequestHide();
2013             if (error != ErrorCode.None)
2014             {
2015                 Log.Error(LogTag, "RequestHide Failed with error " + error);
2016                 throw InputMethodExceptionFactory.CreateException(error);
2017             }
2018         }
2019
2020         /// <summary>
2021         /// This API requests the InputMethodEditor to initialize.
2022         /// </summary>
2023         /// <privilege>
2024         /// http://tizen.org/privilege/ime
2025         /// </privilege>
2026         /// <exception cref="InvalidOperationException">
2027         /// This can occur due to the following reasons:
2028         /// 1) The application does not have the privilege to call this function.
2029         /// 2) Operation failed.
2030         /// </exception>
2031         /// <since_tizen> 4 </since_tizen>
2032         [EditorBrowsable(EditorBrowsableState.Never)]
2033         public static void Create()
2034         {
2035             ErrorCode error = ImeInitialize();
2036             Log.Info(LogTag, "ImeInitialize result : " + error);
2037             if (error != ErrorCode.None)
2038             {
2039                 Log.Error(LogTag, "ImeInitialize Failed with error " + error);
2040                 throw InputMethodExceptionFactory.CreateException(error);
2041             }
2042
2043             error = ImePrepare();
2044             Log.Info(LogTag, "ImePrepare result : " + error);
2045             if (error != ErrorCode.None)
2046             {
2047                 Log.Error(LogTag, "ImePrepare Failed with error " + error);
2048                 throw InputMethodExceptionFactory.CreateException(error);
2049             }
2050         }
2051
2052         /// <summary>
2053         /// This API requests the InputMethodEditor to finalize.
2054         /// </summary>
2055         /// <privilege>
2056         /// http://tizen.org/privilege/ime
2057         /// </privilege>
2058         /// <exception cref="InvalidOperationException">
2059         /// This can occur due to the following reasons:
2060         /// 1) The application does not have the privilege to call this function.
2061         /// 2) Operation failed.
2062         /// </exception>
2063         /// <since_tizen> 4 </since_tizen>
2064         [EditorBrowsable(EditorBrowsableState.Never)]
2065         public static void Destroy()
2066         {
2067             ErrorCode error = ImeFinalize();
2068             Log.Info(LogTag, "ImeFinalize result : " + error);
2069             if (error != ErrorCode.None)
2070             {
2071                 Log.Error(LogTag, "ImeFinalize Failed with error " + error);
2072                 throw InputMethodExceptionFactory.CreateException(error);
2073             }
2074         }
2075
2076         /// <summary>
2077         /// Sets the floating mode to on or off.
2078         /// </summary>
2079         /// <privilege>
2080         /// http://tizen.org/privilege/ime
2081         /// </privilege>
2082         /// <param name="floatingMode"><c>true</c> to set the floating mode to on and <c>false</c> to set it to off.</param>
2083         /// <exception cref="InvalidOperationException">
2084         /// This can occur due to the following reasons:
2085         /// 1) The application does not have the privilege to call this function.
2086         /// 2) The IME main loop has not started yet.
2087         /// </exception>
2088         /// <since_tizen> 5 </since_tizen>
2089         public static void SetFloatingMode(bool floatingMode)
2090         {
2091             ErrorCode error = ImeSetFloatingMode(floatingMode);
2092             if (error != ErrorCode.None)
2093             {
2094                 Log.Error(LogTag, "SetFloatingMode Failed with error " + error);
2095                 throw InputMethodExceptionFactory.CreateException(error);
2096             }
2097         }
2098
2099         /// <summary>
2100         /// Allows the floating input panel window to move along with the mouse pointer when the mouse is pressed.
2101         /// </summary>
2102         /// <privilege>
2103         /// http://tizen.org/privilege/ime
2104         /// </privilege>
2105         /// <remarks>
2106         /// This function can be used in floating mode. If the floating mode is deactivated, calling this function has no effect.
2107         /// </remarks>
2108         /// <exception cref="InvalidOperationException">
2109         /// This can occur due to the following reasons:
2110         /// 1) The application does not have the privilege to call this function.
2111         /// 2) The IME main loop has not started yet.
2112         /// </exception>
2113         /// <since_tizen> 5 </since_tizen>
2114         public static void SetFloatingDragStart()
2115         {
2116             ErrorCode error = ImeSetFloatingDragStart();
2117             if (error != ErrorCode.None)
2118             {
2119                 Log.Error(LogTag, "SetFloatingDragStart Failed with error " + error);
2120                 throw InputMethodExceptionFactory.CreateException(error);
2121             }
2122         }
2123
2124         /// <summary>
2125         /// Does not allow the movement of the floating input panel window with the mouse pointer when the mouse is pressed.
2126         /// </summary>
2127         /// <privilege>
2128         /// http://tizen.org/privilege/ime
2129         /// </privilege>
2130         /// <remarks>
2131         /// This function can be used in floating mode. If the floating mode is deactivated, calling this function has no effect.
2132         /// </remarks>
2133         /// <exception cref="InvalidOperationException">
2134         /// This can occur due to the following reasons:
2135         /// 1) The application does not have the privilege to call this function.
2136         /// 2) The IME main loop has not started yet.
2137         /// </exception>
2138         /// <since_tizen> 5 </since_tizen>
2139         public static void SetFloatingDragEnd()
2140         {
2141             ErrorCode error = ImeSetFloatingDragEnd();
2142             if (error != ErrorCode.None)
2143             {
2144                 Log.Error(LogTag, "SetFloatingDragEnd Failed with error " + error);
2145                 throw InputMethodExceptionFactory.CreateException(error);
2146             }
2147         }
2148
2149         /// <summary>
2150         /// Notifies the changed language of the input panel to the the associated text input UI control.
2151         /// </summary>
2152         /// <privilege>
2153         /// http://tizen.org/privilege/ime
2154         /// </privilege>
2155         /// <remarks>
2156         /// LanguageRequestedCallback is raised after this API is called when the App requests changed language information.
2157         /// </remarks>
2158         /// <exception cref="InvalidOperationException">
2159         /// This can occur due to the following reasons:
2160         /// 1) The application does not have the privilege to call this function.
2161         /// 2) The IME main loop has not started yet.
2162         /// </exception>
2163         /// <since_tizen> 6 </since_tizen>
2164         public static void SendLanguageUpdated()
2165         {
2166             ErrorCode error = ImeUpdateInputPanelEvent(ImeEventType.Language, 0);
2167             if (error != ErrorCode.None)
2168             {
2169                 Log.Error(LogTag, "SendLanguageUpdated Failed with error " + error);
2170                 throw InputMethodExceptionFactory.CreateException(error);
2171             }
2172         }
2173
2174         /// <summary>
2175         /// Sends the changed shift mode of the input panel to the the associated text input UI control.
2176         /// </summary>
2177         /// <privilege>
2178         /// http://tizen.org/privilege/ime
2179         /// </privilege>
2180         /// <param name="enable"><c>true</c> if shift button is clicked, otherwise <c>false</c>.</param>
2181         /// <exception cref="InvalidOperationException">
2182         /// This can occur due to the following reasons:
2183         /// 1) The application does not have the privilege to call this function.
2184         /// 2) The IME main loop has not started yet.
2185         /// </exception>
2186         /// <since_tizen> 6 </since_tizen>
2187         public static void SendShiftModeUpdated(bool enable)
2188         {
2189             ErrorCode error = ImeUpdateInputPanelEvent(ImeEventType.ShiftMode, enable ? (uint)ImeShiftMode.On : (uint)ImeShiftMode.Off);
2190             if (error != ErrorCode.None)
2191             {
2192                 Log.Error(LogTag, "SendInputPanelEvent Failed with error " + error);
2193                 throw InputMethodExceptionFactory.CreateException(error);
2194             }
2195         }
2196
2197         /// <summary>
2198         /// Notifies the changed geometry of input panel window to the associated text input UI control.
2199         /// </summary>
2200         /// <privilege>
2201         /// http://tizen.org/privilege/ime
2202         /// </privilege>
2203         /// <exception cref="InvalidOperationException">
2204         /// This can occur due to the following reasons:
2205         /// 1) The application does not have the privilege to call this function.
2206         /// 2) The IME main loop has not started yet.
2207         /// </exception>
2208         /// <since_tizen> 6 </since_tizen>
2209         public static void SendCustomGeometryUpdated()
2210         {
2211             ErrorCode error = ImeUpdateInputPanelEvent(ImeEventType.Geometry, 0);
2212             if (error != ErrorCode.None)
2213             {
2214                 Log.Error(LogTag, "SendCustomGeometryUpdated Failed with error " + error);
2215                 throw InputMethodExceptionFactory.CreateException(error);
2216             }
2217         }
2218
2219         /// <summary>
2220         /// Gets the selected text synchronously.
2221         /// </summary>
2222         /// <privilege>
2223         /// http://tizen.org/privilege/ime
2224         /// </privilege>
2225         /// <returns>The selected text.</returns>
2226         /// <exception cref="InvalidOperationException">
2227         /// This can occur due to the following reasons:
2228         /// 1) The application does not have the privilege to call this function.
2229         /// 2) The IME main loop has not started yet.
2230         /// 3) Invalid parameter.
2231         /// </exception>
2232         /// <since_tizen> 6 </since_tizen>
2233         public static string GetSelectedText()
2234         {
2235             IntPtr txt;
2236             ErrorCode error = ImeGetSelectedText(out txt);
2237             if (error != ErrorCode.None)
2238             {
2239                 Log.Error(LogTag, "GetSelectedText Failed with error " + error);
2240                 throw InputMethodExceptionFactory.CreateException(error);
2241             }
2242             return Marshal.PtrToStringAnsi(txt);
2243         }
2244
2245         /// <summary>
2246         /// Called to set the prediction hint string to deliver to the input panel.
2247         /// </summary>
2248         /// <since_tizen> 6 </since_tizen>
2249         public static event EventHandler<PredictionHintUpdatedEventArgs> PredictionHintUpdated
2250         {
2251             add
2252             {
2253                 lock (thisLock)
2254                 {
2255                     if (_imePredictionHintSetDelegate == null)
2256                     {
2257                         _imePredictionHintSetDelegate = (IntPtr predictionHint, IntPtr userData) =>
2258                         {
2259                             PredictionHintUpdatedEventArgs args = new PredictionHintUpdatedEventArgs(Marshal.PtrToStringAnsi(predictionHint));
2260                             _predictionHintUpdated?.Invoke(null, args);
2261                         };
2262                         ErrorCode error = ImeEventSetPredictionHintSetCb(_imePredictionHintSetDelegate, IntPtr.Zero);
2263                         if (error != ErrorCode.None)
2264                         {
2265                             Log.Error(LogTag, "Add PredictionHintUpdated Failed with error " + error);
2266                         }
2267                     }
2268                     _predictionHintUpdated += value;
2269                 }
2270             }
2271             remove
2272             {
2273                 lock (thisLock)
2274                 {
2275                     _predictionHintUpdated -= value;
2276                 }
2277             }
2278         }
2279
2280         /// <summary>
2281         /// Called to set the prediction hint key and value to deliver to the input panel.
2282         /// </summary>
2283         /// <since_tizen> 6 </since_tizen>
2284         public static event EventHandler<PredictionHintDataUpdatedEventArgs> PredictionHintDataUpdated
2285         {
2286             add
2287             {
2288                 lock (thisLock)
2289                 {
2290                     if (_imePredictionHintDataSetDelegate == null)
2291                     {
2292                         _imePredictionHintDataSetDelegate = (IntPtr key, IntPtr keyValue, IntPtr userData) =>
2293                         {
2294                             PredictionHintDataUpdatedEventArgs args = new PredictionHintDataUpdatedEventArgs(Marshal.PtrToStringAnsi(key), Marshal.PtrToStringAnsi(keyValue));
2295                             _predictionHintDataUpdated?.Invoke(null, args);
2296                         };
2297
2298                         ErrorCode error = ImeEventSetPredictionHintDataSetCb(_imePredictionHintDataSetDelegate, IntPtr.Zero);
2299                         if (error != ErrorCode.None)
2300                         {
2301                             Log.Error(LogTag, "Add PredictionHintDataUpdated Failed with error " + error);
2302                         }
2303                     }
2304                     _predictionHintDataUpdated += value;
2305                 }
2306             }
2307             remove
2308             {
2309                 lock (thisLock)
2310                 {
2311                     _predictionHintDataUpdated -= value;
2312                 }
2313             }
2314         }
2315
2316         /// <summary>
2317         /// Called when an associated text input UI control requests the text entry to set the MIME type.
2318         /// </summary>
2319         /// <since_tizen> 6 </since_tizen>
2320         public static event EventHandler<MimeTypeUpdateRequestedEventArgs> MimeTypeUpdateRequested
2321         {
2322             add
2323             {
2324                 lock (thisLock)
2325                 {
2326                     if (_imeMimeTypeSetRequestDelegate == null)
2327                     {
2328                         _imeMimeTypeSetRequestDelegate = (IntPtr mimeType, IntPtr userData) =>
2329                         {
2330                             MimeTypeUpdateRequestedEventArgs args = new MimeTypeUpdateRequestedEventArgs(Marshal.PtrToStringAnsi(mimeType));
2331                             _mimeTypeUpdateRequested?.Invoke(null, args);
2332                         };
2333                         ErrorCode error = ImeEventSetMimeTypeSetRequestCb(_imeMimeTypeSetRequestDelegate, IntPtr.Zero);
2334                         if (error != ErrorCode.None)
2335                         {
2336                             Log.Error(LogTag, "Add MimeTypeUpdateRequested Failed with error " + error);
2337                         }
2338                     }
2339                     _mimeTypeUpdateRequested += value;
2340                 }
2341             }
2342             remove
2343             {
2344                 lock (thisLock)
2345                 {
2346                     _mimeTypeUpdateRequested -= value;
2347                 }
2348             }
2349         }
2350
2351         /// <summary>
2352         /// Sends a private command to the associated text input UI control.
2353         /// </summary>
2354         /// <privilege>
2355         /// http://tizen.org/privilege/ime
2356         /// </privilege>
2357         /// <param name="command">The UTF-8 string to be sent.</param>
2358         /// <exception cref="InvalidOperationException">
2359         /// This can occur due to the following reasons:
2360         /// 1) The application does not have the privilege to call this function.
2361         /// 2) The IME main loop has not started yet.
2362         /// 3) Invalid parameter.
2363         /// </exception>
2364         /// <since_tizen> 6 </since_tizen>
2365         public static void SendPrivateCommand(string command)
2366         {
2367             ErrorCode error = ImeSendPrivateCommand(command);
2368             if (error != ErrorCode.None)
2369             {
2370                 Log.Error(LogTag, "SendPrivateCommand Failed with error " + error);
2371                 throw InputMethodExceptionFactory.CreateException(error);
2372             }
2373         }
2374
2375         /// <summary>
2376         /// Commits contents such as image to the associated text input UI control.
2377         /// </summary>
2378         /// <privilege>
2379         /// http://tizen.org/privilege/ime
2380         /// </privilege>
2381         /// <param name="content">The content URI to be sent.</param>
2382         /// <param name="description">The content description.</param>
2383         /// <param name="mimeType">The MIME type received from the MimeTypeSetRequest</param>
2384         /// <exception cref="InvalidOperationException">
2385         /// This can occur due to the following reasons:
2386         /// 1) The application does not have the privilege to call this function.
2387         /// 2) The IME main loop has not started yet.
2388         /// 3) Invalid parameter.
2389         /// </exception>
2390         /// <since_tizen> 6 </since_tizen>
2391         public static void CommitContent(string content, string description, string mimeType)
2392         {
2393             ErrorCode error = ImeCommitContent(content, description, mimeType);
2394             if (error != ErrorCode.None)
2395             {
2396                 Log.Error(LogTag, "CommitContent Failed with error " + error);
2397                 throw InputMethodExceptionFactory.CreateException(error);
2398             }
2399         }
2400     }
2401 }