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>
23 #include <dali/public-api/common/dali-vector.h>
29 * @addtogroup dali_adaptor_framework
36 * @brief Key grab functions.
43 * @brief Grabs the key specfied by @a key for @a window only when @a window is the topmost window.
45 * This function can be used for following example scenarios:
46 * - Mobile - Using volume up/down as zoom up/down in camera apps.
49 * @param[in] window The window to set
50 * @param[in] daliKey The key code to grab (defined in key.h)
51 * @return true if the grab succeeds.
53 DALI_IMPORT_API bool GrabKeyTopmost( Window window, Dali::KEY daliKey );
56 * @brief Ungrabs the key specfied by @a key for @a window.
59 * @param[in] window The window to set
60 * @param[in] daliKey The key code to ungrab (defined in key.h)
61 * @return true if the ungrab succeeds.
62 * @note If this function is called between key down and up events of a grabbed key,
63 * an application doesn't receive the key up event.
65 DALI_IMPORT_API bool UngrabKeyTopmost( Window window, Dali::KEY daliKey );
68 * @brief Key grab mode for platform-level APIs.
73 TOPMOST = 0, ///< Grab a key only when on the top of the grabbing-window stack mode. @SINCE_1_0.0
74 SHARED, ///< Grab a key together with the other client window(s) mode. @SINCE_1_0.0
75 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
76 EXCLUSIVE ///< Grab a key exclusively regardless of the grabbing-window's position on the window stack mode. @SINCE_1_0.0
81 * @brief Grabs the key specfied by @a key for @a window in @a grabMode.
83 * @details This function can be used for following example scenarios:
84 * - TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app.
85 * - Mobile - When a user presses Home key, the homescreen appears regardless of current foreground app.
86 * - Mobile - Using volume up/down as zoom up/down in camera apps.
91 * @param[in] window The window to set
92 * @param[in] daliKey The key code to grab (defined in key.h)
93 * @param[in] grabMode The grab mode for the key
94 * @return true if the grab succeeds.
96 DALI_IMPORT_API bool GrabKey( Window window, Dali::KEY daliKey, KeyGrabMode grabMode );
100 * @brief Ungrabs the key specfied by @a key for @a window.
103 * @PRIVLEVEL_PLATFORM
105 * @param[in] window The window to set
106 * @param[in] daliKey The key code to ungrab (defined in key.h)
107 * @return true if the ungrab succeeds.
108 * @note If this function is called between key down and up events of a grabbed key,
109 * an application doesn't receive the key up event.
111 DALI_IMPORT_API bool UngrabKey( Window window, Dali::KEY daliKey );
116 * @brief Grabs the list of keys specfied by @Dali::Vector of keys for @a window in @Vector of grabModes.
118 * @details This function can be used for following example scenarios:
119 * - TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app.
120 * - Mobile - When a user presses Home key, the homescreen appears regardless of current foreground app.
121 * - Mobile - Using volume up/down as zoom up/down in camera apps.
124 * @PRIVLEVEL_PLATFORM
126 * @param[in] window The window to set
127 * @param[in] daliKeyVector The Dali::Vector of key codes to grab (defined in key.h)
128 * @param[in] grabModeVector The Dali::Vector of grab modes for the keys
129 * @return Dali::Vector Size is zero when error occurs, true/false if the grab succeeds/fails.
131 DALI_IMPORT_API Dali::Vector<bool> GrabKeyList( Window window, const Dali::Vector<Dali::KEY> daliKeyVector, const Dali::Vector<KeyGrabMode> grabModeVector);
136 * @brief Ungrabs the list of keys specfied by @Dali::Vector of keys for @a window.
139 * @PRIVLEVEL_PLATFORM
141 * @param[in] window The window to set
142 * @param[in] daliKeyVector The Dali::Vector of key codes to ungrab (defined in key.h)
143 * @return Dali::Vector Size is zero when error occurs, true/false if the ungrab succeeds/fails.
144 * @note If this function is called between key down and up events of a grabbed key,
145 * an application doesn't receive the key up event.
147 DALI_IMPORT_API Dali::Vector<bool> UngrabKeyList( Window window, const Dali::Vector<Dali::KEY> daliKeyVector );
150 } // namespace KeyGrab
157 #endif // __DALI_KEY_GRAB_H__