[ACR-564] deprecate unused API
[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / TransitEffect.cs
old mode 100755 (executable)
new mode 100644 (file)
index fd29499..cb3ae0d
@@ -20,105 +20,113 @@ using System.Collections.Generic;
 namespace ElmSharp
 {
     /// <summary>
-    /// The axis along which flip effect should be applied.
+    /// Enumeration for the axis along which flip effect should be applied.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public enum FlipAxis
     {
         /// <summary>
-        /// Flip on X axis
+        /// Flip on X-axis.
         /// </summary>
         X,
 
         /// <summary>
-        /// Flip on Y axis
+        /// Flip on Y-axis.
         /// </summary>
         Y,
     }
 
     /// <summary>
-    /// The direction in which the wipe effect should occur.
+    /// Enumeration for the direction in which the wipe effect should occur.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public enum WipeDirection
     {
         /// <summary>
-        /// Wipe to the left
+        /// Wipe to the left.
         /// </summary>
         Left,
 
         /// <summary>
-        /// Wipe to the right
+        /// Wipe to the right.
         /// </summary>
         Right,
 
         /// <summary>
-        /// Wipe to the up
+        /// Wipe to the up.
         /// </summary>
         Up,
 
         /// <summary>
-        /// Wipe to the down
+        /// Wipe to the down.
         /// </summary>
         Down,
     }
 
     /// <summary>
-    /// Whether the wipe effect should show or hide the object.
+    /// Enumeration for whether the wipe effect should show or hide the object.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public enum WipeType
     {
         /// <summary>
-        /// Hide the object during the animation
+        /// Hide the object during the animation.
         /// </summary>
         Hide,
 
         /// <summary>
-        /// Show the object during the animation
+        /// Show the object during the animation.
         /// </summary>
         Show,
     }
 
     /// <summary>
-    /// The type of acceleration used in the transition.
+    /// Enumration for the type of acceleration used in transition.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public enum TweenMode
     {
         /// <summary>
-        /// Constant speed
+        /// Constant speed.
         /// </summary>
         Linear,
 
         /// <summary>
-        /// Starts slow, increase speed over time, then decrease again and stop slowly, v1 being a power factor
+        /// Starts slow, increases speed over time, then decrease again and stop slowly, v1 being a power factor.
         /// </summary>
         Sinusoidal,
 
         /// <summary>
-        /// Starts fast and decrease speed over time, v1 being a power factor
+        /// Starts fast and decreases speed over time, v1 being a power factor.
         /// </summary>
         Decelerate,
 
         /// <summary>
-        /// Starts slow and increase speed over time, v1 being a power factor
+        /// Starts slow and increases speed over time, v1 being a power factor.
         /// </summary>
         Accelerate,
 
         /// <summary>
-        /// Start at gradient v1, interpolated via power of v2 curve
+        /// Starts at gradient v1, interpolated via power of v2 curve.
         /// </summary>
         DivisorInterpolate,
 
         /// <summary>
-        /// Start at 0.0 then "drop" like a ball bouncing to the ground at 1.0, and bounce v2 times, with decay factor of v1
+        /// Starts at 0.0 then "drop" like a ball bouncing to the ground at 1.0, and bounce v2 times, with decay factor of v1.
         /// </summary>
         Bounce,
 
         /// <summary>
-        /// Start at 0.0 then "wobble" like a spring rest position 1.0, and wobble v2 times, with decay factor of v1
+        /// Starts at 0.0 then "wobble" like a spring rest position 1.0, and wobble v2 times, with decay factor of v1.
         /// </summary>
         Spring,
 
         /// <summary>
-        /// Follow the cubic-bezier curve calculated with the control points (x1, y1), (x2, y2)
+        /// Follows the cubic-bezier curve calculated with the control points (x1, y1), (x2, y2).
         /// </summary>
         BezierCurve,
     }
@@ -126,11 +134,15 @@ namespace ElmSharp
     /// <summary>
     /// Blend effect class.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class BlendEffect : EffectBase
     {
         /// <summary>
-        /// Creates and initializes a new instance of BlendEffect class.
+        /// Creates and initializes a new instance of the BlendEffect class.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public BlendEffect()
         {
         }
@@ -144,16 +156,20 @@ namespace ElmSharp
     /// <summary>
     /// Color effect class.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class ColorEffect : EffectBase
     {
         Color _begin;
         Color _end;
 
         /// <summary>
-        /// Creates and initializes a new instance of ColorEffect class.
+        /// Creates and initializes a new instance of the ColorEffect class.
         /// </summary>
-        /// <param name="beginColor">The begin color of the effect</param>
-        /// <param name="endColor">The end color of the effect</param>
+        /// <param name="beginColor">The begin color of the effect.</param>
+        /// <param name="endColor">The end color of the effect.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public ColorEffect(Color beginColor, Color endColor)
         {
             _begin = beginColor;
@@ -161,16 +177,20 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// The begin color of the effect
+        /// The begin color of the effect.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public Color BeginColor
         {
             get { return _begin; }
         }
 
         /// <summary>
-        /// The end color of the effect
+        /// The end color of the effect.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public Color EndColor
         {
             get { return _end; }
@@ -185,11 +205,15 @@ namespace ElmSharp
     /// <summary>
     /// Fade effect class.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class FadeEffect : EffectBase
     {
         /// <summary>
-        /// Creates and initializes a new instance of FadeEffect class.
+        /// Creates and initializes a new instance of the FadeEffect class.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public FadeEffect()
         {
         }
@@ -203,6 +227,8 @@ namespace ElmSharp
     /// <summary>
     /// Flip effect class.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class FlipEffect : EffectBase
     {
         FlipAxis _axis;
@@ -210,11 +236,13 @@ namespace ElmSharp
         bool _resizable;
 
         /// <summary>
-        /// Creates and initializes a new instance of FlipEffect class.
+        /// Creates and initializes a new instance of the FlipEffect class.
         /// </summary>
-        /// <param name="axis">Flipping Axis(X or Y).</param>
-        /// <param name="clockWise">Flipping Direction. True is clock-wise.</param>
-        /// <param name="resizable">Resizable effect with FlipEffect</param>
+        /// <param name="axis">Flipping axis (X or Y).</param>
+        /// <param name="clockWise">Flipping Direction. True is clockwise.</param>
+        /// <param name="resizable">Resizable effect with FlipEffect.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public FlipEffect(FlipAxis axis, bool clockWise, bool resizable = false)
         {
             _axis = axis;
@@ -223,16 +251,20 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Flipping Axis(X or Y).
+        /// Flipping axis (X or Y).
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public FlipAxis Axis
         {
             get { return _axis; }
         }
 
         /// <summary>
-        /// Flipping Direction. True is clock-wise.
+        /// Flipping direction. True is clockwise.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool ClockWise
         {
             get { return _clockWise; }
@@ -241,6 +273,8 @@ namespace ElmSharp
         /// <summary>
         /// Resizable FlipEffect.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool Resizable
         {
             get { return _resizable; }
@@ -257,16 +291,20 @@ namespace ElmSharp
     /// <summary>
     /// Resizing effect class.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class ResizingEffect : EffectBase
     {
         Size _begin;
         Size _end;
 
         /// <summary>
-        /// Creates and initializes a new instance of FlipEffect class.
+        /// Creates and initializes a new instance of the ResizingEffect class.
         /// </summary>
-        /// <param name="beginSize">The begin Size of the effect</param>
-        /// <param name="endSize">The end Size of the effect</param>
+        /// <param name="beginSize">The begin size of the effect.</param>
+        /// <param name="endSize">The end size of the effect.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public ResizingEffect(Size beginSize, Size endSize)
         {
             _begin = beginSize;
@@ -274,16 +312,20 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// The begin Size of the effect
+        /// The begin size of the effect.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public Size BeginSize
         {
             get { return _begin; }
         }
 
         /// <summary>
-        /// The end Size of the effect
+        /// The end size of the effect.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public Size EndSize
         {
             get { return _end; }
@@ -298,16 +340,20 @@ namespace ElmSharp
     /// <summary>
     /// Rotation effect class.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class RotationEffect : EffectBase
     {
         float _begin;
         float _end;
 
         /// <summary>
-        /// Creates and initializes a new instance of RotationEffect class.
+        /// Creates and initializes a new instance of the RotationEffect class.
         /// </summary>
-        /// <param name="beginDegree">The begin degree of the effect</param>
-        /// <param name="endDegree">The end degree of the effect</param>
+        /// <param name="beginDegree">The begin degree of the effect.</param>
+        /// <param name="endDegree">The end degree of the effect.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public RotationEffect(float beginDegree, float endDegree)
         {
             _begin = beginDegree;
@@ -315,16 +361,20 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// The begin degree of the effect
+        /// The begin degree of the effect.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public float BeginDegree
         {
             get { return _begin; }
         }
 
         /// <summary>
-        /// The end degree of the effect
+        /// The end degree of the effect.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public float EndDegree
         {
             get { return _end; }
@@ -339,16 +389,20 @@ namespace ElmSharp
     /// <summary>
     /// Translation effect class.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class TranslationEffect : EffectBase
     {
         Point _begin;
         Point _end;
 
         /// <summary>
-        /// Creates and initializes a new instance of FlipEffect class.
+        /// Creates and initializes a new instance of the TranslationEffect class.
         /// </summary>
-        /// <param name="beginPoint">The begin Point of the effect</param>
-        /// <param name="endPoint">The end Point of the effect</param>
+        /// <param name="beginPoint">The begin point of the effect.</param>
+        /// <param name="endPoint">The end point of the effect.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public TranslationEffect(Point beginPoint, Point endPoint)
         {
             _begin = beginPoint;
@@ -356,16 +410,20 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// The begin Point of the effect
+        /// The begin point of the effect.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public Point BeginPoint
         {
             get { return _begin; }
         }
 
         /// <summary>
-        /// The end Point of the effect
+        /// The end point of the effect.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public Point EndPoint
         {
             get { return _end; }
@@ -380,16 +438,20 @@ namespace ElmSharp
     /// <summary>
     /// Wipe effect class.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class WipeEffect : EffectBase
     {
         WipeType _type;
         WipeDirection _direction;
 
         /// <summary>
-        /// Creates and initializes a new instance of WipeEffect class.
+        /// Creates and initializes a new instance of the WipeEffect class.
         /// </summary>
         /// <param name="type">Wipe type. Hide or show.</param>
-        /// <param name="direction">Wipe Direction.</param>
+        /// <param name="direction">Wipe direction.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public WipeEffect(WipeType type, WipeDirection direction)
         {
             _type = type;
@@ -399,14 +461,18 @@ namespace ElmSharp
         /// <summary>
         /// Wipe type. Hide or show.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public WipeType Type
         {
             get { return _type; }
         }
 
         /// <summary>
-        /// Wipe Direction.
+        /// Wipe direction.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public WipeDirection Direction
         {
             get { return _direction; }
@@ -421,16 +487,20 @@ namespace ElmSharp
     /// <summary>
     /// Zoom effect class.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class ZoomEffect : EffectBase
     {
         float _begin;
         float _end;
 
         /// <summary>
-        /// Creates and initializes a new instance of ZoomEffect class.
+        /// Creates and initializes a new instance of the ZoomEffect class.
         /// </summary>
-        /// <param name="beginRate">The begin rate of the effect</param>
-        /// <param name="endRate">The end rate of the effect</param>
+        /// <param name="beginRate">The begin rate of the effect.</param>
+        /// <param name="endRate">The end rate of the effect.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public ZoomEffect(float beginRate, float endRate)
         {
             _begin = beginRate;
@@ -438,16 +508,20 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// The begin rate of the effect
+        /// The begin rate of the effect.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public float BeginRate
         {
             get { return _begin; }
         }
 
         /// <summary>
-        /// The end rate of the effect
+        /// The end rate of the effect.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public float EndRate
         {
             get { return _end; }