[ACR-564] deprecate unused API
[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / ProgressBar.cs
old mode 100755 (executable)
new mode 100644 (file)
index d0121e6..4a1ed92
@@ -19,8 +19,10 @@ using System;
 namespace ElmSharp
 {
     /// <summary>
-    /// The ProgressBar is a widget for visually representing the progress status of a given job/task.
+    /// The ProgressBar is a widget for visually representing the progress status of a given job or task.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class ProgressBar : Layout
     {
         SmartEvent _changed;
@@ -29,6 +31,8 @@ namespace ElmSharp
         /// Creates and initializes a new instance of the ProgressBar class.
         /// </summary>
         /// <param name="parent">The EvasObject to which the new ProgressBar will be attached as a child.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public ProgressBar(EvasObject parent) : base(parent)
         {
             _changed = new SmartEvent(this, this.RealHandle, "changed");
@@ -39,21 +43,25 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// ValueChanged will be triggered when value of ProgressBar change.
+        /// ValueChanged will be triggered when the value of the ProgressBar changes.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public event EventHandler ValueChanged;
 
         /// <summary>
-        /// Sets or gets the value wheather a given ProgressBar widget is at the "pulsing mode".
+        /// Sets or gets the value whether a given ProgressBar widget is at the "pulsing mode".
         /// </summary>
         /// <remarks>
         /// By default, progress bars display values from low to high value boundaries.
         /// There are, though, contexts in which the progress of a given task is unknown.
-        /// For such cases, one can set a progress bar widget to a "pulsing state",
+        /// For such cases, one can set the progress bar widget to a "pulsing state",
         /// to give the user an idea that some computation is being held,
-        /// but without exact progress values. In the default theme,
+        /// but without the exact progress values. In the default theme,
         /// it animates its bar with the contents filling in constantly and back to non-filled, in a loop.
         /// </remarks>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool IsPulseMode
         {
             get
@@ -67,13 +75,15 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Sets or gets the value of ProgressBar.
+        /// Sets or gets the value of the ProgressBar.
         /// </summary>
         /// <remarks>
         /// Use this property to set the progress bar levels.
-        /// If you pass a value out of the specified range(0.0~1.0),
+        /// If you pass a value out of the specified range (0.0~1.0),
         /// it is interpreted as the closest of the boundary values in the range.
         /// </remarks>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public double Value
         {
             get
@@ -87,8 +97,10 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Sets or gets the span value of ProgressBar.
+        /// Sets or gets the span value of the ProgressBar.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public int SpanSize
         {
             get
@@ -102,8 +114,10 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Sets or gets the value wheather a given ProgressBar widget is horizontal.
+        /// Sets or gets the value whether a given ProgressBar widget is horizontal.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool IsHorizontal
         {
             get
@@ -119,6 +133,8 @@ namespace ElmSharp
         /// <summary>
         /// Sets or gets the value whether a given progress bar widget's displaying values are inverted.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool IsInverted
         {
             get
@@ -132,15 +148,16 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Sets or gets format string for a given progress bar widget's units label.
+        /// Sets or gets the format string for a given progress bar widget's units label.
         /// </summary>
         /// <remarks>
-        /// If NULL is passed on format, it makes obj units area to be hidden completely.
+        /// If null is passed on format, it makes the object units area to be hidden completely.
         /// If not, it sets the format string for the units label's text.
-        /// The units label is provided with a floating point value, so the units text displays at most one floating point value.
+        /// The units label are provided with a floating point value, so the units text displays at the most one floating point value.
         /// Note that the units label is optional. Use a format string such as "%1.2f meters" for example.
-        /// The default format string for a progress bar is an integer percentage, as in "%.0f %%".
         /// </remarks>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public string UnitFormat
         {
             get
@@ -156,11 +173,17 @@ namespace ElmSharp
         /// <summary>
         /// Starts a given progress bar "pulsing" animation, if its under that mode.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void PlayPulse()
         {
             Interop.Elementary.elm_progressbar_pulse(RealHandle, true);
         }
 
+        /// <summary>
+        /// Stops a given progress bar "pulsing" animation, if its under that mode.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
         [Obsolete("use StopPulse instead")]
         public void StopPluse()
         {
@@ -170,31 +193,61 @@ namespace ElmSharp
         /// <summary>
         /// Stops a given progress bar "pulsing" animation, if its under that mode.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void StopPulse()
         {
             Interop.Elementary.elm_progressbar_pulse(RealHandle, false);
         }
 
         /// <summary>
-        /// Gets the part value of the given part of the Progressbar.
+        /// Gets the part value of a given part of the Progressbar.
         /// </summary>
         /// <param name="part">Part of the Progressbar.</param>
-        /// <returns>Returns value range is from 0.0 to 1.0.</returns>
+        /// <returns>Value range is from 0.0 to 1.0.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public double GetPartValue(string part)
         {
             return Interop.Elementary.elm_progressbar_part_value_get(RealHandle, part);
         }
 
         /// <summary>
-        /// Sets the part value of the give part of the Progressbar.
+        /// Sets or gets the general or main color of the given Progressbar.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
+        public override Color Color
+        {
+            get
+            {
+                return GetPartColor("bar");
+            }
+            set
+            {
+                SetPartColor("bar", value);
+            }
+        }
+
+        /// <summary>
+        /// Sets the part value of a given part of the Progressbar.
         /// </summary>
         /// <param name="part">Part of the Progressbar.</param>
         /// <param name="value">Value range is from 0.0 to 1.0.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void SetPartValue(string part, double value)
         {
             Interop.Elementary.elm_progressbar_part_value_set(RealHandle, part, value);
         }
 
+        /// <summary>
+        /// Creates a widget handle.
+        /// </summary>
+        /// <param name="parent">Parent EvasObject.</param>
+        /// <returns>Handle IntPtr.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         protected override IntPtr CreateHandle(EvasObject parent)
         {
             IntPtr handle = Interop.Elementary.elm_layout_add(parent.Handle);