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

   1 #ifndef __DALI_KEY_H__
   2 #define __DALI_KEY_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 Mapping of 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,
  40   DALI_KEY_ESCAPE           = 9,
  41   DALI_KEY_BACKSPACE        = 22,
  42   DALI_KEY_SHIFT_LEFT       = 50,
  43   DALI_KEY_SHIFT_RIGHT      = 62,
  44   DALI_KEY_CURSOR_UP        = 111,
  45   DALI_KEY_CURSOR_LEFT      = 113,
  46   DALI_KEY_CURSOR_RIGHT     = 114,
  47   DALI_KEY_CURSOR_DOWN      = 116,
  48   DALI_KEY_BACK             = 166,
  49   DALI_KEY_CAMERA           = 167,
  50   DALI_KEY_CONFIG           = 168,
  51   DALI_KEY_POWER            = 169,
  52   DALI_KEY_PAUSE            = 170,
  53   DALI_KEY_CANCEL           = 171,
  54   DALI_KEY_PLAY_CD          = 172,
  55   DALI_KEY_STOP_CD          = 173,
  56   DALI_KEY_PAUSE_CD         = 174,
  57   DALI_KEY_NEXT_SONG        = 175,
  58   DALI_KEY_PREVIOUS_SONG    = 176,
  59   DALI_KEY_REWIND           = 177,
  60   DALI_KEY_FASTFORWARD      = 178,
  61   DALI_KEY_MEDIA            = 179,
  62   DALI_KEY_PLAY_PAUSE       = 180,
  63   DALI_KEY_MUTE             = 181,
  64   DALI_KEY_MENU             = 182,
  65   DALI_KEY_HOME             = 183,
  66   DALI_KEY_HOMEPAGE         = 187,
  67   DALI_KEY_WEBPAGE          = 188,
  68   DALI_KEY_MAIL             = 189,
  69   DALI_KEY_SCREENSAVER      = 190,
  70   DALI_KEY_BRIGHTNESS_UP    = 191,
  71   DALI_KEY_BRIGHTNESS_DOWN  = 192,
  72   DALI_KEY_SOFT_KBD         = 193,
  73   DALI_KEY_QUICK_PANEL      = 194,
  74   DALI_KEY_TASK_SWITCH      = 195,
  75   DALI_KEY_APPS             = 196,
  76   DALI_KEY_SEARCH           = 197,
  77   DALI_KEY_VOICE            = 198,
  78   DALI_KEY_LANGUAGE         = 199,
  79   DALI_KEY_VOLUME_UP        = 200,
  80   DALI_KEY_VOLUME_DOWN      = 201
  81 };
  82
  83 /**
  84  * @brief Check if a key event is for a specific DALI KEY.
  85  *
  86  * @SINCE_1_0.0
  87  * @param keyEvent reference to a keyEvent structure
  88  * @param daliKey dali key enum
  89  * @return true if the key is matched, false if not
  90  */
  91 DALI_IMPORT_API bool IsKey( const KeyEvent& keyEvent, KEY daliKey);
  92
  93 /**
  94  * @}
  95  */
  96 } // namespace Dali
  97
  98 #endif // __DALI_KEY_H__