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