[NUI] Make Size and NaturalSize as public API (#423)
authordongsug-song <35130733+dongsug-song@users.noreply.github.com>
Mon, 10 Sep 2018 04:07:57 +0000 (13:07 +0900)
committerGitHub <noreply@github.com>
Mon, 10 Sep 2018 04:07:57 +0000 (13:07 +0900)
src/Tizen.NUI/src/public/BaseComponents/View.cs
src/Tizen.NUI/src/public/Size.cs [moved from src/Tizen.NUI/src/internal/Size.cs with 93% similarity]

index 632414a..d790995 100755 (executable)
@@ -3371,14 +3371,7 @@ namespace Tizen.NUI.BaseComponents
         /// <remarks>
         /// Deriving classes stipulate the natural size and by default a view has a zero natural size.
         /// </remarks>
-        /// /// Please do not use! this will be deprecated!
-        /// Instead please use NaturalSize2D.
-        /// <since_tizen> 3 </since_tizen>
-        [Obsolete("Please do not use! This will be deprecated! Please use NaturalSize2D instead! " +
-            "Like: " +
-            "TextLabel label = new TextLabel(\"Hello World!\"); " +
-            "Size2D size = label.NaturalSize2D;")]
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 5 </since_tizen>
         public Vector3 NaturalSize
         {
             get
@@ -5246,14 +5239,18 @@ namespace Tizen.NUI.BaseComponents
         }
 
         /// <summary>
-        /// [Obsolete("Please do not use! this will be deprecated")]
+        /// Sets the size of a view for the width, the height and the depth.<br />
+        /// Geometry can be scaled to fit within this area.<br />
+        /// This does not interfere with the view's scale factor.<br />
+        /// The views default depth is the minimum of width and height.<br />
         /// </summary>
-        /// <since_tizen> 3 </since_tizen>
-        [Obsolete("Please do not use! This will be deprecated! Please use Size2D instead! " +
-            "Like: " +
-            "View view = new View(); " +
-            "view.Size2D = new Size2D(100, 100);")]
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <remarks>
+        /// Please note that multi-cascade setting is not possible for this NUI object. <br />
+        /// It is recommended that NUI object typed properties are configured by their constructor with parameters. <br />
+        /// For example, this code is working fine : view.Size = new Size( 1.0f, 1.0f, 0.0f); <br />
+        /// but this will not work! : view.Size.Width = 2.0f; view.Size.Height = 2.0f; <br />
+        /// </remarks>
+        /// <since_tizen> 5 </since_tizen>
         public Size Size
         {
             get
similarity index 93%
rename from src/Tizen.NUI/src/internal/Size.cs
rename to src/Tizen.NUI/src/public/Size.cs
index 6841e99..6a20e20 100755 (executable)
@@ -21,18 +21,16 @@ using Tizen.NUI.Binding;
 
 namespace Tizen.NUI
 {
-    // Please do not use! This will be changed to internal class.
     /// <summary>
     /// A three-dimensional size.
     /// </summary>
-    /// <since_tizen> 3 </since_tizen>
+    /// <since_tizen> 5 </since_tizen>
     [Tizen.NUI.Binding.TypeConverter(typeof(SizeTypeConverter))]
-    [EditorBrowsable(EditorBrowsableState.Never)]
     public class Size : global::System.IDisposable
     {
         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
         /// <summary>swigCMemOwn.</summary>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         protected bool swigCMemOwn;
 
         internal Size(global::System.IntPtr cPtr, bool cMemoryOwn)
@@ -51,7 +49,7 @@ namespace Tizen.NUI
         /// <summary>
         /// A Flat to check if it is already disposed.
         /// </summary>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         protected bool disposed = false;
 
         /// <summary>
@@ -69,7 +67,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Dispose.
         /// </summary>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public void Dispose()
         {
             //Throw excpetion if Dispose() is called in separate thread.
@@ -92,7 +90,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Dispose.
         /// </summary>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         protected virtual void Dispose(DisposeTypes type)
         {
             if (disposed)
@@ -131,7 +129,7 @@ namespace Tizen.NUI
         /// <param name="arg1">Size to assign A.</param>
         /// <param name="arg2">Size to assign B.</param>
         /// <returns>A size containing the result of the addition.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public static Size operator +(Size arg1, Size arg2)
         {
             return arg1.Add(arg2);
@@ -143,7 +141,7 @@ namespace Tizen.NUI
         /// <param name="arg1">Size to subtract A.</param>
         /// <param name="arg2">Size to subtract B.</param>
         /// <returns>The size containing the result of the subtraction.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public static Size operator -(Size arg1, Size arg2)
         {
             return arg1.Subtract(arg2);
@@ -154,7 +152,7 @@ namespace Tizen.NUI
         /// </summary>
         /// <param name="arg1">Size for unary negation.</param>
         /// <returns>A size containing the negation.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public static Size operator -(Size arg1)
         {
             return arg1.Subtract();
@@ -166,7 +164,7 @@ namespace Tizen.NUI
         /// <param name="arg1">Size for multiplication.</param>
         /// <param name="arg2">The size to multiply.</param>
         /// <returns>A size containing the result of the multiplication.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public static Size operator *(Size arg1, Size arg2)
         {
             return arg1.Multiply(arg2);
@@ -178,7 +176,7 @@ namespace Tizen.NUI
         /// <param name="arg1">Size for multiplication.</param>
         /// <param name="arg2">The float value to scale the size.</param>
         /// <returns>A size containing the result of the scaling.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public static Size operator *(Size arg1, float arg2)
         {
             return arg1.Multiply(arg2);
@@ -190,7 +188,7 @@ namespace Tizen.NUI
         /// <param name="arg1">Size for division.</param>
         /// <param name="arg2">The size to divide.</param>
         /// <returns>A size containing the result of the division.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public static Size operator /(Size arg1, Size arg2)
         {
             return arg1.Divide(arg2);
@@ -202,7 +200,7 @@ namespace Tizen.NUI
         /// <param name="arg1">Size for division.</param>
         /// <param name="arg2">The float value to scale the size by.</param>
         /// <returns>A Size containing the result of the scaling.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public static Size operator /(Size arg1, float arg2)
         {
             return arg1.Divide(arg2);
@@ -213,7 +211,7 @@ namespace Tizen.NUI
         /// </summary>
         /// <param name="index">Subscript index.</param>
         /// <returns>The float at the given index.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public float this[uint index]
         {
             get
@@ -232,7 +230,7 @@ namespace Tizen.NUI
         /// <summary>
         /// The constructor.
         /// </summary>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public Size() : this(NDalicPINVOKE.new_Vector3__SWIG_0(), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -244,7 +242,7 @@ namespace Tizen.NUI
         /// <param name="x">The x (or width) component.</param>
         /// <param name="y">The y (or height) component.</param>
         /// <param name="z">The z (or depth) component.</param>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public Size(float x, float y, float z) : this(NDalicPINVOKE.new_Vector3__SWIG_1(x, y, z), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -254,7 +252,7 @@ namespace Tizen.NUI
         /// The constructor.
         /// </summary>
         /// <param name="size2d">Size2D with x (width) and y (height).</param>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public Size(Size2D size2d) : this(NDalicPINVOKE.new_Vector3__SWIG_3(Size2D.getCPtr(size2d)), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -263,7 +261,7 @@ namespace Tizen.NUI
         /// <summary>
         /// The Zero constant, (0.0f, 0.0f, 0.0f).
         /// </summary>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public static Size Zero
         {
             get
@@ -354,7 +352,7 @@ namespace Tizen.NUI
         /// </summary>
         /// <param name="rhs">The size to test against.</param>
         /// <returns>True if the sizes are equal.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public bool EqualTo(Size rhs)
         {
             bool ret = NDalicPINVOKE.Vector3_EqualTo(swigCPtr, Size.getCPtr(rhs));
@@ -368,7 +366,7 @@ namespace Tizen.NUI
         /// </summary>
         /// <param name="rhs">The size to test against.</param>
         /// <returns>True if the sizes are not equal.</returns>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public bool NotEqualTo(Size rhs)
         {
             bool ret = NDalicPINVOKE.Vector3_NotEqualTo(swigCPtr, Size.getCPtr(rhs));
@@ -379,7 +377,7 @@ namespace Tizen.NUI
         /// <summary>
         /// The Width property for the width component of size
         /// </summary>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public float Width
         {
             set
@@ -398,7 +396,7 @@ namespace Tizen.NUI
         /// <summary>
         /// The Height property for the height component of size.
         /// </summary>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public float Height
         {
             set
@@ -417,7 +415,7 @@ namespace Tizen.NUI
         /// <summary>
         /// The Depth property for the depth component of size.
         /// </summary>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public float Depth
         {
             set
@@ -437,7 +435,7 @@ namespace Tizen.NUI
         /// The type cast operator, Size to Vector3.
         /// </summary>
         /// <param name="size">The object of size type.</param>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public static implicit operator Vector3(Size size)
         {
             return new Vector3(size.Width, size.Height, size.Depth);
@@ -447,7 +445,7 @@ namespace Tizen.NUI
         /// The type cast operator, Vector3 to Size type.
         /// </summary>
         /// <param name="vec">The object of Vector3 type.</param>
-        /// <since_tizen> 3 </since_tizen>
+        /// <since_tizen> 5 </since_tizen>
         public static implicit operator Size(Vector3 vec)
         {
             return new Size(vec.Width, vec.Height, vec.Depth);