[NUI] Open Text InputFilter APIs
authorBowon Ryu <bowon.ryu@samsung.com>
Mon, 13 Jun 2022 05:04:08 +0000 (14:04 +0900)
committerdongsug-song <35130733+dongsug-song@users.noreply.github.com>
Tue, 14 Jun 2022 10:51:47 +0000 (19:51 +0900)
Signed-off-by: Bowon Ryu <bowon.ryu@samsung.com>
src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs
src/Tizen.NUI/src/public/BaseComponents/TextEditorEvent.cs
src/Tizen.NUI/src/public/BaseComponents/TextEvent.cs
src/Tizen.NUI/src/public/BaseComponents/TextField.cs
src/Tizen.NUI/src/public/BaseComponents/TextFieldEvent.cs
src/Tizen.NUI/src/public/Common/NUIConstants.cs

index 6873541..a696853 100755 (executable)
@@ -1535,20 +1535,13 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// Set InputFilter to TextEditor. <br />
+        /// Set InputFilter to TextEditor.
         /// </summary>
         /// <param name="inputFilter">The InputFilter</param>
         /// <remarks>
         /// <see cref="Tizen.NUI.Text.InputFilter"/> filters input based on regular expressions. <br />
-        /// Users can set the Accepted or Rejected regular expression set, or both. <br />
-        /// If both are used, Rejected has higher priority. <br />
-        /// The character set must follow the regular expression rules. <br />
-        /// Behaviour can not be guaranteed for incorrect grammars. <br />
-        /// Refer the link below for detailed rules. <br />
-        /// The functions in std::regex library use the ECMAScript grammar: <br />
-        /// http://cplusplus.com/reference/regex/ECMAScript/ <br />
         /// InputFiltered signal is emitted when the input is filtered by InputFilter <br />
-        /// See <see cref="InputFiltered"/>, <see cref="InputFilterType"/> and <see cref="InputFilteredEventArgs"/> for a detailed description. <br />
+        /// See <see cref="InputFiltered"/>, <see cref="InputFilterType"/> and <see cref="InputFilteredEventArgs"/> for a detailed description.
         /// </remarks>
         /// <example>
         /// The following example demonstrates how to use the SetInputFilter method.
@@ -1559,7 +1552,7 @@ namespace Tizen.NUI.BaseComponents
         /// editor.SetInputFilter(inputFilter); // acceptable inputs are 4, 5, 6, 7, 8, 9
         /// </code>
         /// </example>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public void SetInputFilter(InputFilter inputFilter)
         {
             SetProperty(TextEditor.Property.InputFilter, new PropertyValue(TextUtils.GetInputFilterMap(inputFilter)));
@@ -1572,7 +1565,7 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// <see cref="Tizen.NUI.Text.InputFilter"/>
         /// </remarks>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public InputFilter GetInputFilter()
         {
             var map = new PropertyMap();
index da02aec..d52381c 100755 (executable)
@@ -275,7 +275,7 @@ namespace Tizen.NUI.BaseComponents
         /// };
         /// </code>
         /// </example>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public event EventHandler<InputFilteredEventArgs> InputFiltered
         {
             add
index 7aa5e99..6319d95 100644 (file)
@@ -36,7 +36,7 @@ namespace Tizen.NUI.BaseComponents
     /// <summary>
     /// InputFilteredEventArgs is a class to record input filter event arguments which will be sent to user.
     /// </summary>
-    [EditorBrowsable(EditorBrowsableState.Never)]
+    /// <since_tizen> 9 </since_tizen>
     public class InputFilteredEventArgs : EventArgs
     {
         /// <summary>
@@ -44,7 +44,6 @@ namespace Tizen.NUI.BaseComponents
         /// If the input is filtered by the Accepted Regex of the InputFilter, the Accept type is stored. <br />
         /// If the input is filtered by the Rejected Regex of the InputFilter, the Reject type is stored. <br />
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
         public InputFilterType Type { get; set; }
     }
 }
\ No newline at end of file
index 1d4d1ae..a7d5a81 100755 (executable)
@@ -1717,20 +1717,13 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// Set InputFilter to TextField. <br />
+        /// Set InputFilter to TextField.
         /// </summary>
         /// <param name="inputFilter">The InputFilter</param>
         /// <remarks>
         /// <see cref="Tizen.NUI.Text.InputFilter"/> filters input based on regular expressions. <br />
-        /// Users can set the Accepted or Rejected regular expression set, or both. <br />
-        /// If both are used, Rejected has higher priority. <br />
-        /// The character set must follow the regular expression rules. <br />
-        /// Behaviour can not be guaranteed for incorrect grammars. <br />
-        /// Refer the link below for detailed rules. <br />
-        /// The functions in std::regex library use the ECMAScript grammar: <br />
-        /// http://cplusplus.com/reference/regex/ECMAScript/ <br />
         /// InputFiltered signal is emitted when the input is filtered by InputFilter <br />
-        /// See <see cref="InputFiltered"/>, <see cref="InputFilterType"/> and <see cref="InputFilteredEventArgs"/> for a detailed description. <br />
+        /// See <see cref="InputFiltered"/>, <see cref="InputFilterType"/> and <see cref="InputFilteredEventArgs"/> for a detailed description.
         /// </remarks>
         /// <example>
         /// The following example demonstrates how to use the SetInputFilter method.
@@ -1741,20 +1734,20 @@ namespace Tizen.NUI.BaseComponents
         /// field.SetInputFilter(inputFilter); // acceptable inputs are 4, 5, 6, 7, 8, 9
         /// </code>
         /// </example>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public void SetInputFilter(InputFilter inputFilter)
         {
             SetProperty(TextField.Property.InputFilter, new PropertyValue(TextUtils.GetInputFilterMap(inputFilter)));
         }
 
         /// <summary>
-        /// Get InputFilter from TextField. <br />
+        /// Get InputFilter from TextField.
         /// </summary>
         /// <returns>The InputFilter</returns>
         /// <remarks>
         /// <see cref="Tizen.NUI.Text.InputFilter"/>
         /// </remarks>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public InputFilter GetInputFilter()
         {
             var map = new PropertyMap();
index 9d0b9bd..2310524 100755 (executable)
@@ -237,7 +237,7 @@ namespace Tizen.NUI.BaseComponents
         /// };
         /// </code>
         /// </example>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public event EventHandler<InputFilteredEventArgs> InputFiltered
         {
             add
index 1976c75..6695c9b 100755 (executable)
@@ -1986,24 +1986,22 @@ namespace Tizen.NUI
     }
 
     /// <summary>
-    /// Enumeration for the type of InputFilter. <br />
+    /// Enumeration for the type of InputFilter.
     /// </summary>
     /// <remarks>
-    /// The type of InputFilter that is stored in the <see cref="Tizen.NUI.BaseComponents.InputFilteredEventArgs"/> when the input is filtered. <br />
+    /// The type of InputFilter that is stored in the <see cref="Tizen.NUI.BaseComponents.InputFilteredEventArgs"/> when the input is filtered.
     /// </remarks>
-    [EditorBrowsable(EditorBrowsableState.Never)]
+    /// <since_tizen> 9 </since_tizen>
     public enum InputFilterType
     {
         /// <summary>
         /// The type of InputFilter is Accept.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
         Accept,
 
         /// <summary>
         /// The type of InputFilter is Reject.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
         Reject
     }
 
@@ -2046,19 +2044,17 @@ namespace Tizen.NUI
         /// The InputFilter struct is used as an argument to SetInputFilter and GetInputFilter methods. <br />
         /// See <see cref="Tizen.NUI.BaseComponents.TextField.SetInputFilter"/>, <see cref="Tizen.NUI.BaseComponents.TextField.GetInputFilter"/>, <see cref="Tizen.NUI.BaseComponents.TextEditor.SetInputFilter"/> and <see cref="Tizen.NUI.BaseComponents.TextEditor.GetInputFilter"/>. <br />
         /// </remarks>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public struct InputFilter
         {
             /// <summary>
             /// A regular expression in the set of characters to be accepted by the inputFilter.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             public string Accepted { get; set; }
 
             /// <summary>
             /// A regular expression in the set of characters to be rejected by the inputFilter.
             /// </summary>
-            [EditorBrowsable(EditorBrowsableState.Never)]
             public string Rejected { get; set; }
         }