[NUI] Open Text InputFilter APIs
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / Common / NUIConstants.cs
index a58b67a..6695c9b 100755 (executable)
@@ -743,6 +743,10 @@ namespace Tizen.NUI
     /// <summary>
     /// An enum of window types.
     /// </summary>
+    /// <remarks>
+    /// Most of window type can be set, except for IME type.<br />
+    /// IME type can only be used in one of NUIApplication's constrcutors.<br />
+    /// </remarks>
     /// <since_tizen> 3 </since_tizen>
     public enum WindowType
     {
@@ -766,11 +770,12 @@ namespace Tizen.NUI
         Dialog,
         /// <summary>
         /// Used for IME window that is used for keyboard window.
-        /// It should be set in Application's New input param when application is created.
-        /// In addition, it is only for internal keyboard application.
-        /// This should be hidden.
+        /// It should be set in NUIApplication constructor.
+        /// It does not work with Window.Type, because IME window type can not change in runtime.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <remarks>
+        /// See <see cref="NUIApplication" /> for this type. <br />
+        /// </remarks>
         Ime
     }
 
@@ -829,13 +834,13 @@ namespace Tizen.NUI
         /// Hyphenation mode will move part of the word (at possible hyphen locations)
         /// to the next line and draw a hyphen at the end of the line.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         Hyphenation,
 
         /// <summary>
         /// Mixed mode will try word wrap, if failed, it will try hyphenation wrap.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         Mixed
     }
 
@@ -886,25 +891,25 @@ namespace Tizen.NUI
     /// <summary>
     /// An enum of ellipsis position.
     /// </summary>
-    [EditorBrowsable(EditorBrowsableState.Never)]
+    /// <since_tizen> 9 </since_tizen>
     public enum EllipsisPosition
     {
         /// <summary>
         /// ellipsis position at end.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         End,
 
         /// <summary>
         /// ellipsis position at start.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         Start,
 
         /// <summary>
-        /// ellipsis position in middle.
+        /// ellipsis position in the middle.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         Middle
     }
 
@@ -1945,65 +1950,58 @@ namespace Tizen.NUI
     /// If the device can not support GLES version 3.0 over, the version will be chosen with GLES version 2.0.<br />
     /// It is for GLWindow and GLView.<br />
     /// </summary>
+    /// <since_tizen> 9 </since_tizen>
     [EditorBrowsable(EditorBrowsableState.Never)]
     public enum GLESVersion
     {
       /// <summary>
       /// GLES version 2.0
       /// </summary>
-      [EditorBrowsable(EditorBrowsableState.Never)]
       Version20 = 0,
 
       /// <summary>
       /// GLES version 3.0
       /// </summary>
-      [EditorBrowsable(EditorBrowsableState.Never)]
       Version30
     }
 
     /// <summary>
     /// Enumeration for rendering mode
     /// This Enumeration is used to choose the rendering mode.
-    /// It has two options.
-    /// One of them is continuous mode. It is rendered continuously.
-    /// The other is on demand mode. It is rendered by application.
     /// It is for GLWindow and GLView.
     /// </summary>
+    /// <since_tizen> 9 </since_tizen>
     [EditorBrowsable(EditorBrowsableState.Never)]
     public enum GLRenderingMode
     {
       /// <summary>
-      /// continuous mode
+      /// The render frame delegate is invoked continuously.
       /// </summary>
-      [EditorBrowsable(EditorBrowsableState.Never)]
       Continuous = 0,
 
       /// <summary>
-      /// on demand by application
+      /// The render frame delegate is invoked by user.
       /// </summary>
-      [EditorBrowsable(EditorBrowsableState.Never)]
       OnDemand = 1
     }
 
     /// <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; }
         }
 
@@ -2139,7 +2135,7 @@ namespace Tizen.NUI
             /// <summary>
             /// The offset in pixels of the shadow (if null, the default value is 0, 0). <br />
             /// If not provided then the shadow is not enabled. <br />
-            ///  
+            ///
             /// </summary>
             [EditorBrowsable(EditorBrowsableState.Never)]
             public Vector2 Offset { get; set; }
@@ -2215,6 +2211,12 @@ namespace Tizen.NUI
             /// </summary>
             [EditorBrowsable(EditorBrowsableState.Never)]
             public FontSizeType FontSizeType { get; set; }
+
+            /// <summary>
+            /// Font Size for text fit
+            /// </summary>
+            [EditorBrowsable(EditorBrowsableState.Never)]
+            public float? FontSize { get; set; }
         }
 
         /// <summary>
@@ -2345,4 +2347,71 @@ namespace Tizen.NUI
             public string RightImageUrl { get; set; }
         }
     }
+
+
+    /// <summary>
+    /// Pre-defined SlideTransition Direction
+    /// </summary>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public struct SlideTransitionDirection
+    {
+        /// <summary>
+        /// Top
+        /// </summary>
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public static Vector2 Top
+        {
+            get
+            {
+                global::System.IntPtr cPtr = Interop.SlideTransitionDirection.SlideTransitionDirectionTopGet();
+                Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
+                if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
+                return ret;
+            }
+        }
+        /// <summary>
+        /// Bottom
+        /// </summary>
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public static Vector2 Bottom
+        {
+            get
+            {
+                global::System.IntPtr cPtr = Interop.SlideTransitionDirection.SlideTransitionDirectionBottomGet();
+                Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
+                if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
+                return ret;
+            }
+        }
+
+        /// <summary>
+        /// Right
+        /// </summary>
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public static Vector2 Right
+        {
+            get
+            {
+                global::System.IntPtr cPtr = Interop.SlideTransitionDirection.SlideTransitionDirectionRightGet();
+                Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
+                if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
+                return ret;
+            }
+        }
+
+        /// <summary>
+        /// Left
+        /// </summary>
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public static Vector2 Left
+        {
+            get
+            {
+                global::System.IntPtr cPtr = Interop.SlideTransitionDirection.SlideTransitionDirectionLeftGet();
+                Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
+                if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
+                return ret;
+            }
+        }
+    }
 }