#define __DALI_KEY_H__
/*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2015 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <dali/public-api/events/key-event.h>
-namespace Dali DALI_IMPORT_API
+namespace Dali
{
-
/**
- * @brief Mapping of keyboard and mouse button event keycodes to platform specific codes.
- *
- * For tizen the X Server Keycode is used as reference, unless it's over ridden
- * in utilX.h in which case the values are based on utilX.h
+ * @addtogroup dali_adaptor_framework
+ * @{
*/
-typedef int KEY;
+/**
+ * @brief Enumeration for mapping keyboard and mouse button event keycodes to platform specific codes.
+ * @SINCE_1_0.0
+ */
-extern const KEY DALI_KEY_INVALID;
-extern const KEY DALI_KEY_ESCAPE;
-extern const KEY DALI_KEY_BACK;
-extern const KEY DALI_KEY_CAMERA;
-extern const KEY DALI_KEY_CONFIG;
-extern const KEY DALI_KEY_POWER;
-extern const KEY DALI_KEY_PAUSE;
-extern const KEY DALI_KEY_CANCEL;
-extern const KEY DALI_KEY_PLAY_CD;
-extern const KEY DALI_KEY_STOP_CD;
-extern const KEY DALI_KEY_PAUSE_CD;
-extern const KEY DALI_KEY_NEXT_SONG;
-extern const KEY DALI_KEY_PREVIOUS_SONG;
-extern const KEY DALI_KEY_REWIND;
-extern const KEY DALI_KEY_FASTFORWARD;
-extern const KEY DALI_KEY_MEDIA;
-extern const KEY DALI_KEY_PLAY_PAUSE;
-extern const KEY DALI_KEY_MUTE;
-extern const KEY DALI_KEY_SEND;
-extern const KEY DALI_KEY_SELECT;
-extern const KEY DALI_KEY_END;
-extern const KEY DALI_KEY_MENU;
-extern const KEY DALI_KEY_HOME;
-extern const KEY DALI_KEY_HOMEPAGE;
-extern const KEY DALI_KEY_WEBPAGE;
-extern const KEY DALI_KEY_MAIL;
-extern const KEY DALI_KEY_SCREENSAVER;
-extern const KEY DALI_KEY_BRIGHTNESS_UP;
-extern const KEY DALI_KEY_BRIGHTNESS_DOWN;
-extern const KEY DALI_KEY_SOFT_KBD;
-extern const KEY DALI_KEY_QUICK_PANEL;
-extern const KEY DALI_KEY_TASK_SWITCH;
-extern const KEY DALI_KEY_APPS;
-extern const KEY DALI_KEY_SEARCH;
-extern const KEY DALI_KEY_VOICE;
-extern const KEY DALI_KEY_LANGUAGE;
-extern const KEY DALI_KEY_VOLUME_UP;
-extern const KEY DALI_KEY_VOLUME_DOWN;
-extern const KEY DALI_KEY_BACKSPACE;
-extern const KEY DALI_KEY_CURSOR_LEFT;
-extern const KEY DALI_KEY_CURSOR_RIGHT;
-extern const KEY DALI_KEY_CURSOR_UP;
-extern const KEY DALI_KEY_CURSOR_DOWN;
+enum KEY
+{
+ DALI_KEY_INVALID = -1, ///< Invalid key value @SINCE_1_0.0
+ DALI_KEY_ESCAPE = 9, ///< Escape key @SINCE_1_0.0
+ DALI_KEY_BACKSPACE = 22, ///< Backspace key @SINCE_1_0.0
+ DALI_KEY_SHIFT_LEFT = 50, ///< Shift Left key @SINCE_1_0.0
+ DALI_KEY_SHIFT_RIGHT = 62, ///< Shift Right key @SINCE_1_0.0
+ DALI_KEY_CURSOR_UP = 111, ///< Cursor up key @SINCE_1_0.0
+ DALI_KEY_CURSOR_LEFT = 113, ///< Cursor left key @SINCE_1_0.0
+ DALI_KEY_CURSOR_RIGHT = 114, ///< Cursor right key @SINCE_1_0.0
+ DALI_KEY_CURSOR_DOWN = 116, ///< Cursor down key @SINCE_1_0.0
+ DALI_KEY_BACK = 166, ///< Back key @SINCE_1_0.0
+ DALI_KEY_CAMERA = 167, ///< Camera key @SINCE_1_0.0
+ DALI_KEY_CONFIG = 168, ///< Config key @SINCE_1_0.0
+ DALI_KEY_POWER = 169, ///< Power key @SINCE_1_0.0
+ DALI_KEY_PAUSE = 170, ///< Pause key @SINCE_1_0.0
+ DALI_KEY_CANCEL = 171, ///< Cancel key @SINCE_1_0.0
+ DALI_KEY_PLAY_CD = 172, ///< Play CD key @SINCE_1_0.0
+ DALI_KEY_STOP_CD = 173, ///< Stop CD key @SINCE_1_0.0
+ DALI_KEY_PAUSE_CD = 174, ///< Pause CD key @SINCE_1_0.0
+ DALI_KEY_NEXT_SONG = 175, ///< Next song key @SINCE_1_0.0
+ DALI_KEY_PREVIOUS_SONG = 176, ///< Previous song key @SINCE_1_0.0
+ DALI_KEY_REWIND = 177, ///< Rewind key @SINCE_1_0.0
+ DALI_KEY_FASTFORWARD = 178, ///< Fastforward key @SINCE_1_0.0
+ DALI_KEY_MEDIA = 179, ///< Media key @SINCE_1_0.0
+ DALI_KEY_PLAY_PAUSE = 180, ///< Play pause key @SINCE_1_0.0
+ DALI_KEY_MUTE = 181, ///< Mute key @SINCE_1_0.0
+ DALI_KEY_MENU = 182, ///< Menu key @SINCE_1_0.0
+ DALI_KEY_HOME = 183, ///< Home key @SINCE_1_0.0
+ DALI_KEY_HOMEPAGE = 187, ///< Homepage key @SINCE_1_0.0
+ DALI_KEY_WEBPAGE = 188, ///< Webpage key @SINCE_1_0.0
+ DALI_KEY_MAIL = 189, ///< Mail key @SINCE_1_0.0
+ DALI_KEY_SCREENSAVER = 190, ///< Screensaver key @SINCE_1_0.0
+ DALI_KEY_BRIGHTNESS_UP = 191, ///< Brightness up key @SINCE_1_0.0
+ DALI_KEY_BRIGHTNESS_DOWN = 192, ///< Brightness down key @SINCE_1_0.0
+ DALI_KEY_SOFT_KBD = 193, ///< Soft KBD key @SINCE_1_0.0
+ DALI_KEY_QUICK_PANEL = 194, ///< Quick panel key @SINCE_1_0.0
+ DALI_KEY_TASK_SWITCH = 195, ///< Task switch key @SINCE_1_0.0
+ DALI_KEY_APPS = 196, ///< Apps key @SINCE_1_0.0
+ DALI_KEY_SEARCH = 197, ///< Search key @SINCE_1_0.0
+ DALI_KEY_VOICE = 198, ///< Voice key @SINCE_1_0.0
+ DALI_KEY_LANGUAGE = 199, ///< Language key @SINCE_1_0.0
+ DALI_KEY_VOLUME_UP = 200, ///< Volume up key @SINCE_1_0.0
+ DALI_KEY_VOLUME_DOWN = 201 ///< Volume down key @SINCE_1_0.0
+};
/**
- * @brief Check if a key event is for a specific DALI KEY.
+ * @brief Checks if a key event is for a specific DALI KEY.
*
+ * @SINCE_1_0.0
* @param keyEvent reference to a keyEvent structure
- * @param daliKey dali key enum
- * @return true if the key is matched, false if not
+ * @param daliKey Dali key enum
+ * @return @c true if the key is matched, @c false if not
*/
-bool IsKey( const KeyEvent& keyEvent, KEY daliKey);
+DALI_IMPORT_API bool IsKey( const Dali::KeyEvent& keyEvent, Dali::KEY daliKey);
+/**
+ * @}
+ */
} // namespace Dali
#endif // __DALI_KEY_H__