adaptors/public-api/adaptor-framework/key.h

   1 #ifndef __DALI_KEY_H__
   2 #define __DALI_KEY_H__
   3
   4 /*
   5  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22
  23 #include <dali/public-api/events/key-event.h>
  24
  25 namespace Dali
  26 {
  27 /**
  28  * @addtogroup dali_adaptor_framework
  29  * @{
  30  */
  31
  32 /**
  33  * @brief Enumeration for mapping keyboard and mouse button event keycodes to platform specific codes.
  34  * @SINCE_1_0.0
  35  */
  36
  37 enum KEY
  38 {
  39   DALI_KEY_INVALID       = -1,       ///< Invalid key value @SINCE_1_0.0
  40   DALI_KEY_ESCAPE      = 9,        ///< Escape key @SINCE_1_0.0
  41   DALI_KEY_BACKSPACE     = 22,       ///< Backspace key @SINCE_1_0.0
  42   DALI_KEY_SHIFT_LEFT     = 50,       ///< Shift Left key @SINCE_1_0.0
  43   DALI_KEY_SHIFT_RIGHT     = 62,       ///< Shift Right key @SINCE_1_0.0
  44   DALI_KEY_CURSOR_UP     = 111,      ///< Cursor up key @SINCE_1_0.0
  45   DALI_KEY_CURSOR_LEFT     = 113,      ///< Cursor left key @SINCE_1_0.0
  46   DALI_KEY_CURSOR_RIGHT     = 114,      ///< Cursor right key @SINCE_1_0.0
  47   DALI_KEY_CURSOR_DOWN     = 116,      ///< Cursor down key @SINCE_1_0.0
  48   DALI_KEY_BACK       = 166,      ///< Back key @SINCE_1_0.0
  49   DALI_KEY_CAMERA      = 167,      ///< Camera key @SINCE_1_0.0
  50   DALI_KEY_CONFIG      = 168,      ///< Config key @SINCE_1_0.0
  51   DALI_KEY_POWER      = 169,      ///< Power key @SINCE_1_0.0
  52   DALI_KEY_PAUSE      = 170,      ///< Pause key @SINCE_1_0.0
  53   DALI_KEY_CANCEL      = 171,      ///< Cancel key @SINCE_1_0.0
  54   DALI_KEY_PLAY_CD      = 172,      ///< Play CD key @SINCE_1_0.0
  55   DALI_KEY_STOP_CD      = 173,      ///< Stop CD key @SINCE_1_0.0
  56   DALI_KEY_PAUSE_CD      = 174,      ///< Pause CD key @SINCE_1_0.0
  57   DALI_KEY_NEXT_SONG     = 175,      ///< Next song key @SINCE_1_0.0
  58   DALI_KEY_PREVIOUS_SONG    = 176,      ///< Previous song key @SINCE_1_0.0
  59   DALI_KEY_REWIND      = 177,      ///< Rewind key @SINCE_1_0.0
  60   DALI_KEY_FASTFORWARD     = 178,      ///< Fastforward key @SINCE_1_0.0
  61   DALI_KEY_MEDIA      = 179,      ///< Media key @SINCE_1_0.0
  62   DALI_KEY_PLAY_PAUSE     = 180,      ///< Play pause key @SINCE_1_0.0
  63   DALI_KEY_MUTE       = 181,      ///< Mute key @SINCE_1_0.0
  64   DALI_KEY_MENU       = 182,      ///< Menu key @SINCE_1_0.0
  65   DALI_KEY_HOME       = 183,      ///< Home key @SINCE_1_0.0
  66   DALI_KEY_HOMEPAGE      = 187,      ///< Homepage key @SINCE_1_0.0
  67   DALI_KEY_WEBPAGE      = 188,      ///< Webpage key @SINCE_1_0.0
  68   DALI_KEY_MAIL       = 189,      ///< Mail key @SINCE_1_0.0
  69   DALI_KEY_SCREENSAVER     = 190,      ///< Screensaver key @SINCE_1_0.0
  70   DALI_KEY_BRIGHTNESS_UP    = 191,      ///< Brightness up key @SINCE_1_0.0
  71   DALI_KEY_BRIGHTNESS_DOWN    = 192,      ///< Brightness down key @SINCE_1_0.0
  72   DALI_KEY_SOFT_KBD      = 193,      ///< Soft KBD key @SINCE_1_0.0
  73   DALI_KEY_QUICK_PANEL     = 194,      ///< Quick panel key @SINCE_1_0.0
  74   DALI_KEY_TASK_SWITCH     = 195,      ///< Task switch key @SINCE_1_0.0
  75   DALI_KEY_APPS       = 196,      ///< Apps key @SINCE_1_0.0
  76   DALI_KEY_SEARCH      = 197,      ///< Search key @SINCE_1_0.0
  77   DALI_KEY_VOICE      = 198,      ///< Voice key @SINCE_1_0.0
  78   DALI_KEY_LANGUAGE    = 199,      ///< Language key @SINCE_1_0.0
  79   DALI_KEY_VOLUME_UP      = 200,      ///< Volume up key @SINCE_1_0.0
  80   DALI_KEY_VOLUME_DOWN    = 201,       ///< Volume down key @SINCE_1_0.0
  81   DALI_KEY_1       = 10,
  82   DALI_KEY_2       = 11,
  83   DALI_KEY_3       = 12,
  84   DALI_KEY_4       = 13,
  85   DALI_KEY_5       = 14,
  86   DALI_KEY_6       = 15,
  87   DALI_KEY_7       = 16,
  88   DALI_KEY_8       = 17,
  89   DALI_KEY_9       = 18,
  90   DALI_KEY_0       = 19,
  91   DALI_KEY_MINUS      = 20,
  92   DALI_KEY_OK       = 36,
  93   DALI_KEY_RED       = 67,
  94   DALI_KEY_GREEN      = 68,
  95   DALI_KEY_YELLOW      = 69,
  96   DALI_KEY_BLUE       = 70,
  97   DALI_KEY_SOURCE      = 72,
  98   DALI_KEY_CH_LIST      = 73,
  99   DALI_KEY_LSGT       = 94,
 100   DALI_KEY_CHDOWN      = 95,
 101   DALI_KEY_CHUP       = 96,
 102   DALI_KEY_LFD_POWEROFF     = 120,
 103   DALI_KEY_LFD_MAGICINFO    = 128,
 104   DALI_KEY_SYS_MENU      = 133,
 105   DALI_KEY_TOOLS      = 135,
 106   DALI_KEY_REPEAT      = 137,
 107   DALI_KEY_GUIDE      = 138,
 108   DALI_KEY_ASPECT      = 140,
 109   DALI_KEY_PMODE      = 141,
 110   DALI_KEY_HDMI       = 143,
 111   DALI_KEY_USBHUB_SWITCH    = 144,
 112   DALI_KEY_EMANUAL      = 146,
 113   DALI_KEY_LFD_LOCK      = 147,
 114   DALI_KEY_MORE       = 148,
 115   DALI_KEY_FACTORY      = 149,
 116   DALI_KEY_SLEEP      = 150,
 117   DALI_KEY_TV       = 153,
 118   DALI_KEY_DTV       = 154,
 119   DALI_KEY_STB_POWER     = 155,
 120   DALI_KEY_ADDDEL      = 156,
 121   DALI_KEY_PANEL_DOWN     = 157,
 122   DALI_KEY_BT_COLOR_MECHA    = 159,
 123   DALI_KEY_STILL_PICTURE    = 160,
 124   DALI_KEY_BT_TRIGGER     = 161,
 125   DALI_KEY_BT_HOTKEY     = 162,
 126   DALI_KEY_CINEMA_MODE     = 163,
 127   DALI_KEY_BT_CONTENTSBAR    = 164,
 128   DALI_KEY_GAME       = 165,
 129   DALI_KEY_MBR_STB_GUIDE    = 184,
 130   DALI_KEY_MBR_BD_POPUP     = 185,
 131   DALI_KEY_MBR_BDDVD_POWER    = 186,
 132   DALI_KEY_WIFI_PAIRING     = 202,
 133   DALI_KEY_BT_DUALVIEW     = 210,
 134   DALI_KEY_BT_SAMSUNG_APPS    = 211,
 135   DALI_KEY_FAMILY_MODE     = 212,
 136   DALI_KEY_ESAVING      = 213,
 137   DALI_KEY_CLEAR      = 214,
 138   DALI_KEY_SUB_TITLE     = 215,
 139   DALI_KEY_TV_SNS      = 217,
 140   DALI_KEY_DVR       = 218,
 141   DALI_KEY_CAPTION      = 221,
 142   DALI_KEY_ZOOM1      = 222,
 143   DALI_KEY_PANEL_PLUS     = 223,
 144   DALI_KEY_BT_VOICE      = 224,
 145   DALI_KEY_PANEL_MINUS     = 227,
 146   DALI_KEY_SOCCER_MODE     = 228,
 147   DALI_KEY_FUNCTIONS_AMAZON    = 229,
 148   DALI_KEY_AD       = 230,
 149   DALI_KEY_REWIND_      = 232,
 150   DALI_KEY_FF_       = 233,
 151   DALI_KEY_FUNCTIONS_NETFLIX   = 234,
 152   DALI_KEY_PIP_ONOFF     = 235,
 153   DALI_KEY_MBR_WATCH_MOVIE    = 236,
 154   DALI_KEY_MBR_STBBD_MENU    = 237,
 155   DALI_KEY_MBR_SETUP_CONFIRM   = 238,
 156   DALI_KEY_FAMILYHUB     = 239,
 157   DALI_KEY_ANYVIEW      = 240,
 158   DALI_KEY_BT_DEVICE     = 241,
 159   DALI_KEY_SOFT_WAKE_UP     = 244,
 160   DALI_KEY_LFD_SET      = 245,
 161   DALI_KEY_WAKE_UP_MODE     = 246,
 162   DALI_KEY_LFD_BLANK     = 247,
 163   DALI_KEY_PAGE_LEFT     = 249,
 164   DALI_KEY_PAGE_RIGHT     = 250,
 165   DALI_KEY_PLAY_BACK     = 252,
 166   DALI_KEY_EXTRA      = 253,
 167   DALI_KEY_DISCRET_POWER_OFF   = 360,
 168   DALI_KEY_DISCRET_POWER_ON    = 361,
 169   DALI_KEY_DISCRET_S_VIDEO1    = 365,
 170   DALI_KEY_DISCRET_S_VIDEO2    = 366,
 171   DALI_KEY_DISCRET_S_VIDEO3    = 367,
 172   DALI_KEY_DISCRET_COMPONENT1   = 368,
 173   DALI_KEY_DISCRET_COMPONENT2   = 369,
 174   DALI_KEY_DISCRET_COMPONENT3   = 370,
 175   DALI_KEY_DISCRET_HDMI1    = 371,
 176   DALI_KEY_DISCRET_HDMI2    = 372,
 177   DALI_KEY_DISCRET_HDMI3    = 373,
 178   DALI_KEY_DISCRET_PC     = 374,
 179   DALI_KEY_DISCRET_DVI1     = 375,
 180   DALI_KEY_DISCRET_DVI2     = 376,
 181   DALI_KEY_DISCRET_ZOOM1    = 377,
 182   DALI_KEY_DISCRET_ZOOM2    = 378,
 183   DALI_KEY_DISCRET_PANORAMA    = 379,
 184   DALI_KEY_DISCRET_4_3     = 380,
 185   DALI_KEY_DISCRET_16_9     = 381,
 186   DALI_KEY_LFD_POWERON     = 382,
 187   DALI_KEY_DISCRET_LFD_DP    = 383,
 188   DALI_KEY_DISCRET_SOURCE_TV   = 384,
 189   DALI_KEY_COLOR      = 385,
 190   DALI_KEY_DISCRET_LFD_HDBT_RX   = 386,
 191   DALI_KEY_DISCRET_LFD_OPS    = 387,
 192   DALI_KEY_DISCRET_HDMI4    = 388,
 193   DALI_KEY_DISCRET_SOURCE_AV1   = 389,
 194   DALI_KEY_DISCRET_SOURCE_AV2   = 390,
 195   DALI_KEY_DISCRET_SOURCE_AV3   = 391,
 196   DALI_KEY_AV_OPEN      = 392,
 197   DALI_KEY_AV_DISC_MENU     = 393,
 198   DALI_KEY_AV_TITLE_MENU    = 394,
 199   DALI_KEY_TEST       = 395,
 200   DALI_KEY_COLD_START     = 396,
 201   DALI_KEY_VERSION      = 397,
 202   DALI_KEY_UNDEFINED     = 398,
 203   DALI_KEY_SCREEN_FREEZE    = 399,
 204   DALI_KEY_SCREEN_MUTE     = 400,
 205   DALI_KEY_LIST_END      = 405,
 206   DALI_KEY_LIST_HOME     = 406,
 207   DALI_KEY_VOICE_CONTROL    = 407,
 208   DALI_KEY_PAGE_UP      = 408,
 209   DALI_KEY_PAGE_DOWN     = 409,
 210   DALI_KEY_MBR_OPTION     = 410,
 211   DALI_KEY_ROOM_CONTROL     = 411,
 212   DALI_KEY_TEMPERATURE_UP    = 412,
 213   DALI_KEY_TEMPERATURE_DOWN    = 413,
 214   DALI_KEY_LIGHT_ON      = 414,
 215   DALI_KEY_LIGHT_OFF     = 415,
 216   DALI_KEY_DO_NOT_DISTURB    = 416,
 217   DALI_KEY_MAKE_UP_ROOM     = 417,
 218   DALI_KEY_ALARM      = 418,
 219   DALI_KEY_FUNC_USB      = 419,
 220   DALI_KEY_FUNC_DIN      = 420,
 221   DALI_KEY_SOUNDEFFECT1     = 421,
 222   DALI_KEY_SOUNDEFFECT2     = 422,
 223   DALI_KEY_SOUNDEFFECT3     = 423,
 224   DALI_KEY_SOUNDEFFECT4     = 424,
 225   DALI_KEY_SOUNDEFFECT5     = 425,
 226   DALI_KEY_SOUNDEFFECT6     = 426,
 227   DALI_KEY_SOUNDEFFECT7     = 427,
 228   DALI_KEY_SOUNDEFFECT8     = 428,
 229   DALI_KEY_SWPLUS      = 429,
 230   DALI_KEY_SWMINUS      = 430,
 231   DALI_KEY_ANYNET      = 431,
 232   DALI_KEY_AUTOPOWER     = 432,
 233   DALI_KEY_SOFTAP      = 433,
 234   DALI_KEY_ADDSPK      = 434,
 235   DALI_KEY_SCRECONNECT     = 435,
 236   DALI_KEY_NETWORKMD     = 436,
 237   DALI_KEY_SURROUNDOFF     = 437,
 238   DALI_KEY_SURROUNDON     = 438,
 239   DALI_KEY_BLUETOOTH     = 439,
 240   DALI_KEY_APDONOFF      = 440,
 241   DALI_KEY_SOUNDCONTROL     = 441,
 242   DALI_KEY_NIGHTMODE     = 442,
 243   DALI_KEY_USEREQ      = 443,
 244   DALI_KEY_EQLEVELDOWN     = 444,
 245   DALI_KEY_EQLEVELUP     = 445,
 246   DALI_KEY_DRCON      = 446,
 247   DALI_KEY_DRCOFF      = 447,
 248   DALI_KEY_SPEAKERLEVEL     = 448,
 249   DALI_KEY_WOOFERRST     = 449,
 250   DALI_KEY_MIRACAST_ON     = 450,
 251   DALI_KEY_MIRACAST_OFF     = 451,
 252   DALI_KEY_FUNC_RADIO     = 452,
 253   DALI_KEY_SOUNDSHARE_RESET    = 453,
 254   DALI_KEY_TOUCHMODE     = 454,
 255   DALI_KEY_GROUP      = 455,
 256   DALI_KEY_UNGROUP      = 456,
 257   DALI_KEY_DEEP_SLEEP     = 457,
 258   DALI_KEY_RM_LOG      = 458,
 259   DALI_KEY_AUX       = 459,
 260   DALI_KEY_EQ       = 460,
 261   DALI_KEY_GIGAEQ      = 461,
 262   DALI_KEY_DJ_BEAT      = 462,
 263   DALI_KEY_PANNING      = 463,
 264   DALI_KEY_MIC_IN      = 464,
 265   DALI_KEY_MIC_OUT      = 465,
 266   DALI_KEY_MIC_VOL_UP     = 466,
 267   DALI_KEY_MIC_VOL_DOWN     = 467,
 268   DALI_KEY_GYRO_A      = 468,
 269   DALI_KEY_GYRO_B      = 469,
 270   DALI_KEY_FANETOK      = 470,
 271   DALI_KEY_QSPOWER      = 471,
 272   DALI_KEY_SHOPMODE      = 472,
 273   DALI_KEY_WIFI_ONOFF     = 473,
 274   DALI_KEY_OPTICAL_DET     = 474,
 275   DALI_KEY_TV_REMOTE     = 475,
 276   DALI_KEY_FUNC_AUX      = 476,
 277   DALI_KEY_CHUP_CARD1     = 477,
 278   DALI_KEY_CHDOWN_CARD1     = 478,
 279   DALI_KEY_CHUP_CARD2     = 479,
 280   DALI_KEY_CHDOWN_CARD2     = 480,
 281   DALI_KEY_VOLUP_BATHROOM    = 481,
 282   DALI_KEY_VOLDOWN_BATHROOM    = 482,
 283   DALI_KEY_SELECT_DEVICE    = 483,
 284   DALI_KEY_SMARTSOUND_ON    = 484,
 285   DALI_KEY_SMARTSOUND_OFF    = 485,
 286   DALI_KEY_BLURAY_4X_FF     = 486,
 287   DALI_KEY_BLURAY_4X_REWIND    = 487,
 288   DALI_KEY_BLURAY_4X_STOP    = 488,
 289   DALI_KEY_DISC_PLAY     = 489,
 290   DALI_KEY_OCF_CONFIRM     = 490,
 291   DALI_KEY_MULTICODE_SET    = 491,
 292   DALI_KEY_MULTICODE_RESET    = 492,
 293   DALI_KEY_HOTEL_MODE_MENU    = 493,
 294   DALI_KEY_HOTEL_MOVIES     = 494,
 295   DALI_KEY_HOTEL_LANGUAGE    = 495,
 296   DALI_KEY_HOTEL_TV_GUIDE    = 496,
 297   DALI_KEY_HOTEL_APPS_GUESTs   = 497,
 298   DALI_KEY_QUICK_MENU     = 498,
 299   DALI_KEY_LFD_UNSET     = 500,
 300   DALI_KEY_PIP_CHUP      = 501,
 301   DALI_KEY_PIP_CHDOWN     = 502,
 302   DALI_KEY_ANTENA      = 503,
 303   DALI_KEY_AUTO_PROGRAM     = 504,
 304   DALI_KEY_PANEL_ENTER     = 505,
 305   DALI_KEY_LINK       = 506,
 306   DALI_KEY_PANEL_UP      = 507,
 307   DALI_KEY_REC       = 508,
 308   DALI_KEY_ANGLE      = 509,
 309   DALI_KEY_WHEEL_LEFT     = 510,
 310   DALI_KEY_WHEEL_RIGHT     = 511,
 311   DALI_KEY_PANEL_EXIT     = 512,
 312   DALI_KEY_EXIT       = 513,
 313   DALI_KEY_MBR_TV      = 514,
 314   DALI_KEY_MBR_SETUP_FAILURE   = 515,
 315   DALI_KEY_MBR_SETUP     = 516,
 316   DALI_KEY_MBR_WATCH_TV     = 517,
 317   DALI_KEY_PRECH      = 518,
 318   DALI_KEY_FAVCH      = 519,
 319   DALI_KEY_RECOMMEND_SEARCH_TOGGLE  = 520,
 320   DALI_KEY_BT_NUMBER     = 521,
 321   DALI_KEY_16_9       = 522,
 322   DALI_KEY_MTS       = 523,
 323   DALI_KEY_INFO       = 524,
 324   DALI_KEY_SMODE      = 525,
 325   DALI_KEY_3SPEED      = 526,
 326   DALI_KEY_3D       = 527,
 327   DALI_KEY_TTX_MIX      = 528,
 328   DALI_KEY_SRSTSXT      = 529,
 329   DALI_KEY_a       = 20000,
 330   DALI_KEY_b       = 20001,
 331   DALI_KEY_c       = 20002,
 332   DALI_KEY_d       = 20003,
 333   DALI_KEY_e       = 20004,
 334   DALI_KEY_f       = 20005,
 335   DALI_KEY_g       = 20006,
 336   DALI_KEY_h       = 20007,
 337   DALI_KEY_i       = 20008,
 338   DALI_KEY_j       = 20009,
 339   DALI_KEY_k       = 30000,
 340   DALI_KEY_l       = 30001,
 341   DALI_KEY_m       = 30002,
 342   DALI_KEY_n       = 30003,
 343   DALI_KEY_o       = 30004,
 344   DALI_KEY_p       = 30005,
 345   DALI_KEY_q       = 30006,
 346   DALI_KEY_r       = 30007,
 347   DALI_KEY_s       = 30008,
 348   DALI_KEY_t       = 30009,
 349   DALI_KEY_u       = 40000,
 350   DALI_KEY_v       = 40001,
 351   DALI_KEY_w       = 40002,
 352   DALI_KEY_x       = 40003,
 353   DALI_KEY_y       = 40004,
 354   DALI_KEY_z       = 40005,
 355   DALI_KEY_A       = 40006,
 356   DALI_KEY_B       = 40007,
 357   DALI_KEY_C       = 40008,
 358   DALI_KEY_D       = 40009,
 359   DALI_KEY_E       = 50000,
 360   DALI_KEY_F       = 50001,
 361   DALI_KEY_G       = 50002,
 362   DALI_KEY_H       = 50003,
 363   DALI_KEY_I       = 50004,
 364   DALI_KEY_J       = 50005,
 365   DALI_KEY_K       = 50006,
 366   DALI_KEY_L       = 50007,
 367   DALI_KEY_M       = 50008,
 368   DALI_KEY_N       = 50009,
 369   DALI_KEY_O       = 60000,
 370   DALI_KEY_P       = 60001,
 371   DALI_KEY_Q       = 60002,
 372   DALI_KEY_R       = 60003,
 373   DALI_KEY_S       = 60004,
 374   DALI_KEY_T       = 60005,
 375   DALI_KEY_U       = 60006,
 376   DALI_KEY_V       = 60007,
 377   DALI_KEY_W       = 60008,
 378   DALI_KEY_X       = 60009,
 379   DALI_KEY_Y       = 70000,
 380   DALI_KEY_Z       = 70001,
 381 };
 382
 383 /**
 384  * @brief Checks if a key event is for a specific DALI KEY.
 385  *
 386  * @SINCE_1_0.0
 387  * @param keyEvent reference to a keyEvent structure
 388  * @param daliKey Dali key enum
 389  * @return @c true if the key is matched, @c false if not
 390  */
 391 DALI_IMPORT_API bool IsKey( const Dali::KeyEvent& keyEvent, Dali::KEY daliKey);
 392
 393 /**
 394  * @}
 395  */
 396 } // namespace Dali
 397
 398 #endif // __DALI_KEY_H__