Release 4.0.0-preview1-00301

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

diff --git a/src/Tizen.NUI/src/public/PropertyNotification.cs b/src/Tizen.NUI/src/public/PropertyNotification.cs
index 1775866..efba44b 100755 (executable)
--- a/src/Tizen.NUI/src/public/PropertyNotification.cs
+++ b/src/Tizen.NUI/src/public/PropertyNotification.cs
@@ -1,18 +1,19 @@
-/** Copyright (c) 2017 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.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 
 namespace Tizen.NUI
 {
@@ -38,6 +39,10 @@ namespace Tizen.NUI
             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
         }
 
+        /// <summary>
+        /// Dispose.
+        /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         protected override void Dispose(DisposeTypes type)
         {
             if (disposed)
@@ -101,7 +106,6 @@ namespace Tizen.NUI
 
         ///<summary>
         /// Event for Notified signal which can be used to subscribe/unsubscribe the event handler
-        /// (in the type of NotifyEventHandler-DaliEventHandler<object,NotifyEventArgs>) provided by the user.
         /// Notified signal is emitted when the notification upon a condition of the property being met, has occurred.
         ///</summary>
         /// <since_tizen> 4 </since_tizen>
@@ -150,8 +154,11 @@ namespace Tizen.NUI
         }
 
         /// <summary>
-        /// Get property notification from Intptr.
+        /// Get property notification from Intptr.<br/>
+        /// This should be internal, please do not use.
         /// </summary>
+        /// <param name="cPtr">An object of IntPtr type.</param>
+        /// <returns>An object of the PropertyNotification type.</returns>
         /// <since_tizen> 4 </since_tizen>
         public static PropertyNotification GetPropertyNotificationFromPtr(global::System.IntPtr cPtr)
         {
@@ -172,6 +179,8 @@ namespace Tizen.NUI
         /// <summary>
         /// Downcast a PropertyNotification instance.
         /// </summary>
+        /// <param name="handle">Handle to an object of BaseHandle type.</param>
+        /// <returns>Handle to an object of the PropertyNotification type.</returns>
         /// <since_tizen> 4 </since_tizen>
         public static PropertyNotification DownCast(BaseHandle handle)
         {
@@ -192,6 +201,8 @@ namespace Tizen.NUI
         /// <summary>
         /// Assign.
         /// </summary>
+        /// <param name="rhs">A reference to the copied handle.</param>
+        /// <returns>A reference to this.</returns>
         /// <since_tizen> 4 </since_tizen>
         public PropertyNotification Assign(PropertyNotification rhs)
         {
@@ -203,6 +214,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Gets the condition of this notification.
         /// </summary>
+        /// <returns>The condition is returned.</returns>
         /// <since_tizen> 4 </since_tizen>
         public PropertyCondition GetCondition()
         {
@@ -225,6 +237,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Gets the target handle's property index that this notification.
         /// </summary>
+        /// <returns>The target property index.</returns>
         /// <since_tizen> 4 </since_tizen>
         public int GetTargetProperty()
         {
@@ -236,6 +249,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Sets the Notification mode.
         /// </summary>
+        /// <param name="mode">mode Notification mode (Default is PropertyNotification::NotifyOnTrue).</param>
         /// <since_tizen> 4 </since_tizen>
         public void SetNotifyMode(PropertyNotification.NotifyMode mode)
         {
@@ -246,6 +260,7 @@ namespace Tizen.NUI
         /// <summary>
         /// Retrieves the current Notification mode.
         /// </summary>
+        /// <returns>Notification mode.</returns>
         /// <since_tizen> 4 </since_tizen>
         public PropertyNotification.NotifyMode GetNotifyMode()
         {
@@ -266,6 +281,10 @@ namespace Tizen.NUI
             return ret;
         }
 
+        /// <summary>
+        /// Connects to this signal to be notified when the notification has occurred.
+        /// </summary>
+        /// <returns>A signal object to Connect() with</returns>
         public PropertyNotifySignal NotifySignal()
         {
             PropertyNotifySignal ret = new PropertyNotifySignal(NDalicPINVOKE.PropertyNotification_NotifySignal(swigCPtr), false);
@@ -279,9 +298,25 @@ namespace Tizen.NUI
         /// <since_tizen> 4 </since_tizen>
         public enum NotifyMode
         {
+            /// <summary>
+            /// Don't notify, regardless of result of Condition
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             Disabled,
+            /// <summary>
+            /// Notify whenever condition changes from false to true.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             NotifyOnTrue,
+            /// <summary>
+            /// Notify whenever condition changes from true to false.
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             NotifyOnFalse,
+            /// <summary>
+            /// Notify whenever condition changes (false to true, and true to false)
+            /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             NotifyOnChanged
         }