1 #ifndef __DALI_KEY_GRAB_H__
2 #define __DALI_KEY_GRAB_H__
5 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/common/dali-common.h>
28 * @addtogroup dali_adaptor_framework
35 * @brief Key grab functions.
42 * @brief Grabs the key specfied by @a key for @a window only when @a window is the topmost window.
44 * This function can be used for following example scenarios:
45 * - Mobile - Using volume up/down as zoom up/down in camera apps.
48 * @param[in] window The window to set
49 * @param[in] daliKey The key code to grab (defined in key.h)
50 * @return true if the grab succeeds.
52 DALI_IMPORT_API bool GrabKeyTopmost( Window window, Dali::KEY daliKey );
55 * @brief Ungrabs the key specfied by @a key for @a window.
58 * @param[in] window The window to set
59 * @param[in] daliKey The key code to ungrab (defined in key.h)
60 * @return true if the ungrab succeeds.
61 * @note If this function is called between key down and up events of a grabbed key,
62 * an application doesn't receive the key up event.
64 DALI_IMPORT_API bool UngrabKeyTopmost( Window window, Dali::KEY daliKey );
67 * @brief Key grab mode for platform-level APIs.
72 TOPMOST = 0, ///< Grab a key only when on the top of the grabbing-window stack mode. @SINCE_1_0.0
73 SHARED, ///< Grab a key together with the other client window(s) mode. @SINCE_1_0.0
74 OVERRIDE_EXCLUSIVE, ///< Grab a key exclusively regardless of the grabbing-window's position on the window stack with the possibility of overriding the grab by the other client window mode. @SINCE_1_0.0
75 EXCLUSIVE ///< Grab a key exclusively regardless of the grabbing-window's position on the window stack mode. @SINCE_1_0.0
80 * @brief Grabs the key specfied by @a key for @a window in @a grabMode.
82 * @details This function can be used for following example scenarios:
83 * - TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app.
84 * - Mobile - When a user presses Home key, the homescreen appears regardless of current foreground app.
85 * - Mobile - Using volume up/down as zoom up/down in camera apps.
90 * @param[in] window The window to set
91 * @param[in] daliKey The key code to grab (defined in key.h)
92 * @param[in] grabMode The grab mode for the key
93 * @return true if the grab succeeds.
95 DALI_IMPORT_API bool GrabKey( Window window, Dali::KEY daliKey, KeyGrabMode grabMode );
99 * @brief Ungrabs the key specfied by @a key for @a window.
102 * @PRIVLEVEL_PLATFORM
104 * @param[in] window The window to set
105 * @param[in] daliKey The key code to ungrab (defined in key.h)
106 * @return true if the ungrab succeeds.
107 * @note If this function is called between key down and up events of a grabbed key,
108 * an application doesn't receive the key up event.
110 DALI_IMPORT_API bool UngrabKey( Window window, Dali::KEY daliKey );
112 } // namespace KeyGrab
119 #endif // __DALI_KEY_GRAB_H__