X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=adaptors%2Ftizen%2Fkey-grab.h;h=d7d3bdc397312af5e3746c96e239b57feab71463;hb=a7573b0f44b096f3118714fd88089b900cae917e;hp=4d083cc44987ba002256d1e82397ac9e24372917;hpb=13a3032c8a4eecee3aa4ba7bcc676bb048c4a94d;p=platform%2Fcore%2Fuifw%2Fdali-adaptor.git diff --git a/adaptors/tizen/key-grab.h b/adaptors/tizen/key-grab.h old mode 100644 new mode 100755 index 4d083cc..d7d3bdc --- a/adaptors/tizen/key-grab.h +++ b/adaptors/tizen/key-grab.h @@ -20,6 +20,7 @@ // INTERNAL INCLUDES #include +#include #include "key.h" namespace Dali @@ -39,7 +40,7 @@ namespace KeyGrab { /** - * @brief Grabs the key specfied by @a key for @a window only when @a window is the topmost window. + * @brief Grabs the key specified by @a key for @a window only when @a window is the topmost window. * * This function can be used for following example scenarios: * - Mobile - Using volume up/down as zoom up/down in camera apps. @@ -47,24 +48,24 @@ namespace KeyGrab * @SINCE_1_0.0 * @param[in] window The window to set * @param[in] daliKey The key code to grab (defined in key.h) - * @return true if the grab succeeds. + * @return true if the grab succeeds */ DALI_IMPORT_API bool GrabKeyTopmost( Window window, Dali::KEY daliKey ); /** - * @brief Ungrabs the key specfied by @a key for @a window. + * @brief Ungrabs the key specified by @a key for @a window. * * @SINCE_1_0.0 * @param[in] window The window to set * @param[in] daliKey The key code to ungrab (defined in key.h) - * @return true if the ungrab succeeds. + * @return true if the ungrab succeeds * @note If this function is called between key down and up events of a grabbed key, * an application doesn't receive the key up event. */ DALI_IMPORT_API bool UngrabKeyTopmost( Window window, Dali::KEY daliKey ); /** - * @brief Key grab mode for platform-level APIs. + * @brief Enumeration for key grab mode for platform-level APIs. * @SINCE_1_0.0 */ enum KeyGrabMode @@ -77,7 +78,7 @@ enum KeyGrabMode /** * @PLATFORM - * @brief Grabs the key specfied by @a key for @a window in @a grabMode. + * @brief Grabs the key specified by @a key for @a window in @a grabMode. * * @details This function can be used for following example scenarios: * - TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app. @@ -90,25 +91,62 @@ enum KeyGrabMode * @param[in] window The window to set * @param[in] daliKey The key code to grab (defined in key.h) * @param[in] grabMode The grab mode for the key - * @return true if the grab succeeds. + * @return true if the grab succeeds */ DALI_IMPORT_API bool GrabKey( Window window, Dali::KEY daliKey, KeyGrabMode grabMode ); /** * @PLATFORM - * @brief Ungrabs the key specfied by @a key for @a window. + * @brief Ungrabs the key specified by @a key for @a window. * * @SINCE_1_0.0 * @PRIVLEVEL_PLATFORM * @PRIVILEGE_KEYGRAB * @param[in] window The window to set * @param[in] daliKey The key code to ungrab (defined in key.h) - * @return true if the ungrab succeeds. + * @return true if the ungrab succeeds * @note If this function is called between key down and up events of a grabbed key, * an application doesn't receive the key up event. */ DALI_IMPORT_API bool UngrabKey( Window window, Dali::KEY daliKey ); + +/** + * @PLATFORM + * @brief Grabs the list of keys specified by Dali::Vector of keys for @a window in Vector of grabModes. + * + * @details This function can be used for following example scenarios: + * - TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app. + * - Mobile - When a user presses Home key, the homescreen appears regardless of current foreground app. + * - Mobile - Using volume up/down as zoom up/down in camera apps. + * + * @SINCE_1_2.0 + * @PRIVLEVEL_PLATFORM + * @PRIVILEGE_KEYGRAB + * @param[in] window The window to set + * @param[in] daliKeyVector The Dali::Vector of key codes to grab (defined in key.h) + * @param[in] grabModeVector The Dali::Vector of grab modes for the keys + * @return Dali::Vector Size is zero when error occurs, true/false if the grab succeeds/fails. + */ +DALI_IMPORT_API Dali::Vector GrabKeyList( Window window, const Dali::Vector& daliKeyVector, const Dali::Vector& grabModeVector); + + +/** + * @PLATFORM + * @brief Ungrabs the list of keys specified by Dali::Vector of keys for @a window. + * + * @SINCE_1_2.0 + * @PRIVLEVEL_PLATFORM + * @PRIVILEGE_KEYGRAB + * @param[in] window The window to set + * @param[in] daliKeyVector The Dali::Vector of key codes to ungrab (defined in key.h) + * @return Dali::Vector Size is zero when error occurs, true/false if the ungrab succeeds/fails. + * @note If this function is called between key down and up events of a grabbed key, + * an application doesn't receive the key up event. + */ +DALI_IMPORT_API Dali::Vector UngrabKeyList( Window window, const Dali::Vector& daliKeyVector ); + + } // namespace KeyGrab /**