Release 4.0.0-preview1-00301
[platform/core/csapi/tizenfx.git] / src / Tizen.NUI / src / public / UIComponents / Slider.cs
index 3bb0e12..0b70b76 100755 (executable)
@@ -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.UIComponents
 {
@@ -22,7 +23,7 @@ namespace Tizen.NUI.UIComponents
     using Tizen.NUI.BaseComponents;
 
     /// <summary>
-    /// Slider is a control to enable sliding an indicator between two values.
+    /// The slider is a control to enable sliding an indicator between two values.
     /// </summary>
     public class Slider : View
     {
@@ -39,7 +40,7 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Dispose
+        /// Dispose.
         /// </summary>
         protected override void Dispose(DisposeTypes type)
         {
@@ -89,7 +90,7 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Value changed event arguments.
+        /// The ValueChanged event arguments.
         /// </summary>
         public class ValueChangedEventArgs : EventArgs
         {
@@ -97,8 +98,9 @@ namespace Tizen.NUI.UIComponents
             private float _slideValue;
 
             /// <summary>
-            /// Slider.
+            /// The slider.
             /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public Slider Slider
             {
                 get
@@ -112,8 +114,9 @@ namespace Tizen.NUI.UIComponents
             }
 
             /// <summary>
-            /// Slider value.
+            /// The slider value.
             /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public float SlideValue
             {
                 get
@@ -128,7 +131,7 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Sliding finished event arguments.
+        /// The SlidingFinished event arguments.
         /// </summary>
         public class SlidingFinishedEventArgs : EventArgs
         {
@@ -136,8 +139,9 @@ namespace Tizen.NUI.UIComponents
             private float _slideValue;
 
             /// <summary>
-            /// Slider.
+            /// The slider.
             /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public Slider Slider
             {
                 get
@@ -151,8 +155,9 @@ namespace Tizen.NUI.UIComponents
             }
 
             /// <summary>
-            /// Slider value.
+            /// The slider value.
             /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public float SlideValue
             {
                 get
@@ -167,7 +172,7 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Mark reached event arguments.
+        /// The MarkReached event arguments.
         /// </summary>
         public class MarkReachedEventArgs : EventArgs
         {
@@ -175,8 +180,9 @@ namespace Tizen.NUI.UIComponents
             private int _slideValue;
 
             /// <summary>
-            /// Slider.
+            /// The slider.
             /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public Slider Slider
             {
                 get
@@ -190,8 +196,9 @@ namespace Tizen.NUI.UIComponents
             }
 
             /// <summary>
-            /// Slider value.
+            /// The slider value.
             /// </summary>
+            /// <since_tizen> 3 </since_tizen>
             public int SlideValue
             {
                 get
@@ -222,8 +229,9 @@ namespace Tizen.NUI.UIComponents
         private MarkReachedCallbackDelegate _sliderMarkReachedCallbackDelegate;
 
         /// <summary>
-        /// Event emitted when the slider value changes.
+        /// An event emitted when the slider value changes.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public event EventHandlerWithReturnType<object, ValueChangedEventArgs, bool> ValueChanged
         {
             add
@@ -263,8 +271,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Event emitted when the sliding is finished.
+        /// An event emitted when the sliding is finished.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public event EventHandlerWithReturnType<object, SlidingFinishedEventArgs, bool> SlidingFinished
         {
             add
@@ -304,8 +313,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Event emitted when the slider handle reaches a mark.
+        /// An event emitted when the slider handle reaches a mark.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public event EventHandlerWithReturnType<object, MarkReachedEventArgs, bool> MarkReached
         {
             add
@@ -345,10 +355,10 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Get Slider from the pointer.
+        /// Gets the slider from the pointer.
         /// </summary>
-        /// <param name="cPtr">The pointer of Slider</param>
-        /// <returns>Object of Slider type</returns>
+        /// <param name="cPtr">The pointer of the slider.</param>
+        /// <returns>The object of the slider type.</returns>
         internal static Slider GetSliderFromPtr(global::System.IntPtr cPtr)
         {
             Slider ret = new Slider(cPtr, false);
@@ -356,7 +366,7 @@ namespace Tizen.NUI.UIComponents
             return ret;
         }
 
-        internal class Property : global::System.IDisposable
+        internal new class Property : global::System.IDisposable
         {
             private global::System.Runtime.InteropServices.HandleRef swigCPtr;
             protected bool swigCMemOwn;
@@ -386,6 +396,7 @@ namespace Tizen.NUI.UIComponents
                 }
             }
 
+            /// <since_tizen> 3 </since_tizen>
             public void Dispose()
             {
                 //Throw excpetion if Dispose() is called in separate thread.
@@ -461,8 +472,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Creates the Slider control.
+        /// Creates the slider control.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public Slider() : this(NDalicPINVOKE.Slider_New(), true)
         {
             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
@@ -481,12 +493,13 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Downcasts an Object handle to Slider.<br>
-        /// If handle points to a Slider, the downcast produces valid handle.<br>
-        /// If not, the returned handle is left uninitialized.<br>
+        /// Downcasts an object handle to the slider.<br />
+        /// If the handle points to a slider, then the downcast produces a valid handle.<br />
+        /// If not, then the returned handle is left uninitialized.<br />
         /// </summary>
-        /// <param name="handle">Handle to an object</param>
-        /// <returns>Handle to a Slider or an uninitialized handle</returns>
+        /// <param name="handle">The handle to an object.</param>
+        /// <returns>The handle to a slider or an uninitialized handle.</returns>
+        /// <since_tizen> 3 </since_tizen>
         public new static Slider DownCast(BaseHandle handle)
         {
             Slider ret =  Registry.GetManagedBaseHandleFromNativePtr(handle) as Slider;
@@ -516,8 +529,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Lower bound property
+        /// The lower bound property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float LowerBound
         {
             get
@@ -533,8 +547,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Upper bound property
+        /// The upper bound property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float UpperBound
         {
             get
@@ -550,8 +565,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Value property
+        /// The value property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float Value
         {
             get
@@ -567,8 +583,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Track visual property
+        /// The track visual property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap TrackVisual
         {
             get
@@ -584,8 +601,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Handle visual property
+        /// The handle visual property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap HandleVisual
         {
             get
@@ -601,8 +619,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Progress visual property
+        /// The progress visual property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap ProgressVisual
         {
             get
@@ -618,8 +637,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Popup visual property
+        /// The popup visual property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap PopupVisual
         {
             get
@@ -635,8 +655,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Popup arrow visual property
+        /// The popup arrow visual property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public PropertyMap PopupArrowVisual
         {
             get
@@ -652,8 +673,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Disable color property
+        /// The disable color property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public Vector4 DisabledColor
         {
             get
@@ -669,8 +691,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Value presicion property
+        /// The value precision property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public int ValuePrecision
         {
             get
@@ -686,8 +709,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Show popup property
+        /// The show popup property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public bool ShowPopup
         {
             get
@@ -703,8 +727,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Show value property
+        /// The show value property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public bool ShowValue
         {
             get
@@ -720,8 +745,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Marks property
+        /// The marks property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public Tizen.NUI.PropertyArray Marks
         {
             get
@@ -737,8 +763,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Snap to marks property
+        /// The snap to marks property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public bool SnapToMarks
         {
             get
@@ -754,8 +781,9 @@ namespace Tizen.NUI.UIComponents
         }
 
         /// <summary>
-        /// Mark tolerance property
+        /// The mark tolerance property.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public float MarkTolerance
         {
             get
@@ -772,4 +800,4 @@ namespace Tizen.NUI.UIComponents
 
     }
 
-}
+}
\ No newline at end of file