[ACR-564] deprecate unused API

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

diff --git a/src/ElmSharp/ElmSharp/GenItemClass.cs b/src/ElmSharp/ElmSharp/GenItemClass.cs
index 17fe11a..051cbfc 100644 (file)
--- a/src/ElmSharp/ElmSharp/GenItemClass.cs
+++ b/src/ElmSharp/ElmSharp/GenItemClass.cs
@@ -18,12 +18,16 @@ using System;
 using System.Collections.Generic;
 using System.Runtime.InteropServices;
 
+using Tizen.Internals;
+
 namespace ElmSharp
 {
     /// <summary>
     /// It represents the GenGrid or GenList item class definition field details.
-    /// It has some display styles, such as "default", "full" and "group_index".
+    /// It has some display styles, such as "default", "full", and "group_index".
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class GenItemClass : IDisposable
     {
         static Dictionary<IntPtr, EvasObject> s_HandleToEvasObject = new Dictionary<IntPtr, EvasObject>();
@@ -34,6 +38,8 @@ namespace ElmSharp
         /// <param name="data">The item data.</param>
         /// <param name="part">The part where the data should be shown.</param>
         /// <returns>Return string that should be shown.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public delegate string GetTextDelegate(object data, string part);
 
         /// <summary>
@@ -42,12 +48,16 @@ namespace ElmSharp
         /// <param name="data">The item data.</param>
         /// <param name="part">The part where the data should be shown.</param>
         /// <returns>Return content that should be shown.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public delegate EvasObject GetContentDelegate(object data, string part);
 
         /// <summary>
         /// The delegate to define <see cref="DeleteHandler"/>.
         /// </summary>
         /// <param name="data">The item data.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public delegate void DeleteDelegate(object data);
 
         /// <summary>
@@ -55,8 +65,10 @@ namespace ElmSharp
         /// </summary>
         /// <param name="data">The item data.</param>
         /// <param name="part">The part where the data should be shown.</param>
-        /// <param name="old">The content has been added in gengrid.</param>
+        /// <param name="old">The content that has been added in gengrid.</param>
         /// <returns>Return content that should be shown.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public delegate EvasObject GetReusableContentDelegate(object data, string part, EvasObject old);
 
         ItemClass _itemClass;
@@ -67,6 +79,8 @@ namespace ElmSharp
         /// Creates and initializes a new instance of the GenItemClass.
         /// </summary>
         /// <param name="style">The item display style.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public GenItemClass(string style)
         {
             _style = style;
@@ -83,6 +97,9 @@ namespace ElmSharp
             ReleaseItemClass(unmanaged);
         }
 
+        /// <summary>
+        /// Destroys the GenItemClass object.
+        /// </summary>
         ~GenItemClass()
         {
             Dispose(false);
@@ -91,30 +108,40 @@ namespace ElmSharp
         /// <summary>
         /// Gets the item style.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public string ItemStyle { get { return _style; } }
 
         /// <summary>
-        /// Gets or sets the callback that defines how to display item text.
+        /// Gets or sets the callback that defines how to display the item text.
         /// If get, return <see cref="GetTextDelegate"/>.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public GetTextDelegate GetTextHandler { get; set; }
 
         /// <summary>
-        /// Gets or sets the callback that defines how to display item content.
+        /// Gets or sets the callback that defines how to display the item content.
         /// If get, return <see cref="GetContentDelegate"/>.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public GetContentDelegate GetContentHandler { get; set; }
 
         /// <summary>
-        /// Gets or sets the callback that defines how to delete item text and content.
+        /// Gets or sets the callback that defines how to delete the item text and content.
         /// If get, return <see cref="DeleteDelegate"/>.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public DeleteDelegate DeleteHandler { get; set; }
 
         /// <summary>
-        /// Gets or sets the callback that defines how to reuse item content.
+        /// Gets or sets the callback that defines how to reuse the item content.
         /// If get, return <see cref="GetReusableContentDelegate"/>.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public GetReusableContentDelegate ReusableContentHandler { get; set; }
 
         internal IntPtr UnmanagedPtr
@@ -130,6 +157,15 @@ namespace ElmSharp
             }
         }
 
+        /// <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 (_unmanagedPtr != IntPtr.Zero)
@@ -139,6 +175,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);
@@ -151,11 +192,23 @@ namespace ElmSharp
             DeleteHandler?.Invoke(data);
         }
 
+        /// <summary>
+        /// Creates a new GenList item class in a given GenList widget.
+        /// </summary>
+        /// <returns>The new item class object.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         protected virtual IntPtr CreateItemClass()
         {
             return Interop.Elementary.elm_genlist_item_class_new();
         }
 
+        /// <summary>
+        /// Removes an item class in a given GenList widget.
+        /// </summary>
+        /// <param name="unmanagedPtr">The object to be removed.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         protected virtual void ReleaseItemClass(IntPtr unmanagedPtr)
         {
             Interop.Elementary.elm_genlist_item_class_free(unmanagedPtr);
@@ -181,8 +234,8 @@ namespace ElmSharp
 
         void EvasObjectDeleted(object sender, EventArgs e)
         {
-            IntPtr handle = (sender as EvasObject).Handle;
-            s_HandleToEvasObject.Remove(handle);
+            if (sender is EvasObject evasObject)
+                s_HandleToEvasObject.Remove(evasObject);
         }
 
         IntPtr GetReusableContentCallback(IntPtr data, IntPtr obj, IntPtr part, IntPtr old)
@@ -207,36 +260,72 @@ namespace ElmSharp
         }
     }
 
+    /// <summary>
+    /// It represents the gengrid item class definition field details.
+    /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class GenGridItemClass : GenItemClass
     {
+        /// <summary>
+        /// Create the GenGridItemClass instance.
+        /// </summary>
+        /// <param name="style">The item display style.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public GenGridItemClass(string style) : base(style)
         {
         }
 
+        /// <summary>
+        /// Adds a new gengrid item class in a given GenGrid widget.
+        /// </summary>
+        /// <returns>The new instance.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         protected override IntPtr CreateItemClass()
         {
             return Interop.Elementary.elm_gengrid_item_class_new();
         }
 
+        /// <summary>
+        /// Removes the item class in a given GenGrid widget.
+        /// </summary>
+        /// <param name="unmanagedPtr">The object to be removed.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         protected override void ReleaseItemClass(IntPtr unmanagedPtr)
         {
             Interop.Elementary.elm_gengrid_item_class_free(unmanagedPtr);
         }
     }
 
+    [NativeStruct("Elm_Gen_Item_Class", Include = "Elementary.h", PkgConfig = "elementary")]
     [StructLayout(LayoutKind.Sequential)]
     internal class ItemClass
     {
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public delegate string GetTextCallback(IntPtr data, IntPtr obj, IntPtr part);
 
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public delegate IntPtr GetContentCallback(IntPtr data, IntPtr obj, IntPtr part);
 
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public delegate int GetStateCallback(IntPtr data, IntPtr obj, IntPtr part);
 
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public delegate void DelCallback(IntPtr data, IntPtr obj);
 
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public delegate int FilterCallback(IntPtr data, IntPtr obj, IntPtr key);
 
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public delegate IntPtr GetReusableContentCallback(IntPtr data, IntPtr obj, IntPtr part, IntPtr old);
 
         public int version;