[ACR-564] deprecate unused API
[platform/core/csapi/tizenfx.git] / src / ElmSharp / ElmSharp / Index.cs
old mode 100755 (executable)
new mode 100644 (file)
index f73ec7a..3c4a3ff
@@ -20,18 +20,22 @@ using System.Collections.Generic;
 namespace ElmSharp
 {
     /// <summary>
-    /// An index widget gives you an index for fast access to whichever group of other UI items one might have.
-    /// Inherits Layout
+    /// The Index widget gives you an index for fast access to whichever group of the other UI items one might have.
+    /// Inherits Layout.
     /// </summary>
+    /// <since_tizen> preview </since_tizen>
+    [Obsolete("This has been deprecated in API12")]
     public class Index : Layout
     {
         HashSet<IndexItem> _children = new HashSet<IndexItem>();
         SmartEvent _delayedChanged;
 
         /// <summary>
-        /// Creates and initializes a new instance of Index class.
+        /// Creates and initializes a new instance of the Index class.
         /// </summary>
-        /// <param name="parent">The parent is a given container which will be attached by Index as a child. It's <see cref="EvasObject"/> type.</param>
+        /// <param name="parent">The parent is a given container, which will be attached by Index as a child. It's <see cref="EvasObject"/> type.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public Index(EvasObject parent) : base(parent)
         {
             _delayedChanged = new SmartEvent(this, this.RealHandle, "delay,changed");
@@ -41,11 +45,15 @@ namespace ElmSharp
         /// <summary>
         /// Changed will be triggered when the selected index item is changed.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public event EventHandler Changed;
 
         /// <summary>
-        /// Sets or gets the auto hiding feature is enabled or not for a given index widget.
+        /// Sets or gets whether the auto hiding feature is enabled or not for a given index widget.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool AutoHide
         {
             get
@@ -59,8 +67,10 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Sets or gets a value whether horizontal mode is enabled or not.
+        /// Sets or gets a value whether the horizontal mode is enabled or not.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool IsHorizontal
         {
             get
@@ -74,8 +84,10 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Sets or gets the value of indicator's disabled status.
+        /// Sets or gets a value of the indicator's disabled status.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool IndicatorVisible
         {
             get
@@ -89,8 +101,10 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Sets or gets the omit feature is enabled or not for a given index widget.
+        /// Sets or gets whether the omit feature is enabled or not for a given index widget.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public bool OmitEnabled
         {
             get
@@ -104,9 +118,11 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Set a delay change time for index object.
-        /// delay time is 0.2 sec by default.
+        /// Sets a delay change time for the index object.
+        /// The delay time is 0.2 seconds by default.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public double Delay
         {
             get
@@ -122,6 +138,8 @@ namespace ElmSharp
         /// <summary>
         /// Gets or sets the items level for a given index widget.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public int Level
         {
             get
@@ -135,9 +153,11 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Control standard_priority group of index.
-        /// Priority group will be shown as many items as it can, and other group will be shown one character only.
+        /// Controls the standard_priority group of the index.
+        /// Priority group will be shown as many items as it can, and other group will be shown for one character only.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public int Priority
         {
             get
@@ -151,8 +171,10 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Gets the last selected item, for a given index widget.
+        /// Gets the last selected item for a given index widget.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public IndexItem SelectedItem
         {
             get
@@ -163,72 +185,91 @@ namespace ElmSharp
         }
 
         /// <summary>
-        /// Append a new item on a given index widget.
+        /// Appends a new item on a given index widget.
         /// </summary>
-        /// <param name="label">the label which the item should be indexed</param>
-        /// <returns>A object to the IndexItem added or null, on errors</returns>
+        /// <param name="label">The label for which the item should be indexed.</param>
+        /// <returns>An object to the IndexItem if added, or null on errors.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public IndexItem Append(string label)
         {
-            IndexItem item = new IndexItem(label);
+            IndexItem item = new IndexItem(label, this);
             item.Handle = Interop.Elementary.elm_index_item_append(RealHandle, label, null, (IntPtr)item.Id);
             return item;
         }
 
         /// <summary>
-        /// Prepend a new item on a given index widget.
+        /// Prepends a new item on a given index widget.
         /// </summary>
-        /// <param name="label">the label which the item should be indexed</param>
-        /// <returns>A handle to the item added or NULL, on errors</returns>
+        /// <param name="label">The label for which the item should be indexed.</param>
+        /// <returns>A handle to the item if added, or null on errors.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public IndexItem Prepend(string label)
         {
-            IndexItem item = new IndexItem(label);
+            IndexItem item = new IndexItem(label, this);
             item.Handle = Interop.Elementary.elm_index_item_prepend(RealHandle, label, null, (IntPtr)item.Id);
             return item;
         }
 
         /// <summary>
-        /// Insert a new item into the index object before item before.
+        /// Inserts a new item into the index object before the item before.
         /// </summary>
-        /// <param name="label">the label which the item should be indexed</param>
+        /// <param name="label">The label for which the item should be indexed.</param>
         /// <param name="before">The index item to insert after.</param>
-        /// <returns>A object to the IndexItem added or null, on errors</returns>
+        /// <returns>An object to the IndexItem if added, or null on errors.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public IndexItem InsertBefore(string label, IndexItem before)
         {
-            IndexItem item = new IndexItem(label);
+            IndexItem item = new IndexItem(label, this);
             item.Handle = Interop.Elementary.elm_index_item_insert_before(RealHandle, before, label, null, (IntPtr)item.Id);
             return item;
         }
 
         /// <summary>
-        /// Insert a new item into the index object after item after.
+        /// Inserts a new item into the index object after the item after.
         /// </summary>
-        /// <param name="label">the label which the item should be indexed</param>
+        /// <param name="label">The label for which the item should be indexed.</param>
         /// <param name="after">The index item to insert after.</param>
-        /// <returns>A object to the IndexItem added or null, on errors</returns>
+        /// <returns>An object to the IndexItem if added, or null on errors.</returns>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public IndexItem InsertAfter(string label, IndexItem after)
         {
-            IndexItem item = new IndexItem(label);
+            IndexItem item = new IndexItem(label, this);
             item.Handle = Interop.Elementary.elm_index_item_insert_after(RealHandle, after, label, null, (IntPtr)item.Id);
             return item;
         }
 
         /// <summary>
-        /// Flush the changes made to the index items so they work correctly.
+        /// Flushes the changes made to the index items so that they work correctly.
         /// </summary>
-        /// <param name="level">The index level (one of 0 or 1) where changes were made</param>
+        /// <param name="level">The index level (one of 0 or 1) where the changes were made.</param>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void Update(int level)
         {
             Interop.Elementary.elm_index_level_go(RealHandle, level);
         }
 
         /// <summary>
-        /// Removes all items from a given index widget.
+        /// Removes all the items from a given index widget.
         /// </summary>
+        /// <since_tizen> preview </since_tizen>
+        [Obsolete("This has been deprecated in API12")]
         public void Clear()
         {
             Interop.Elementary.elm_index_item_clear(RealHandle);
         }
 
+        /// <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);
@@ -245,16 +286,5 @@ namespace ElmSharp
             SelectedItem?.SendSelected();
             Changed?.Invoke(this, e);
         }
-
-        void AddInternal(IndexItem item)
-        {
-            _children.Add(item);
-            item.Deleted += Item_Deleted;
-        }
-
-        void Item_Deleted(object sender, EventArgs e)
-        {
-            _children.Remove((IndexItem)sender);
-        }
     }
 }
\ No newline at end of file