/**
* @defgroup Index Index
+ * @ingroup Elementary
*
* @image html img/widget/index/preview-00.png
* @image latex img/widget/index/preview-00.eps
* @addtogroup Index
* @{
*/
-
/**
* Add a new index widget to the given parent Elementary
* (container) object
* @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 int elm_index_item_level_get(const Evas_Object *obj);
/**
+ * Set the selected state of an item.
+ *
+ * @param it The index item
+ * @param selected The selected state
+ *
+ * This sets the selected state of the given item @p it.
+ * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
+ *
+ * If a new item is selected the previously selected will be unselected.
+ * Previously selected item can be get with function
+ * elm_index_selected_item_get().
+ *
+ * Selected items will be highlighted.
+ *
+ * @see elm_index_selected_item_get()
+ *
+ * @ingroup Index
+ */
+EAPI void elm_index_item_selected_set(Elm_Object_Item *it, Eina_Bool selected);
+
+/**
* 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_item_selected_get(const Evas_Object *obj, int level);
+EAPI Elm_Object_Item *elm_index_selected_item_get(const Evas_Object *obj, int level);
/**
* Append a new item on a given index widget.
* @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
* @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
* @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
* @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
* 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
EAPI Eina_Bool elm_index_indicator_disabled_get(const Evas_Object *obj);
/**
+ * Enable or disable horizontal mode on the index object
+ *
+ * @param obj The index object.
+ * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
+ * disable it, i.e., to enable vertical mode. it's an area one @ref Fingers
+ * "finger" wide on the bottom side of the index widget's container.
+ *
+ * @note Vertical mode is set by default.
+ *
+ * On horizontal mode items are displayed on index from left to right,
+ * instead of from top to bottom. Also, the index will scroll horizontally.
+ *
+ * @see elm_index_horizontal_get()
+ *
+ * @ingroup Index
+ */
+EAPI void elm_index_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
+
+/**
+ * Get a value whether horizontal mode is enabled or not.
+ *
+ * @param obj The index object.
+ * @return @c EINA_TRUE means horizontal mode selection is enabled.
+ * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
+ * @c EINA_FALSE is returned.
+ *
+ * @see elm_index_horizontal_set() for details.
+ *
+ * @ingroup Index
+ */
+EAPI Eina_Bool elm_index_horizontal_get(const Evas_Object *obj);
+
+/**
* @}
*/