dali/devel-api/adaptor-framework/keyboard.h

   1 #ifndef DALI_KEYBOARD_H
   2 #define DALI_KEYBOARD_H
   3
   4 /*
   5  * Copyright (c) 2020 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/dali-adaptor-common.h>
  23
  24 namespace Dali
  25 {
  26 /**
  27  * @addtogroup dali_adaptor_framework
  28  * @{
  29  */
  30
  31 /**
  32  * @brief Keyboard functions.
  33  */
  34 namespace Keyboard
  35 {
  36 /**
  37  * @brief Sets keyboard repeat information.
  38  *
  39  * @param[in] rate The key repeat rate value in seconds
  40  * @param[in] delay The key repeat delay value in seconds
  41  * @return true if setting the keyboard repeat succeeds
  42  */
  43 DALI_ADAPTOR_API bool SetRepeatInfo(float rate, float delay);
  44
  45 /**
  46  * @brief Gets keyboard repeat information.
  47  *
  48  * @param[in] rate The key repeat rate value in seconds
  49  * @param[in] delay The key repeat delay value in seconds
  50  * @return true if getting the keyboard repeat succeeds, false otherwise
  51  */
  52 DALI_ADAPTOR_API bool GetRepeatInfo(float& rate, float& delay);
  53
  54 /**
  55  * @brief Sets keyboard repeat information of horizontal way.
  56  *
  57  * @param[in] rate The key repeat rate value in seconds
  58  * @param[in] delay The key repeat delay value in seconds
  59  * @return true if setting the keyboard repeat succeeds
  60  */
  61 DALI_ADAPTOR_API bool SetHorizontalRepeatInfo(float rate, float delay);
  62
  63 /**
  64  * @brief Gets keyboard repeat information of horizontal way.
  65  *
  66  * @param[in] rate The key repeat rate value in seconds
  67  * @param[in] delay The key repeat delay value in seconds
  68  * @return true if getting the keyboard repeat succeeds, false otherwise
  69  */
  70 DALI_ADAPTOR_API bool GetHorizontalRepeatInfo(float& rate, float& delay);
  71
  72 /**
  73  * @brief Sets keyboard repeat information of vertical way.
  74  *
  75  * @param[in] rate The key repeat rate value in seconds
  76  * @param[in] delay The key repeat delay value in seconds
  77  * @return true if setting the keyboard repeat succeeds
  78  */
  79 DALI_ADAPTOR_API bool SetVerticalRepeatInfo(float rate, float delay);
  80
  81 /**
  82  * @brief Gets keyboard repeat information of vertical way.
  83  *
  84  * @param[in] rate The key repeat rate value in seconds
  85  * @param[in] delay The key repeat delay value in seconds
  86  * @return true if getting the keyboard repeat succeeds, false otherwise
  87  */
  88 DALI_ADAPTOR_API bool GetVerticalRepeatInfo(float& rate, float& delay);
  89
  90 } // namespace Keyboard
  91
  92 /**
  93  * @}
  94  */
  95 } // namespace Dali
  96
  97 #endif // DALI_KEYBOARD_H