[ACR-564] deprecate unused API

[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / SmartEvent.cs

diff --git a/src/ElmSharp/ElmSharp/SmartEvent.cs b/src/ElmSharp/ElmSharp/SmartEvent.cs
old mode 100755 (executable)
new mode 100644 (file)
index 6edbb7a..d6016bf
--- a/src/ElmSharp/ElmSharp/SmartEvent.cs
+++ b/src/ElmSharp/ElmSharp/SmartEvent.cs
@@ -24,20 +24,24 @@ namespace ElmSharp
     /// <summary>
     /// It inherits <see cref="IInvalidatable"/>.
     /// The event with TEventArgs for <see cref="EvasObject"/>.
-    /// EvasObject can elect SmartEvent occurring inside of them to be reported back to their users via delegates.
+    /// EvasObject can elect the SmartEvent occurring inside them, to be reported back to their users via delegates.
     /// This way, you can extend EvasObject's own <see cref="EvasObjectEvent"/>.
     /// They are defined by an event string, which identifies them uniquely.
     /// </summary>
     /// <typeparam name="TEventArgs">The parameter for the event.</typeparam>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class SmartEvent<TEventArgs> : IInvalidatable where TEventArgs : EventArgs
     {
         /// <summary>
-        /// The delegate for creating smart event item args.
+        /// The delegate for creating smart event item arguments.
         /// </summary>
         /// <param name="data">The item data.</param>
-        /// <param name="obj">The sender obj.</param>
-        /// <param name="info">The item sender obj.</param>
+        /// <param name="obj">The sender object.</param>
+        /// <param name="info">The item sender object.</param>
         /// <returns>Return smart event item args.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public delegate TEventArgs SmartEventInfoParser(IntPtr data, IntPtr obj, IntPtr info);
 
         private EvasObject _sender;
@@ -52,10 +56,21 @@ namespace ElmSharp
         /// <param name="sender">The source of the event.</param>
         /// <param name="eventName">The event name.</param>
         /// <param name="parser">The event parameter.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public SmartEvent(EvasObject sender, string eventName, SmartEventInfoParser parser) : this(sender, sender.Handle, eventName, parser)
         {
         }
 
+        /// <summary>
+        /// Creates and initializes a new instance of the SmartEvent class.
+        /// </summary>
+        /// <param name="sender">The source of the event.</param>
+        /// <param name="handle">Teh event handler.</param>
+        /// <param name="eventName">The event name.</param>
+        /// <param name="parser">The event parser.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         [EditorBrowsableAttribute(EditorBrowsableState.Never)]
         public SmartEvent(EvasObject sender, IntPtr handle, string eventName, SmartEventInfoParser parser)
         {
@@ -71,10 +86,15 @@ namespace ElmSharp
         /// </summary>
         /// <param name="sender">The source of the event.</param>
         /// <param name="eventName">The event name.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public SmartEvent(EvasObject sender, string eventName) : this(sender, eventName, null)
         {
         }
 
+        /// <summary>
+        /// Destroys the SmartEvent object.
+        /// </summary>
         ~SmartEvent()
         {
             Dispose(false);
@@ -87,8 +107,10 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Adds or removes delegate for event.
+        /// Adds or removes a delegate for the event.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public event EventHandler<TEventArgs> On
         {
             add
@@ -123,6 +145,11 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Destroys the current object.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void Dispose()
         {
             Dispose(true);
@@ -130,19 +157,30 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Make current instance invalidate.
+        /// Makes the current instance invalidate.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void MakeInvalidate()
         {
             _sender = null;
             _handle = IntPtr.Zero;
         }
 
+        /// <summary>
+        /// Releases all the resources currently used by this instance.
+        /// </summary>
+        /// <param name="disposing">
+        /// true if the managed resources should be disposed,
+        /// otherwise false.
+        /// </param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         protected virtual void Dispose(bool disposing)
         {
             if (disposing)
             {
-                // Place holder to dispose managed state (managed objects).
+                _sender.RemoveFromEventLifeTracker(this);
             }
             if (_handle != IntPtr.Zero)
             {
@@ -157,14 +195,16 @@ namespace ElmSharp
 
     /// <summary>
     /// It inherits <see cref="IInvalidatable"/>.
-    /// EvasObject can elect SmartEvent occurring inside of them to be reported back to their users via delegates.
+    /// EvasObject can elect the SmartEvent occurring inside them, to be reported back to their users via delegates.
     /// This way, you can extend EvasObject's own <see cref="EvasObjectEvent"/>.
     /// They are defined by an event string, which identifies them uniquely.
     /// </summary>
-    /// <typeparam name="TEventArgs">The parameter for the event.</typeparam>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class SmartEvent : IInvalidatable
     {
         private SmartEvent<EventArgs> _smartEvent;
+
         private event EventHandler _handlers;
 
         /// <summary>
@@ -172,24 +212,39 @@ namespace ElmSharp
         /// </summary>
         /// <param name="sender">The source of the event.</param>
         /// <param name="eventName">The event name.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public SmartEvent(EvasObject sender, string eventName) : this(sender, sender.RealHandle, eventName)
         {
         }
 
+        /// <summary>
+        /// Creates and initializes a new instance of the SmartEvent class.
+        /// </summary>
+        /// <param name="sender">The source of the event.</param>
+        /// <param name="handle">The event handler.</param>
+        /// <param name="eventName">The event name.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         [EditorBrowsableAttribute(EditorBrowsableState.Never)]
         public SmartEvent(EvasObject sender, IntPtr handle, string eventName)
         {
             _smartEvent = new SmartEvent<EventArgs>(sender, handle, eventName, null);
         }
 
+        /// <summary>
+        /// Destroys the SmartEvent object.
+        /// </summary>
         ~SmartEvent()
         {
             Dispose(false);
         }
 
         /// <summary>
-        /// Adds or removes delegate for event.
+        /// Adds or removes a delegate for the event.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public event EventHandler On
         {
             add
@@ -216,6 +271,11 @@ namespace ElmSharp
             _handlers?.Invoke(sender, e);
         }
 
+        /// <summary>
+        /// Destroys the current object.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void Dispose()
         {
             Dispose(true);
@@ -223,13 +283,24 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Make current instance invalidate.
+        /// Makes the current instance invalidate.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void MakeInvalidate()
         {
             _smartEvent.MakeInvalidate();
         }
 
+        /// <summary>
+        /// Releases all the resources currently used by this instance.
+        /// </summary>
+        /// <param name="disposing">
+        /// true if the managed resources should be disposed,
+        /// otherwise false.
+        /// </param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         protected virtual void Dispose(bool disposing)
         {
             if (disposing)
@@ -239,4 +310,4 @@ namespace ElmSharp
             }
         }
     }
-}
+}
\ No newline at end of file