From 966362913602947b6e8406813ff8c7c14ce9f56e Mon Sep 17 00:00:00 2001 From: Jiyun Yang Date: Fri, 11 Oct 2019 20:44:54 +0900 Subject: [PATCH] [NUI] Update documentation on View class (#1070) Signed-off-by: Jiyun Yang --- src/Tizen.NUI/src/public/BaseComponents/View.cs | 78 ++++++++++++++++++++++++- 1 file changed, 75 insertions(+), 3 deletions(-) diff --git a/src/Tizen.NUI/src/public/BaseComponents/View.cs b/src/Tizen.NUI/src/public/BaseComponents/View.cs index 95c2ecd..11d4c09 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/View.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/View.cs @@ -1939,7 +1939,7 @@ namespace Tizen.NUI.BaseComponents } /// - /// The mutually exclusive with BACKGROUND_IMAGE and BACKGROUND type Vector4. + /// The mutually exclusive with "backgroundImage" and "background" type Vector4. /// /// 3 public Color BackgroundColor @@ -1956,7 +1956,7 @@ namespace Tizen.NUI.BaseComponents } /// - /// The mutually exclusive with BACKGROUND_COLOR and BACKGROUND type Map. + /// The mutually exclusive with "backgroundColor" and "background" type Map. /// /// 3 public string BackgroundImage @@ -2592,6 +2592,11 @@ namespace Tizen.NUI.BaseComponents /// /// Gets or sets the size width of the view. /// + /// + /// + /// Animatable - This property can be animated using Animation class. + /// + /// /// 3 public float SizeWidth { @@ -2610,6 +2615,11 @@ namespace Tizen.NUI.BaseComponents /// /// Gets or sets the size height of the view. /// + /// + /// + /// Animatable - This property can be animated using Animation class. + /// + /// /// 3 public float SizeHeight { @@ -2630,6 +2640,11 @@ namespace Tizen.NUI.BaseComponents /// By default, sets the position vector between the parent origin and pivot point (default).
/// If the position inheritance is disabled, sets the world position.
/// + /// + /// + /// Animatable - This property can be animated using Animation class. + /// + /// /// 3 public Position Position { @@ -2648,6 +2663,11 @@ namespace Tizen.NUI.BaseComponents /// /// Gets or sets the position X of the view. /// + /// + /// + /// Animatable - This property can be animated using Animation class. + /// + /// /// 3 public float PositionX { @@ -2665,6 +2685,11 @@ namespace Tizen.NUI.BaseComponents /// /// Gets or sets the position Y of the view. /// + /// + /// + /// Animatable - This property can be animated using Animation class. + /// + /// /// 3 public float PositionY { @@ -2682,6 +2707,11 @@ namespace Tizen.NUI.BaseComponents /// /// Gets or sets the position Z of the view. /// + /// + /// + /// Animatable - This property can be animated using Animation class. + /// + /// /// 3 public float PositionZ { @@ -2714,7 +2744,14 @@ namespace Tizen.NUI.BaseComponents /// Gets or sets the orientation of the view.
/// The view's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
/// - /// This is an asynchronous method. + /// + /// + /// This is an asynchronous method. + /// + /// + /// Animatable - This property can be animated using Animation class. + /// + /// /// 3 public Rotation Orientation { @@ -2746,6 +2783,11 @@ namespace Tizen.NUI.BaseComponents /// /// Gets or sets the scale factor applied to the view.
/// + /// + /// + /// Animatable - This property can be animated using Animation class. + /// + /// /// 3 public Vector3 Scale { @@ -2763,6 +2805,11 @@ namespace Tizen.NUI.BaseComponents /// /// Gets or sets the scale X factor applied to the view. /// + /// + /// + /// Animatable - This property can be animated using Animation class. + /// + /// /// 3 public float ScaleX { @@ -2780,6 +2827,11 @@ namespace Tizen.NUI.BaseComponents /// /// Gets or sets the scale Y factor applied to the view. /// + /// + /// + /// Animatable - This property can be animated using Animation class. + /// + /// /// 3 public float ScaleY { @@ -2797,6 +2849,11 @@ namespace Tizen.NUI.BaseComponents /// /// Gets or sets the scale Z factor applied to the view. /// + /// + /// + /// Animatable - This property can be animated using Animation class. + /// + /// /// 3 public float ScaleZ { @@ -2829,8 +2886,13 @@ namespace Tizen.NUI.BaseComponents /// Retrieves the visibility flag of the view. /// /// + /// /// If the view is not visible, then the view and its children will not be rendered. /// This is regardless of the individual visibility values of the children, i.e., the view will only be rendered if all of its parents have visibility set to true. + /// + /// + /// Animatable - This property can be animated using Animation class. + /// /// /// 3 public bool Visibility @@ -3314,11 +3376,16 @@ namespace Tizen.NUI.BaseComponents /// The views default depth is the minimum of width and height.
/// /// + /// /// Please note that multi-cascade setting is not possible for this NUI object.
/// It is recommended that NUI object typed properties are configured by their constructor with parameters.
/// For example, this code is working fine : view.Size = new Size( 1.0f, 1.0f, 0.0f);
/// but this will not work! : view.Size.Width = 2.0f; view.Size.Height = 2.0f;
/// It may not match the current value in some cases, i.e. when the animation is progressing or the maximum or minimu size is set.
+ /// + /// + /// Animatable - This property can be animated using Animation class. + /// /// /// 5 public Size Size @@ -3579,6 +3646,11 @@ namespace Tizen.NUI.BaseComponents /// /// The Color of View. This is an RGBA value. /// + /// + /// + /// Animatable - This property can be animated using Animation class. + /// + /// /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)] public Color Color -- 2.7.4