adaptors/public-api/adaptor-framework/input-method.h

   1 #ifndef __DALI_INPUT_MEHTOD_H__
   2 #define __DALI_INPUT_MEHTOD_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-common.h>
  23
  24 namespace Dali
  25 {
  26 /**
  27  * @addtogroup dali_adaptor_framework
  28  * @{
  29  */
  30
  31 /**
  32  * @brief Enumeration for input method.
  33  * @SINCE_1_0.0
  34  */
  35 namespace InputMethod
  36 {
  37 /**
  38  * @brief Enumeration for specifying what the Input Method "action" button functionality is set to.
  39  *
  40  * The 'Action' button is traditionally the [RETURN] or [DONE] button.
  41  *
  42  * Not all these actions are supported by all systems.
  43  *
  44  * Setting a custom label will still require one of these actions to be set.
  45  * @SINCE_1_0.0
  46  */
  47 enum ActionButton
  48 {
  49   ACTION_DEFAULT,       ///< Default action @SINCE_1_0.0
  50   ACTION_DONE,          ///< Done @SINCE_1_0.0
  51   ACTION_GO,            ///< Go action @SINCE_1_0.0
  52   ACTION_JOIN,          ///< Join action @SINCE_1_0.0
  53   ACTION_LOGIN,         ///< Login action @SINCE_1_0.0
  54   ACTION_NEXT,          ///< Next action @SINCE_1_0.0
  55   ACTION_PREVIOUS,      ///< Previous action @SINCE_1_0.0
  56   ACTION_SEARCH,        ///< Search action @SINCE_1_0.0
  57   ACTION_SEND,          ///< Send action @SINCE_1_0.0
  58   ACTION_SIGNIN,        ///< Sign in action @SINCE_1_0.0
  59   ACTION_UNSPECIFIED,   ///< Unspecified action @SINCE_1_0.0
  60   ACTION_NONE           ///< Nothing to do @SINCE_1_0.0
  61 };
  62
  63 /**
  64  * @brief Enumeration for settings that can be changed in the system Input Method.
  65  *
  66  * Not all these settings are supported by all systems.
  67  * @SINCE_1_0.0
  68  */
  69 enum Settings
  70 {
  71   ACTION_BUTTON,          ///< ActionButton. Apply the one of the ActionButton functions to the action button (return button). @SINCE_1_0.0
  72   AUTO_CAPITALISE,        ///< boolean.      Capitalize the first letter of each sentence automatically. @SINCE_1_0.0
  73   AUTO_COMPLETE,          ///< boolean.      Suggest words based on the current input. @SINCE_1_0.0
  74   AUTO_CORRECT            ///< boolean.      Automatically correct commonly misspelt words. @SINCE_1_0.0
  75 };
  76
  77 } // namespace InputMethod
  78
  79 /**
  80  * @}
  81  */
  82 } // namespace Dali
  83
  84 #endif // __DALI_INPUT_MEHTOD_H__