1 #ifndef DALI_INPUT_MEHTOD_H
2 #define DALI_INPUT_MEHTOD_H
5 * Copyright (c) 2020 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/dali-adaptor-common.h>
27 * @addtogroup dali_adaptor_framework
32 * @brief Enumeration for input method.
39 * @brief Enumeration for settings that can be changed in the system Input Method.
41 * Key types of map to change virtual keyboard settings in INPUT_METHOD_SETTINGS property.
48 * @brief Enumeration for Category type.
54 PANEL_LAYOUT, ///< Set Keyboard layout @SINCE_1_3.20
55 BUTTON_ACTION, ///< Set Button Action @SINCE_1_3.20
56 AUTO_CAPITALIZE, ///< Set Auto capitalize of input @SINCE_1_3.20
57 VARIATION ///< Set variation @SINCE_1_3.20
60 } // namespace Category
62 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
63 /////////////////////////// The enumerations below is to set each type of Category. ///////////////////////////////////
64 ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
67 * @brief Sets Input panel (virtual keyboard) layout types.
75 * @brief Enumeration for PanelLayout type.
81 NORMAL, ///< Default layout @SINCE_1_3.20
82 NUMBER, ///< Number layout @SINCE_1_3.20
83 EMAIL, ///< Email layout @SINCE_1_3.20
84 URL, ///< URL layout @SINCE_1_3.20
85 PHONENUMBER, ///< Phone Number layout @SINCE_1_3.20
86 IP, ///< IP layout @SINCE_1_3.20
87 MONTH, ///< Month layout @SINCE_1_3.20
88 NUMBER_ONLY, ///< Number Only layout @SINCE_1_3.20
89 HEX, ///< Hexadecimal layout @SINCE_1_3.20
90 TERMINAL, ///< Command-line terminal layout including ESC, Alt, Ctrl key, so on (no auto-correct, no auto-capitalization) @SINCE_1_3.20
91 PASSWORD, ///< Like normal, but no auto-correct, no auto-capitalization etc @SINCE_1_3.20
92 DATE_TIME, ///< Date and time layout @SINCE_1_3.20
93 EMOTICON ///< Emoticon layout @SINCE_1_3.20
96 } // namespace PanelLayout
99 * @brief Enumeration for specifying what the Input Method "action" button functionality is set to.
101 * The 'Action' button is traditionally the [RETURN] or [DONE] button.
102 * Not all these actions are supported by all systems.
103 * Setting a custom label will still require one of these actions to be set.
106 namespace ButtonAction
110 * @brief Enumeration for ButtonAction type.
116 DEFAULT, ///< Default action @SINCE_1_3.20
117 DONE, ///< Done @SINCE_1_3.20
118 GO, ///< Go action @SINCE_1_3.20
119 JOIN, ///< Join action @SINCE_1_3.20
120 LOGIN, ///< Login action @SINCE_1_3.20
121 NEXT, ///< Next action @SINCE_1_3.20
122 PREVIOUS, ///< Previous action @SINCE_1_3.20
123 SEARCH, ///< Search action @SINCE_1_3.20
124 SEND, ///< Send action @SINCE_1_3.20
125 SIGNIN, ///< Sign in action @SINCE_1_3.20
126 UNSPECIFIED, ///< Unspecified action @SINCE_1_3.20
127 NONE ///< Nothing to do @SINCE_1_3.20
130 } // namespace ButtonAction
134 * @brief Sets Autocapitalization Types.
138 namespace AutoCapital
142 * @brief Enumeration for AutoCapital type.
148 NONE, ///< No auto-capitalization when typing @SINCE_1_3.20
149 WORD, ///< Autocapitalize each word typed @SINCE_1_3.20
150 SENTENCE, ///< Autocapitalize the start of each sentence @SINCE_1_3.20
151 ALL_CHARACTER ///< Autocapitalize all letters @SINCE_1_3.20
154 } // namespace AutoCapital
157 /////////////////////////// VARIATION based on PANEL_LAYOUT //////////////////////////////////
160 * @brief Available variation for Normal layout.
164 namespace NormalLayout
168 * @brief Enumeration for NormalLayout Variation type.
174 NORMAL, ///< The plain normal layout @SINCE_1_3.20
175 WITH_FILENAME, ///< Filename layout. Symbols such as '/' should be disabled @SINCE_1_3.20
176 WITH_PERSON_NAME ///< The name of a person @SINCE_1_3.20
179 } // namespace NormalLayout
182 * @brief Available variation for Number only layout.
186 namespace NumberOnlyLayout
190 * @brief Enumeration for NumberOnlyLayout Variation type.
196 NORMAL, ///< The plain normal number layout @SINCE_1_3.20
197 WITH_SIGNED, ///< The number layout to allow a positive or negative sign at the start @SINCE_1_3.20
198 WITH_DECIMAL, ///< The number layout to allow decimal point to provide fractional value @SINCE_1_3.20
199 WITH_SIGNED_AND_DECIMAL ///< The number layout to allow decimal point and negative sign @SINCE_1_3.20
202 } // namespace NumberOnlyLayout
205 * @brief Available variation for Password layout.
209 namespace PasswordLayout
213 * @brief Enumeration for PasswordLayout Variation type.
219 NORMAL, ///< The normal password layout @SINCE_1_3.20
220 WITH_NUMBER_ONLY ///< The password layout to allow only number @SINCE_1_3.20
223 } // namespace PasswordLayout
225 } // namespace InputMethod
232 #endif // DALI_INPUT_MEHTOD_H