[ACR-564] deprecate unused API

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

diff --git a/src/ElmSharp/ElmSharp/GenListItem.cs b/src/ElmSharp/ElmSharp/GenListItem.cs
index d1f7a85..7cfd23f 100644 (file)
--- a/src/ElmSharp/ElmSharp/GenListItem.cs
+++ b/src/ElmSharp/ElmSharp/GenListItem.cs
@@ -20,8 +20,10 @@ using System.ComponentModel;
 namespace ElmSharp
 {
     /// <summary>
-    /// The type of item's part type.
+    /// The type of the item's part types.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     [Flags]
     public enum GenListItemFieldType
     {
@@ -31,7 +33,7 @@ namespace ElmSharp
         All = 0,
 
         /// <summary>
-        /// The text part type.
+        /// The Text part type.
         /// </summary>
         Text = (1 << 0),
 
@@ -41,7 +43,7 @@ namespace ElmSharp
         Content = (1 << 1),
 
         /// <summary>
-        /// The state of part.
+        /// The State part type.
         /// </summary>
         State = (1 << 2),
 
@@ -53,18 +55,26 @@ namespace ElmSharp
 
     /// <summary>
     /// It inherits <see cref="GenItem"/>.
-    /// A instance to the genlist item added.
-    /// It contains Update() method to update a genlist item which is given.
+    /// A instance to the genlist item is added.
+    /// It contains the Update() method to update a genlist item which is given.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class GenListItem : GenItem
     {
         internal GenListItem(object data, GenItemClass itemClass) : base(data, itemClass)
         {
         }
 
+        internal GenListItem(object data, GenItemClass itemClass, EvasObject parent) : base(data, itemClass, parent)
+        {
+        }
+
         /// <summary>
         /// Gets or sets whether a given genlist item is selected.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public override bool IsSelected
         {
             get
@@ -80,6 +90,8 @@ namespace ElmSharp
         /// <summary>
         /// Gets or sets whether a given genlist item is expanded.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool IsExpanded
         {
             get
@@ -94,11 +106,13 @@ namespace ElmSharp
 
         /// <summary>
         /// Updates the content of an item.
-        /// This updates an item by calling all the <see cref="GenItemClass"/> again to get the content, text, and states.
+        /// This updates an item by calling all <see cref="GenItemClass"/> again to get the content, text, and states.
         /// Use this when the original item data has changed and the changes are desired to reflect.
-        /// To update already realized items, use <see cref="GenList.UpdateRealizedItems"/>.
+        /// To update the already realized items, use <see cref="GenList.UpdateRealizedItems"/>.
         /// </summary>
         /// <seealso cref="GenList.UpdateRealizedItems"/>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public override void Update()
         {
             Interop.Elementary.elm_genlist_item_update(Handle);
@@ -106,22 +120,25 @@ namespace ElmSharp
 
         /// <summary>
         /// Updates the part of an item.
-        /// This updates an item's part by calling item's fetching functions again to get the contents, texts and states.
+        /// This updates an item's part by calling the item's fetching functions again to get the contents, texts, and states.
         /// Use this when the original item data has changed and the changes are desired to be reflected.
         /// To update an item's all property, use <see cref="GenList.UpdateRealizedItems"/>.
         /// </summary>
-        /// <param name="part">The part could be "elm.text", "elm.swalllow.icon", "elm.swallow.end", "elm.swallow.content" and so on. It is also used for globbing to match '*', '?', and '.'. It can be used at updating multi fields.</param>
-        /// <param name="type">The type of item's part type.</param>
+        /// <param name="part">The part could be "elm.text", "elm.swalllow.icon", "elm.swallow.end", "elm.swallow.content", and so on. It is also used for globbing to match '*', '?', and '.'. It can be used for updating multi-fields.</param>
+        /// <param name="type">The type of the item's part type.</param>
         /// <seealso cref="GenList.UpdateRealizedItems"/>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void UpdateField(string part, GenListItemFieldType type)
         {
             Interop.Elementary.elm_genlist_item_fields_update(Handle, part, (uint)type);
         }
 
         /// <summary>
-        /// Demote an item to the end of the list.
+        /// Demotes an item to the end of the list.
         /// </summary>
-        /// <param name="item">The genlistitem object</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void DemoteItem()
         {
             Interop.Elementary.elm_genlist_item_demote(Handle);
@@ -130,6 +147,8 @@ namespace ElmSharp
         /// <summary>
         /// Gets or sets the genlist item's select mode.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public override GenItemSelectionMode SelectionMode
         {
             get
@@ -146,6 +165,8 @@ namespace ElmSharp
         /// Gets the next item in a genlist widget's internal list of items.
         /// </summary>
         /// <seealso cref="Previous"/>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public GenListItem Next
         {
             get
@@ -159,9 +180,11 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Get the previous item in a genlist widget's internal list of items.
+        /// Gets the previous item in a genlist widget's internal list of items.
         /// </summary>
         /// <seealso cref="Next"/>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public GenListItem Previous
         {
             get
@@ -174,6 +197,11 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets the content to be shown in the tooltip item.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         [EditorBrowsable(EditorBrowsableState.Never)]
         public override string Cursor
         {
@@ -194,6 +222,11 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets the style for this item cursor.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         [EditorBrowsable(EditorBrowsableState.Never)]
         public override string CursorStyle
         {
@@ -207,6 +240,11 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets or gets the cursor engine only usage for this item cursor.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         [EditorBrowsable(EditorBrowsableState.Never)]
         public override bool IsUseEngineCursor
         {
@@ -220,19 +258,32 @@ namespace ElmSharp
             }
         }
 
+        /// <summary>
+        /// Sets the text to be shown in the genlist item.
+        /// </summary>
+        /// <param name="tooltip">The text to set in the content.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public override void SetTooltipText(string tooltip)
         {
             Interop.Elementary.elm_genlist_item_tooltip_text_set(Handle, tooltip);
         }
 
+        /// <summary>
+        /// Unsets the tooltip from the item.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public override void UnsetTooltip()
         {
             Interop.Elementary.elm_genlist_item_tooltip_unset(Handle);
         }
 
         /// <summary>
-        /// Gets or sets the style of given genlist item's tooltip.
+        /// Gets or sets the style of the given genlist item's tooltip.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public override string TooltipStyle
         {
             get
@@ -246,8 +297,10 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Gets or sets whether disable size restrictions on an object's tooltip.
+        /// Gets or sets the disable size restrictions on an object's tooltip.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool IsTooltipWindowMode
         {
             get
@@ -261,8 +314,10 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Gets the index of the item. It is only valid once displayed.
+        /// Gets the index of the item. It is only valid, once displayed.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public int Index
         {
             get
@@ -272,8 +327,10 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Gets the depth of expanded item.
+        /// Gets the depth of the expanded item.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public int ExpandedItemDepth
         {
             get
@@ -283,22 +340,26 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Remove all sub-items (children) of the given item.
+        /// Remove all the subitems (children) of the given item.
         /// </summary>
-        /// <remark>
-        /// This removes all items that are children (and their descendants) of the given item it.
-        /// </remark>
+        /// <remarks>
+        /// This removes the items that are the children (and their descendants) of the given item.
+        /// </remarks>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void ClearSubitems()
         {
             Interop.Elementary.elm_genlist_item_subitems_clear(Handle);
         }
 
         /// <summary>
-        /// Update the item class of an item.
+        /// Updates the item class of the item.
         /// This sets another class of the item, changing the way that it is displayed. After changing the item class, <see cref="Update"/> is called on the item.
         /// </summary>
         /// <param name="itemClass">The item class for the item.</param>
         /// <param name="data">The data for the item.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void UpdateItemClass(GenItemClass itemClass, object data)
         {
             Data = data;
@@ -306,6 +367,11 @@ namespace ElmSharp
             Interop.Elementary.elm_genlist_item_item_class_update((IntPtr)Handle, itemClass.UnmanagedPtr);
         }
 
+        /// <summary>
+        /// Sets the content to be shown in the tooltip item.
+        /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         protected override void UpdateTooltipDelegate()
         {
             Interop.Elementary.elm_genlist_item_tooltip_content_cb_set(Handle,
@@ -314,4 +380,4 @@ namespace ElmSharp
                 null);
         }
     }
-}
+}
\ No newline at end of file