elementary/font - actually it doesnt append the font to the hash when font_hash is...
[framework/uifw/elementary.git] / src / lib / elm_index.h
index 992cf57..64c210d 100644 (file)
@@ -1,5 +1,6 @@
 /**
  * @defgroup Index Index
+ * @ingroup Elementary
  *
  * @image html img/widget/index/preview-00.png
  * @image latex img/widget/index/preview-00.eps
@@ -72,7 +73,6 @@ EAPI Evas_Object          *elm_index_add(Evas_Object *parent);
  * @ingroup Index
  */
 EAPI void                  elm_index_autohide_disabled_set(Evas_Object *obj, Eina_Bool disabled);
-EAPI void                  elm_index_active_set(Evas_Object *obj, Eina_Bool active);
 
 /**
  * Get whether auto hiding feature is enabled or not for a given index widget.
@@ -80,12 +80,11 @@ EAPI void                  elm_index_active_set(Evas_Object *obj, Eina_Bool acti
  * @param obj The index object
  * @return @c EINA_TRUE, if auto hiding is disabled, @c EINA_FALSE otherwise
  *
- * @see elm_index_active_set() for more details
+ * @see elm_index_autohide_disabled_set() for more details
  *
  * @ingroup Index
  */
 EAPI Eina_Bool             elm_index_autohide_disabled_get(const Evas_Object *obj);
-EAPI Eina_Bool             elm_index_active_get(const Evas_Object *obj);
 
 /**
  * Set the items level for a given index widget.
@@ -126,7 +125,6 @@ EAPI int                   elm_index_item_level_get(const Evas_Object *obj);
  *
  * Selected items will be highlighted.
  *
- * @see elm_index_item_selected_get()
  * @see elm_index_selected_item_get()
  *
  * @ingroup Index
@@ -137,12 +135,12 @@ EAPI void                  elm_index_item_selected_set(Elm_Object_Item *it, Eina
  * Returns the last selected item, for a given index widget.
  *
  * @param obj The index object.
+ * @param level @c 0 or @c 1, the currently implemented levels.
  * @return The last item @b selected on @p obj (or @c NULL, on errors).
  *
  * @ingroup Index
  */
 EAPI Elm_Object_Item      *elm_index_selected_item_get(const Evas_Object *obj, int level);
-EAPI Elm_Object_Item      *elm_index_item_selected_get(const Evas_Object *obj, int level);
 
 /**
  * Append a new item on a given index widget.
@@ -151,7 +149,7 @@ EAPI Elm_Object_Item      *elm_index_item_selected_get(const Evas_Object *obj, i
  * @param letter Letter under which the item should be indexed
  * @param func The function to call when the item is selected.
  * @param data The item data to set for the index's item
- * @return A handle to the item added or @c NULL, on errors 
+ * @return A handle to the item added or @c NULL, on errors
  *
  * Despite the most common usage of the @p letter argument is for
  * single char strings, one could use arbitrary strings as index
@@ -162,7 +160,7 @@ EAPI Elm_Object_Item      *elm_index_item_selected_get(const Evas_Object *obj, i
  *
  * @ingroup Index
  */
-EAPI Elm_Object_Item      *elm_index_item_append(Evas_Object *obj, const char *letter, const void *data);
+EAPI Elm_Object_Item      *elm_index_item_append(Evas_Object *obj, const char *letter, Evas_Smart_Cb func, const void *data);
 
 /**
  * Prepend a new item on a given index widget.
@@ -171,7 +169,7 @@ EAPI Elm_Object_Item      *elm_index_item_append(Evas_Object *obj, const char *l
  * @param letter Letter under which the item should be indexed
  * @param func The function to call when the item is selected.
  * @param data The item data to set for the index's item
- * @return A handle to the item added or @c NULL, on errors 
+ * @return A handle to the item added or @c NULL, on errors
  *
  * Despite the most common usage of the @p letter argument is for
  * single char strings, one could use arbitrary strings as index
@@ -182,7 +180,7 @@ EAPI Elm_Object_Item      *elm_index_item_append(Evas_Object *obj, const char *l
  *
  * @ingroup Index
  */
-EAPI Elm_Object_Item      *elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *data);
+EAPI Elm_Object_Item      *elm_index_item_prepend(Evas_Object *obj, const char *letter, Evas_Smart_Cb func, const void *data);
 
 /**
  * Insert a new item into the index object after item @p after.
@@ -192,7 +190,7 @@ EAPI Elm_Object_Item      *elm_index_item_prepend(Evas_Object *obj, const char *
  * @param letter Letter under which the item should be indexed
  * @param func The function to call when the item is clicked.
  * @param data The item data to set for the index's item
- * @return A handle to the item added or @c NULL, on errors 
+ * @return A handle to the item added or @c NULL, on errors
  *
  * Despite the most common usage of the @p letter argument is for
  * single char strings, one could use arbitrary strings as index
@@ -207,7 +205,6 @@ EAPI Elm_Object_Item      *elm_index_item_prepend(Evas_Object *obj, const char *
  * @ingroup Index
  */
 EAPI Elm_Object_Item      *elm_index_item_insert_after(Evas_Object *obj, Elm_Object_Item *after, const char *letter, Evas_Smart_Cb func, const void *data);
-EAPI Elm_Object_Item      *elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *data, const Elm_Object_Item *relative);
 
 /**
  * Insert a new item into the index object before item @p before.
@@ -217,7 +214,7 @@ EAPI Elm_Object_Item      *elm_index_item_append_relative(Evas_Object *obj, cons
  * @param letter Letter under which the item should be indexed
  * @param func The function to call when the item is clicked.
  * @param data The item data to set for the index's item
- * @return A handle to the item added or @c NULL, on errors 
+ * @return A handle to the item added or @c NULL, on errors
  *
  * Despite the most common usage of the @p letter argument is for
  * single char strings, one could use arbitrary strings as index
@@ -232,7 +229,6 @@ EAPI Elm_Object_Item      *elm_index_item_append_relative(Evas_Object *obj, cons
  * @ingroup Index
  */
 EAPI Elm_Object_Item      *elm_index_item_insert_before(Evas_Object *obj, Elm_Object_Item *before, const char *letter, Evas_Smart_Cb func, const void *data);
-EAPI Elm_Object_Item      *elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *data, const Elm_Object_Item *relative);
 
 /**
  * Insert a new item into the given index widget, using @p cmp_func
@@ -256,7 +252,7 @@ EAPI Elm_Object_Item      *elm_index_item_prepend_relative(Evas_Object *obj, con
  * because all references to it will be lost. If this function is
  * not provided (@c NULL is given), index items will be @b
  * duplicated, if @p cmp_func returns @c 0.
- * @return A handle to the item added or @c NULL, on errors 
+ * @return A handle to the item added or @c NULL, on errors
  *
  * Despite the most common usage of the @p letter argument is for
  * single char strings, one could use arbitrary strings as index
@@ -267,7 +263,7 @@ EAPI Elm_Object_Item      *elm_index_item_prepend_relative(Evas_Object *obj, con
  *
  * @ingroup Index
  */
-EAPI Elm_Object_Item     *elm_index_item_sorted_insert(Evas_Object *obj, const char *letter, const void *data, Eina_Compare_Cb cmp_func, Eina_Compare_Cb cmp_data_func);
+EAPI Elm_Object_Item      *elm_index_item_sorted_insert(Evas_Object *obj, const char *letter, Evas_Smart_Cb func, const void *data, Eina_Compare_Cb cmp_func, Eina_Compare_Cb cmp_data_func);
 
 /**
  * Find a given index widget's item, <b>using item data</b>.
@@ -301,7 +297,6 @@ EAPI void                  elm_index_item_clear(Evas_Object *obj);
  * @ingroup Index
  */
 EAPI void                  elm_index_level_go(Evas_Object *obj, int level);
-EAPI void                  elm_index_item_go(Evas_Object *obj, int level);
 
 /**
  * Get the letter (string) set on a given index widget item.