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

   1 #ifndef __DALI_INPUT_MEHTOD_DEVEL_H__
   2 #define __DALI_INPUT_MEHTOD_DEVEL_H__
   3
   4 /*
   5  * Copyright (c) 2017 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 namespace InputMethod
  31 {
  32
  33 /**
  34  * @brief SetType that can be changed in the system Input Method
  35  *
  36  * Key types of map to change virtual keyboard settings in INPUT_METHOD_SETTINGS property
  37  *
  38  */
  39 namespace Category
  40 {
  41   enum Type
  42   {
  43     PANEL_LAYOUT,        ///< Set Keyboard layout
  44     ACTION_BUTTON_TITLE,       ///< Set Action button title
  45     AUTO_CAPITALISE,     ///< Set Auto capitalise of input
  46     VARIATION,           ///< Set variation
  47   };
  48 }
  49
  50 /**
  51  * @brief Autocapitalization Types
  52  *
  53  */
  54 namespace AutoCapital
  55 {
  56   enum Type
  57   {
  58      NONE,         ///< No auto-capitalization when typing
  59      WORD,         ///< Autocapitalize each word typed
  60      SENTENCE,     ///< Autocapitalize the start of each sentence
  61      ALLCHARACTER, ///< Autocapitalize all letters
  62   };
  63 }
  64
  65 /**
  66  * @brief  Input panel (virtual keyboard) layout types.
  67  *
  68  */
  69 namespace PanelLayout
  70 {
  71   enum Type
  72   {
  73      NORMAL,          ///< Default layout
  74      NUMBER,          ///< Number layout
  75      EMAIL,           ///< Email layout
  76      URL,             ///< URL layout
  77      PHONENUMBER,     ///< Phone Number layout
  78      IP,              ///< IP layout
  79      MONTH,           ///< Month layout
  80      NUMBERONLY,      ///< Number Only layout
  81      HEX,             ///< Hexadecimal layout
  82      TERMINAL,        ///< Command-line terminal layout including ESC, Alt, Ctrl key, so on (no auto-correct, no auto-capitalization)
  83      PASSWORD,        ///< Like normal, but no auto-correct, no auto-capitalization etc
  84      DATETIME,        ///< Date and time layout
  85      EMOTICON,        ///< Emoticon layout
  86   };
  87 }
  88
  89 /**
  90  * @brief Specifies what the Input Method "action" button functionality is set to.
  91  *
  92  * The 'Action' button is traditionally the [RETURN] or [DONE] button.
  93  *
  94  */
  95 namespace ActionButtonTitle
  96 {
  97   enum Type
  98   {
  99     DEFAULT,       ///< Default action
 100     DONE,          ///< Done
 101     GO,            ///< Go action
 102     JOIN,          ///< Join action
 103     LOGIN,         ///< Login action
 104     NEXT,          ///< Next action
 105     PREVIOUS,      ///< Previous action
 106     SEARCH,        ///< Search action
 107     SEND,          ///< Send action
 108     SIGNIN,        ///< Sign in action
 109     UNSPECIFIED,   ///< Unspecified action
 110     NONE           ///< Nothing to do
 111   };
 112 }
 113
 114 /**
 115  * @brief Available variation for Normal layout
 116  *
 117  *
 118  */
 119 namespace NormalLayout
 120 {
 121   enum Type
 122   {
 123      NORMAL,                 ///< The plain normal layout
 124      WITH_FILENAME,          ///< Filename layout. Symbols such as '/' should be disabled
 125      WITH_PERSON_NAME        ///< The name of a person
 126   };
 127 }
 128
 129 /**
 130  * @brief Available variation for Number only layout
 131  *
 132  *
 133  */
 134 namespace NumberOnlyLayout
 135 {
 136   enum Type
 137   {
 138      NORMAL,                 ///< The plain normal number layout
 139      WITH_SIGNED,            ///< The number layout to allow a positive or negative sign at the start
 140      WITH_DECIMAL,           ///< The number layout to allow decimal point to provide fractional value
 141      WITH_SIGNED_AND_DECIMAL ///< The number layout to allow decimal point and negative sign
 142   };
 143 }
 144
 145 /**
 146  * @brief Available variation for Password layout
 147  *
 148  *
 149  */
 150 namespace PasswordLayout
 151 {
 152   enum Type
 153   {
 154      NORMAL,               ///< The normal password layout
 155      WITH_NUMBERONLY       ///< The password layout to allow only number
 156   };
 157 }
 158
 159 } // namespace InputMethod
 160
 161 /**
 162  * @}
 163  */
 164 } // namespace Dali
 165
 166 #endif // __DALI_INPUT_MEHTOD_DEVEL_H__