adaptors/tizen/key-grab.h

   1 #ifndef __DALI_KEY_GRAB_H__
   2 #define __DALI_KEY_GRAB_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 // INTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-common.h>
  23 #include "key.h"
  24
  25 namespace Dali
  26 {
  27 class Window;
  28
  29 namespace KeyGrab
  30 {
  31
  32 /**
  33  * @brief Grabs the key specfied by @a key for @a window only when @a window is the topmost window.
  34  *
  35  * This function can be used for following example scenarios:
  36  * Mobile - Using volume up/down as zoom up/down in camera apps.
  37  *
  38  * @note This function is only specified by Tizen.
  39  * @param[in] window The window to set
  40  * @param[in] dailKey The key code to grab (defined in key.h)
  41  * @return true if the grab succeed.
  42  */
  43 DALI_IMPORT_API bool GrabKeyTopmost( Window window, Dali::KEY daliKey );
  44
  45 /**
  46  * @brief Ungrabs the key specfied by @a key for @a window.
  47  *
  48  * @note This function is only specified by Tizen.
  49  * @param[in] window The window to set
  50  * @param[in] dailKey The key code to ungrab (defined in key.h)
  51  * @return true if the ungrab succeed.
  52  */
  53 DALI_IMPORT_API bool UngrabKeyTopmost( Window window, Dali::KEY daliKey );
  54
  55 /**
  56  * @brief Key grab mode for platform-level APIs.
  57  */
  58 enum KeyGrabMode
  59 {
  60   TOPMOST = 0,             ///< Grab a key only when on the top of the grabbing-window stack mode.
  61   SHARED,                  ///< Grab a key together with the other client window(s) mode.
  62   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.
  63   EXCLUSIVE                ///< Grab a key exclusively regardless of the grabbing-window's position on the window stack mode.
  64 };
  65
  66 /**
  67  * @brief Grabs the key specfied by @a key for @a window in @a grabMode.
  68  *
  69  * This function can be used for following example scenarios:
  70  * TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app.
  71  * Mobile - When a user presses Home key, the homescreen appears regardless of current foreground app.
  72  * Mobile - Using volume up/down as zoom up/down in camera apps.
  73  *
  74  * @privlevel platform
  75  * @note This function is only specified by Tizen.
  76  * @param[in] window The window to set
  77  * @param[in] dailKey The key code to grab (defined in key.h)
  78  * @param[in] grabMode The grab mode for the key
  79  * @return true if the grab succeed.
  80  */
  81 DALI_IMPORT_API bool GrabKey( Window window, Dali::KEY daliKey, KeyGrabMode grabMode );
  82
  83 /**
  84  * @brief Ungrabs the key specfied by @a key for @a window.
  85  *
  86  * @privlevel platform
  87  * @note This function is only specified by Tizen.
  88  * @param[in] window The window to set
  89  * @param[in] dailKey The key code to ungrab (defined in key.h)
  90  * @return true if the ungrab succeed.
  91  */
  92 DALI_IMPORT_API bool UngrabKey( Window window, Dali::KEY daliKey );
  93
  94 } // namespace KeyGrab
  95
  96 } // namespace Dali
  97
  98 #endif // __DALI_KEY_GRAB_H__