Release 4.0.0-preview1-00271

[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / WidgetView.cs

diff --git a/src/Tizen.NUI/src/public/WidgetView.cs b/src/Tizen.NUI/src/public/WidgetView.cs
index f7b63d5..47180a5 100755 (executable)
--- a/src/Tizen.NUI/src/public/WidgetView.cs
+++ b/src/Tizen.NUI/src/public/WidgetView.cs
@@ -31,8 +31,8 @@ namespace Tizen.NUI
     using Tizen.NUI.BaseComponents;
 
     /// <summary>
-    /// WidgetView is a class for displaying the widget image and controlling the widget.<br>
-    /// Input events that WidgetView gets are delivered to the widget.
+    /// The WidgetView is a class for displaying the widget image and controlling the widget.<br>
+    /// Input events that the WidgetView gets are delivered to the widget.
     /// </summary>
     public class WidgetView : View
     {
@@ -49,7 +49,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// To make Button instance be disposed.
+        /// To make the Button instance be disposed.
         /// </summary>
         protected override void Dispose(DisposeTypes type)
         {
@@ -95,8 +95,9 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Create a new WidgetView.
+        /// Creates a new WidgetView.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public WidgetView(string widgetId, string contentInfo, int width, int height, float updatePeriod) : this(NDalicManualPINVOKE.WidgetView_New(widgetId, contentInfo, width, height, updatePeriod), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -130,7 +131,7 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Event arguments of widget view.
+        /// Event arguments of the widget view.
         /// </summary>
         public class WidgetViewEventArgs : EventArgs
         {
@@ -139,6 +140,7 @@ namespace Tizen.NUI
             /// <summary>
             /// The widet view.
             /// </summary>
+            /// <since_tizen> 4 </since_tizen>
             public WidgetView WidgetView
             {
                 get
@@ -158,10 +160,11 @@ namespace Tizen.NUI
         private WidgetAddedEventCallbackType _widgetAddedEventCallback;
 
         /// <summary>
-        /// Event for ResourceReady signal which can be used to subscribe/unsubscribe the event handler.<br>
+        /// An event for the ResourceReady signal which can be used to subscribe or unsubscribe the event handler.<br>
         /// This signal is emitted after all resources required by a control are loaded and ready.<br>
-        /// Most resources are only loaded when the control is placed on stage.<br>
+        /// Most resources are only loaded when the control is placed on the stage.<br>
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public event EventHandler<WidgetViewEventArgs> WidgetAdded
         {
             add
@@ -207,10 +210,11 @@ namespace Tizen.NUI
         private WidgetDeletedEventCallbackType _widgetDeletedEventCallback;
 
         /// <summary>
-        /// Event for ResourceReady signal which can be used to subscribe/unsubscribe the event handler.<br>
+        /// An event for the ResourceReady signal which can be used to subscribe or unsubscribe the event handler.<br>
         /// This signal is emitted after all resources required by a control are loaded and ready.<br>
-        /// Most resources are only loaded when the control is placed on stage.<br>
+        /// Most resources are only loaded when the control is placed on the stage.<br>
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public event EventHandler<WidgetViewEventArgs> WidgetDeleted
         {
             add
@@ -256,10 +260,11 @@ namespace Tizen.NUI
         private WidgetCreationAbortedEventCallbackType _widgetCreationAbortedEventCallback;
 
         /// <summary>
-        /// Event for ResourceReady signal which can be used to subscribe/unsubscribe the event handler.<br>
+        /// An event for the ResourceReady signal which can be used to subscribe or unsubscribe the event handler.<br>
         /// This signal is emitted after all resources required by a control are loaded and ready.<br>
-        /// Most resources are only loaded when the control is placed on stage.<br>
+        /// Most resources are only loaded when the control is placed on the stage.<br>
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public event EventHandler<WidgetViewEventArgs> WidgetCreationAborted
         {
             add
@@ -305,10 +310,11 @@ namespace Tizen.NUI
         private WidgetContentUpdatedEventCallbackType _widgetContentUpdatedEventCallback;
 
         /// <summary>
-        /// Event for ResourceReady signal which can be used to subscribe/unsubscribe the event handler.<br>
+        /// An event for the ResourceReady signal which can be used to subscribe or unsubscribe the event handler.<br>
         /// This signal is emitted after all resources required by a control are loaded and ready.<br>
-        /// Most resources are only loaded when the control is placed on stage.<br>
+        /// Most resources are only loaded when the control is placed on the stage.<br>
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public event EventHandler<WidgetViewEventArgs> WidgetContentUpdated
         {
             add
@@ -354,10 +360,11 @@ namespace Tizen.NUI
         private WidgetUpdatePeriodChangedEventCallbackType _widgetUpdatePeriodChangedEventCallback;
 
         /// <summary>
-        /// Event for ResourceReady signal which can be used to subscribe/unsubscribe the event handler.<br>
+        /// An event for the ResourceReady signal which can be used to subscribe or unsubscribe the event handler.<br>
         /// This signal is emitted after all resources required by a control are loaded and ready.<br>
-        /// Most resources are only loaded when the control is placed on stage.<br>
+        /// Most resources are only loaded when the control is placed on the stage.<br>
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public event EventHandler<WidgetViewEventArgs> WidgetUpdatePeriodChanged
         {
             add
@@ -403,10 +410,11 @@ namespace Tizen.NUI
         private WidgetFaultedEventCallbackType _widgetFaultedEventCallback;
 
         /// <summary>
-        /// Event for ResourceReady signal which can be used to subscribe/unsubscribe the event handler.<br>
+        /// An event for the ResourceReady signal which can be used to subscribe or unsubscribe the event handler.<br>
         /// This signal is emitted after all resources required by a control are loaded and ready.<br>
-        /// Most resources are only loaded when the control is placed on stage.<br>
+        /// Most resources are only loaded when the control is placed on the stage.<br>
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public event EventHandler<WidgetViewEventArgs> WidgetFaulted
         {
             add
@@ -449,7 +457,8 @@ namespace Tizen.NUI
         /// <summary>
         /// Pauses a given widget.
         /// </summary>
-        /// <returns>true on success, false otherwise.</returns>
+        /// <returns>True on success, false otherwise.</returns>
+        /// <since_tizen> 4 </since_tizen>
         public bool PauseWidget()
         {
             bool ret = NDalicManualPINVOKE.WidgetView_PauseWidget(swigCPtr);
@@ -458,9 +467,10 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Resume a given widget.
+        /// Resumes a given widget.
         /// </summary>
-        /// <returns>true on success, false otherwise.</returns>
+        /// <returns>True on success, false otherwise.</returns>
+        /// <since_tizen> 4 </since_tizen>
         public bool ResumeWidget()
         {
             bool ret = NDalicManualPINVOKE.WidgetView_ResumeWidget(swigCPtr);
@@ -469,11 +479,12 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Cancels touch event procedure.
+        /// Cancels the touch event procedure.
         /// If you call this function after feed the touch down event, the widget will get ON_HOLD events.
        ///  If a widget gets ON_HOLD event, it will not do anything even if you feed touch up event.
         /// </summary>
-        /// <returns>true on success, false otherwise.</returns>
+        /// <returns>True on success, false otherwise.</returns>
+        /// <since_tizen> 4 </since_tizen>
         public bool CancelTouchEvent()
         {
             bool ret = NDalicManualPINVOKE.WidgetView_CancelTouchEvent(swigCPtr);
@@ -482,9 +493,10 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Activate a widget in faulted state.
-        /// A widget in faulted state MUST be activated before adding the widget.
+        /// Activates a widget in the faulted state.
+        /// A widget in faulted state must be activated before adding the widget.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public void ActivateFaultedWidget()
         {
             NDalicManualPINVOKE.WidgetView_ActivateFaultedWidget(swigCPtr);
@@ -534,8 +546,9 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Gets the id of widget.
+        /// Gets the ID of the widget.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public string WidgetID
         {
             get
@@ -547,8 +560,9 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Gets the id of instance.
+        /// Gets the ID of the instance.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public string InstanceID
         {
             get
@@ -562,6 +576,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Gets the content info.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public string ContentInfo
         {
             get
@@ -575,6 +590,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Gets the title.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public string Title
         {
             get
@@ -588,6 +604,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Gets the update peroid.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public float UpdatePeriod
         {
             get
@@ -599,8 +616,9 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Gets/sets the preview.
+        /// Gets or sets the preview.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public bool Preview
         {
             get
@@ -616,8 +634,9 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Gets/sets the loading text.
+        /// Gets or sets the loading text.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public bool LoadingText
         {
             get
@@ -633,8 +652,9 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Gets/sets whether the widget state is faulted or not.
+        /// Gets or sets whether the widget state is faulted or not.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public bool WidgetStateFaulted
         {
             get
@@ -650,8 +670,9 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Gets/sets whether the widget is permanent delete or not.
+        /// Gets or sets whether the widget is to delete permanently or not.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public bool PermanentDelete
         {
             get
@@ -668,4 +689,4 @@ namespace Tizen.NUI
 
     }
 
-}
+}
\ No newline at end of file