[NUI] Make AppBar APIs public
authorJaehyun Cho <jae_hyun.cho@samsung.com>
Wed, 14 Apr 2021 16:03:26 +0000 (01:03 +0900)
committerdongsug-song <35130733+dongsug-song@users.noreply.github.com>
Wed, 28 Apr 2021 03:36:30 +0000 (12:36 +0900)
This is ACR patch to make AppBar APIs public.

This pull request includes properties and methods of AppBar, AppBarStyle
and ContentPage classes.

src/Tizen.NUI.Components/Controls/Navigation/AppBar.cs
src/Tizen.NUI.Components/Controls/Navigation/ContentPage.cs
src/Tizen.NUI.Components/Style/Navigation/AppBarStyle.cs

index bacb4d2..c182e77 100755 (executable)
@@ -1,5 +1,5 @@
 /*
- * Copyright(c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright(c) 2021 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.
@@ -25,7 +25,7 @@ namespace Tizen.NUI.Components
     /// The AppBar class is a class which shows title text and provides navigation
     /// and action functions on Page.
     /// </summary>
-    [EditorBrowsable(EditorBrowsableState.Never)]
+    /// <since_tizen> 9 </since_tizen>
     public class AppBar : Control
     {
         private bool autoNavigationContent = true;
@@ -48,7 +48,7 @@ namespace Tizen.NUI.Components
         /// <summary>
         /// Creates a new instance of AppBar.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public AppBar() : base()
         {
             Initialize();
@@ -58,7 +58,7 @@ namespace Tizen.NUI.Components
         /// Creates a new instance of AppBar.
         /// </summary>
         /// <param name="style">Creates AppBar by special style defined in UX.</param>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public AppBar(string style) : base(style)
         {
             Initialize();
@@ -68,7 +68,7 @@ namespace Tizen.NUI.Components
         /// Creates a new instance of AppBar.
         /// </summary>
         /// <param name="appBarStyle">Creates AppBar by style customized by user.</param>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public AppBar(AppBarStyle appBarStyle) : base(appBarStyle)
         {
             Initialize();
@@ -153,11 +153,12 @@ namespace Tizen.NUI.Components
         }
 
         /// <summary>
-        /// Navigation content of AppBar. NavigationContent is added to Children automatically.
+        /// Navigation content of AppBar.
+        /// NavigationContent is added as a child of AppBar automatically.
         /// If AutoNavigationContent is set to be true and NavigationContent is not set,
         /// then default navigation content is automatically displayed.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public View NavigationContent
         {
             get
@@ -188,10 +189,10 @@ namespace Tizen.NUI.Components
 
         /// <summary>
         /// Title text of AppBar.
-        /// SetTitle sets title text to the default title content.
+        /// Title sets title text to the default title content.
         /// If TitleContent is not TextLabel, then Title does not set title text of the TitleContent.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public string Title
         {
             get
@@ -215,10 +216,11 @@ namespace Tizen.NUI.Components
         }
 
         /// <summary>
-        /// Title content of AppBar. TitleContent is added to Children automatically.
+        /// Title content of AppBar.
+        /// TitleContent is added as a child of AppBar automatically.
         /// If TitleContent is not TextLabel, then Title does not set title text of the TitleContent.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public View TitleContent
         {
             get
@@ -255,10 +257,11 @@ namespace Tizen.NUI.Components
         /// <summary>
         /// Action views of AppBar.
         /// Action views are added to ActionContent of AppBar.
-        /// The Action and ActionButton styles of AppBarStyle are applied to actions only by setting Actions.
-        /// If you do not want to apply Action and ActionButton styles to action views, then please use ActionContent.Add() instead.
+        /// If action views and action buttons are set to Actions, then proper style look for action views and action buttons are automatically applied to action views and action buttons.
+        /// e.g. size, button icon color, etc.
+        /// If you do not want to apply framework's style look for action views and action buttons, then please use ActionContent.Add(actionView) instead of setting Actions.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public IEnumerable<View> Actions
         {
             get
@@ -309,11 +312,12 @@ namespace Tizen.NUI.Components
         }
 
         /// <summary>
-        /// Action content of AppBar. ActionContent is added to Children automatically.
+        /// Action content of AppBar.
+        /// ActionContent is added as a child of AppBar automatically.
         /// Action content contains action views and action buttons by Actions.
         /// The Action and ActionButton styles of AppBarStyle are applied to actions only by setting Actions.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public View ActionContent
         {
             get
@@ -371,7 +375,7 @@ namespace Tizen.NUI.Components
         /// then default navigation content is automatically displayed.
         /// If default navigation content is clicked, it calls navigator pop operation.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public bool AutoNavigationContent
         {
             get
@@ -465,7 +469,7 @@ namespace Tizen.NUI.Components
         /// Applies style to AppBar.
         /// </summary>
         /// <param name="viewStyle">The style to apply.</param>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public override void ApplyStyle(ViewStyle viewStyle)
         {
             styleApplied = false;
@@ -652,4 +656,4 @@ namespace Tizen.NUI.Components
             }
         }
     }
-}
\ No newline at end of file
+}
index b526142..2a0be89 100755 (executable)
@@ -71,10 +71,11 @@ namespace Tizen.NUI.Components
         }
 
         /// <summary>
-        /// AppBar of ContentPage. AppBar is added to Children automatically.
+        /// AppBar of ContentPage.
+        /// AppBar is added as a child of ContentPage automatically.
         /// AppBar is positioned at the top of the Page.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public AppBar AppBar
         {
             get
@@ -106,7 +107,8 @@ namespace Tizen.NUI.Components
         }
 
         /// <summary>
-        /// Content of ContentPage. Content is added to Children automatically.
+        /// Content of ContentPage.
+        /// Content is added as a child of ContentPage automatically.
         /// Content is positioned below AppBar.
         /// Content is resized to fill the full screen except AppBar.
         /// </summary>
index 994e97b..7d12483 100755 (executable)
@@ -23,25 +23,26 @@ namespace Tizen.NUI.Components
     /// <summary>
     /// AppBarStyle is a class which saves AppBar's ux data.
     /// </summary>
-    [EditorBrowsable(EditorBrowsableState.Never)]
+    /// <since_tizen> 9 </since_tizen>
     public class AppBarStyle : ControlStyle
     {
         [EditorBrowsable(EditorBrowsableState.Never)]
         static AppBarStyle() { }
 
         /// <summary>
-        /// Creates a new instance of a AppBarStyle.
+        /// Creates a new instance of an AppBarStyle.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public AppBarStyle() : base()
         {
         }
 
         /// <summary>
-        /// Creates a new instance of a AppBarStyle with style.
+        /// Creates a new instance of an AppBarStyle with style.
+        /// The given style is copied to the new instance.
         /// </summary>
         /// <param name="style">Creates AppBarStyle by style customized by user.</param>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public AppBarStyle(AppBarStyle style) : base(style)
         {
         }
@@ -49,28 +50,28 @@ namespace Tizen.NUI.Components
         /// <summary>
         /// Gets or sets the AppBar Back Button style.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public ButtonStyle BackButton { get; set; } = new ButtonStyle();
 
         /// <summary>
         /// Gets or sets the AppBar Title TextLabel style.
         /// This style is applied if AppBar Title is a TextLabel.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public TextLabelStyle TitleTextLabel { get; set; } = new TextLabelStyle();
 
         /// <summary>
         /// Gets or sets the AppBar Action View style.
         /// This style is applied if AppBar ActionContent's child is a View.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public ViewStyle ActionView { get; set; } = new ViewStyle();
 
         /// <summary>
         /// Gets or sets the AppBar Action Button style.
         /// This style is applied if AppBar ActionContent's child is a Button.
         /// </summary>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public ButtonStyle ActionButton { get; set; } = new ButtonStyle();
 
         /// <summary>
@@ -98,7 +99,7 @@ namespace Tizen.NUI.Components
         /// Style's clone function.
         /// </summary>
         /// <param name="bindableObject">The style that needs to copy.</param>
-        [EditorBrowsable(EditorBrowsableState.Never)]
+        /// <since_tizen> 9 </since_tizen>
         public override void CopyFrom(BindableObject bindableObject)
         {
             base.CopyFrom(bindableObject);