Merge branch 'devel/master' into sandbox/dkdk/tizen
[platform/core/uifw/dali-adaptor.git] / dali / public-api / adaptor-framework / input-method.h
index f5caaa3..e3feac7 100644 (file)
@@ -1,8 +1,8 @@
-#ifndef __DALI_INPUT_MEHTOD_H__
-#define __DALI_INPUT_MEHTOD_H__
+#ifndef DALI_INPUT_MEHTOD_H
+#define DALI_INPUT_MEHTOD_H
 
 /*
- * Copyright (c) 2018 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,8 +18,8 @@
  *
  */
 
-// EXTERNAL INCLUDES
-#include <dali/public-api/common/dali-common.h>
+// INTERNAL INCLUDES
+#include <dali/public-api/dali-adaptor-common.h>
 
 namespace Dali
 {
@@ -34,7 +34,6 @@ namespace Dali
  */
 namespace InputMethod
 {
-
 /**
  * @brief Enumeration for settings that can be changed in the system Input Method.
  *
@@ -43,7 +42,6 @@ namespace InputMethod
  */
 namespace Category
 {
-
 /**
 * @brief Enumeration for Category type.
 *
@@ -51,10 +49,10 @@ namespace Category
 */
 enum Type
 {
-  PANEL_LAYOUT,        ///< Set Keyboard layout @SINCE_1_3.20
-  BUTTON_ACTION,       ///< Set Button Action @SINCE_1_3.20
-  AUTO_CAPITALIZE,     ///< Set Auto capitalize of input @SINCE_1_3.20
-  VARIATION            ///< Set variation @SINCE_1_3.20
+  PANEL_LAYOUT,    ///< Set Keyboard layout @SINCE_1_3.20
+  BUTTON_ACTION,   ///< Set Button Action @SINCE_1_3.20
+  AUTO_CAPITALIZE, ///< Set Auto capitalize of input @SINCE_1_3.20
+  VARIATION        ///< Set variation @SINCE_1_3.20
 };
 
 } // namespace Category
@@ -70,7 +68,6 @@ enum Type
  */
 namespace PanelLayout
 {
-
 /**
 * @brief Enumeration for PanelLayout type.
 *
@@ -78,19 +75,19 @@ namespace PanelLayout
 */
 enum Type
 {
-  NORMAL,          ///< Default layout @SINCE_1_3.20
-  NUMBER,          ///< Number layout @SINCE_1_3.20
-  EMAIL,           ///< Email layout @SINCE_1_3.20
-  URL,             ///< URL layout @SINCE_1_3.20
-  PHONENUMBER,     ///< Phone Number layout @SINCE_1_3.20
-  IP,              ///< IP layout @SINCE_1_3.20
-  MONTH,           ///< Month layout @SINCE_1_3.20
-  NUMBER_ONLY,     ///< Number Only layout @SINCE_1_3.20
-  HEX,             ///< Hexadecimal layout @SINCE_1_3.20
-  TERMINAL,        ///< Command-line terminal layout including ESC, Alt, Ctrl key, so on (no auto-correct, no auto-capitalization) @SINCE_1_3.20
-  PASSWORD,        ///< Like normal, but no auto-correct, no auto-capitalization etc @SINCE_1_3.20
-  DATE_TIME,       ///< Date and time layout @SINCE_1_3.20
-  EMOTICON         ///< Emoticon layout @SINCE_1_3.20
+  NORMAL,      ///< Default layout @SINCE_1_3.20
+  NUMBER,      ///< Number layout @SINCE_1_3.20
+  EMAIL,       ///< Email layout @SINCE_1_3.20
+  URL,         ///< URL layout @SINCE_1_3.20
+  PHONENUMBER, ///< Phone Number layout @SINCE_1_3.20
+  IP,          ///< IP layout @SINCE_1_3.20
+  MONTH,       ///< Month layout @SINCE_1_3.20
+  NUMBER_ONLY, ///< Number Only layout @SINCE_1_3.20
+  HEX,         ///< Hexadecimal layout @SINCE_1_3.20
+  TERMINAL,    ///< Command-line terminal layout including ESC, Alt, Ctrl key, so on (no auto-correct, no auto-capitalization) @SINCE_1_3.20
+  PASSWORD,    ///< Like normal, but no auto-correct, no auto-capitalization etc @SINCE_1_3.20
+  DATE_TIME,   ///< Date and time layout @SINCE_1_3.20
+  EMOTICON     ///< Emoticon layout @SINCE_1_3.20
 };
 
 } // namespace PanelLayout
@@ -105,7 +102,6 @@ enum Type
  */
 namespace ButtonAction
 {
-
 /**
 * @brief Enumeration for ButtonAction type.
 *
@@ -113,23 +109,22 @@ namespace ButtonAction
 */
 enum Type
 {
-  DEFAULT,       ///< Default action @SINCE_1_3.20
-  DONE,          ///< Done @SINCE_1_3.20
-  GO,            ///< Go action @SINCE_1_3.20
-  JOIN,          ///< Join action @SINCE_1_3.20
-  LOGIN,         ///< Login action @SINCE_1_3.20
-  NEXT,          ///< Next action @SINCE_1_3.20
-  PREVIOUS,      ///< Previous action @SINCE_1_3.20
-  SEARCH,        ///< Search action @SINCE_1_3.20
-  SEND,          ///< Send action @SINCE_1_3.20
-  SIGNIN,        ///< Sign in action @SINCE_1_3.20
-  UNSPECIFIED,   ///< Unspecified action @SINCE_1_3.20
-  NONE           ///< Nothing to do @SINCE_1_3.20
+  DEFAULT,     ///< Default action @SINCE_1_3.20
+  DONE,        ///< Done @SINCE_1_3.20
+  GO,          ///< Go action @SINCE_1_3.20
+  JOIN,        ///< Join action @SINCE_1_3.20
+  LOGIN,       ///< Login action @SINCE_1_3.20
+  NEXT,        ///< Next action @SINCE_1_3.20
+  PREVIOUS,    ///< Previous action @SINCE_1_3.20
+  SEARCH,      ///< Search action @SINCE_1_3.20
+  SEND,        ///< Send action @SINCE_1_3.20
+  SIGNIN,      ///< Sign in action @SINCE_1_3.20
+  UNSPECIFIED, ///< Unspecified action @SINCE_1_3.20
+  NONE         ///< Nothing to do @SINCE_1_3.20
 };
 
 } // namespace ButtonAction
 
-
 /**
  * @brief Sets Autocapitalization Types.
  *
@@ -137,7 +132,6 @@ enum Type
  */
 namespace AutoCapital
 {
-
 /**
 * @brief Enumeration for AutoCapital type.
 *
@@ -153,7 +147,6 @@ enum Type
 
 } // namespace AutoCapital
 
-
 /////////////////////////// VARIATION based on PANEL_LAYOUT //////////////////////////////////
 
 /**
@@ -163,7 +156,6 @@ enum Type
  */
 namespace NormalLayout
 {
-
 /**
 * @brief Enumeration for NormalLayout Variation type.
 *
@@ -171,9 +163,9 @@ namespace NormalLayout
 */
 enum Type
 {
-  NORMAL,                 ///< The plain normal layout @SINCE_1_3.20
-  WITH_FILENAME,          ///< Filename layout. Symbols such as '/' should be disabled @SINCE_1_3.20
-  WITH_PERSON_NAME        ///< The name of a person @SINCE_1_3.20
+  NORMAL,          ///< The plain normal layout @SINCE_1_3.20
+  WITH_FILENAME,   ///< Filename layout. Symbols such as '/' should be disabled @SINCE_1_3.20
+  WITH_PERSON_NAME ///< The name of a person @SINCE_1_3.20
 };
 
 } // namespace NormalLayout
@@ -185,7 +177,6 @@ enum Type
  */
 namespace NumberOnlyLayout
 {
-
 /**
 * @brief Enumeration for NumberOnlyLayout Variation type.
 *
@@ -208,7 +199,6 @@ enum Type
  */
 namespace PasswordLayout
 {
-
 /**
 * @brief Enumeration for PasswordLayout Variation type.
 *
@@ -216,55 +206,12 @@ namespace PasswordLayout
 */
 enum Type
 {
-  NORMAL,               ///< The normal password layout @SINCE_1_3.20
-  WITH_NUMBER_ONLY      ///< The password layout to allow only number @SINCE_1_3.20
+  NORMAL,          ///< The normal password layout @SINCE_1_3.20
+  WITH_NUMBER_ONLY ///< The password layout to allow only number @SINCE_1_3.20
 };
 
 } // namespace PasswordLayout
 
-
-/**
- * @DEPRECATED_1_3.20 Use ButtonAction instead.
- * @brief Enumeration for specifying what the Input Method "action" button functionality is set to.
- *
- * The 'Action' button is traditionally the [RETURN] or [DONE] button.
- *
- * Not all these actions are supported by all systems.
- *
- * Setting a custom label will still require one of these actions to be set.
- * @SINCE_1_0.0
- */
-enum ActionButton
-{
-  ACTION_DEFAULT,       ///< Default action @SINCE_1_0.0
-  ACTION_DONE,          ///< Done @SINCE_1_0.0
-  ACTION_GO,            ///< Go action @SINCE_1_0.0
-  ACTION_JOIN,          ///< Join action @SINCE_1_0.0
-  ACTION_LOGIN,         ///< Login action @SINCE_1_0.0
-  ACTION_NEXT,          ///< Next action @SINCE_1_0.0
-  ACTION_PREVIOUS,      ///< Previous action @SINCE_1_0.0
-  ACTION_SEARCH,        ///< Search action @SINCE_1_0.0
-  ACTION_SEND,          ///< Send action @SINCE_1_0.0
-  ACTION_SIGNIN,        ///< Sign in action @SINCE_1_0.0
-  ACTION_UNSPECIFIED,   ///< Unspecified action @SINCE_1_0.0
-  ACTION_NONE           ///< Nothing to do @SINCE_1_0.0
-};
-
-/**
- * @DEPRECATED_1_3.20 Use Category instead.
- * @brief Enumeration for settings that can be changed in the system Input Method.
- *
- * Not all these settings are supported by all systems.
- * @SINCE_1_0.0
- */
-enum Settings
-{
-  ACTION_BUTTON,          ///< ActionButton. Apply the one of the ActionButton functions to the action button (return button). @SINCE_1_0.0
-  AUTO_CAPITALISE,        ///< boolean.      Capitalize the first letter of each sentence automatically. @SINCE_1_0.0
-  AUTO_COMPLETE,          ///< boolean.      Suggest words based on the current input. @SINCE_1_0.0
-  AUTO_CORRECT            ///< boolean.      Automatically correct commonly misspelt words. @SINCE_1_0.0
-};
-
 } // namespace InputMethod
 
 /**
@@ -272,4 +219,4 @@ enum Settings
  */
 } // namespace Dali
 
-#endif // __DALI_INPUT_MEHTOD_H__
+#endif // DALI_INPUT_MEHTOD_H