2 * @defgroup Index Index
4 * @image html img/widget/index/preview-00.png
5 * @image latex img/widget/index/preview-00.eps
7 * An index widget gives you an index for fast access to whichever
8 * group of other UI items one might have. It's a list of text
9 * items (usually letters, for alphabetically ordered access).
11 * Index widgets are by default hidden and just appear when the
12 * user clicks over it's reserved area in the canvas. In its
13 * default theme, it's an area one @ref Fingers "finger" wide on
14 * the right side of the index widget's container.
16 * When items on the index are selected, smart callbacks get
17 * called, so that its user can make other container objects to
18 * show a given area or child object depending on the index item
19 * selected. You'd probably be using an index together with @ref
20 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
23 * Smart events one can add callbacks for are:
24 * - @c "changed" - When the selected index item changes. @c
25 * event_info is the selected item's data pointer.
26 * - @c "delay,changed" - When the selected index item changes, but
27 * after a small idling period. @c event_info is the selected
28 * item's data pointer.
29 * - @c "selected" - When the user releases a mouse button and
30 * selects an item. @c event_info is the selected item's data
32 * - @c "level,up" - when the user moves a finger from the first
33 * level to the second level
34 * - @c "level,down" - when the user moves a finger from the second
35 * level to the first level
37 * The @c "delay,changed" event is so that it'll wait a small time
38 * before actually reporting those events and, moreover, just the
39 * last event happening on those time frames will actually be
42 * Here are some examples on its usage:
43 * @li @ref index_example_01
44 * @li @ref index_example_02
52 * Add a new index widget to the given parent Elementary
55 * @param parent The parent object
56 * @return a new index widget handle or @c NULL, on errors
58 * This function inserts a new index widget on the canvas.
62 EAPI Evas_Object *elm_index_add(Evas_Object *parent);
65 * Enable or disable auto hiding feature for a given index widget.
67 * @param obj The index object
68 * @param disabled @c EINA_TRUE to disable auto hiding, @c EINA_FALSE to enable
70 * @see elm_index_autohide_disabled_get()
74 EAPI void elm_index_autohide_disabled_set(Evas_Object *obj, Eina_Bool disabled);
77 * Get whether auto hiding feature is enabled or not for a given index widget.
79 * @param obj The index object
80 * @return @c EINA_TRUE, if auto hiding is disabled, @c EINA_FALSE otherwise
82 * @see elm_index_autohide_disabled_set() for more details
86 EAPI Eina_Bool elm_index_autohide_disabled_get(const Evas_Object *obj);
89 * Set the items level for a given index widget.
91 * @param obj The index object.
92 * @param level @c 0 or @c 1, the currently implemented levels.
94 * @see elm_index_item_level_get()
98 EAPI void elm_index_item_level_set(Evas_Object *obj, int level);
101 * Get the items level set for a given index widget.
103 * @param obj The index object.
104 * @return @c 0 or @c 1, which are the levels @p obj might be at.
106 * @see elm_index_item_level_set() for more information
110 EAPI int elm_index_item_level_get(const Evas_Object *obj);
113 * Set the selected state of an item.
115 * @param it The index item
116 * @param selected The selected state
118 * This sets the selected state of the given item @p it.
119 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
121 * If a new item is selected the previously selected will be unselected.
122 * Previously selected item can be get with function
123 * elm_index_selected_item_get().
125 * Selected items will be highlighted.
127 * @see elm_index_selected_item_get()
131 EAPI void elm_index_item_selected_set(Elm_Object_Item *it, Eina_Bool selected);
134 * Returns the last selected item, for a given index widget.
136 * @param obj The index object.
137 * @return The last item @b selected on @p obj (or @c NULL, on errors).
141 EAPI Elm_Object_Item *elm_index_selected_item_get(const Evas_Object *obj, int level);
144 * Append a new item on a given index widget.
146 * @param obj The index object.
147 * @param letter Letter under which the item should be indexed
148 * @param func The function to call when the item is selected.
149 * @param data The item data to set for the index's item
150 * @return A handle to the item added or @c NULL, on errors
152 * Despite the most common usage of the @p letter argument is for
153 * single char strings, one could use arbitrary strings as index
156 * @c item will be the pointer returned back on @c "changed", @c
157 * "delay,changed" and @c "selected" smart events.
161 EAPI Elm_Object_Item *elm_index_item_append(Evas_Object *obj, const char *letter, Evas_Smart_Cb func, const void *data);
164 * Prepend a new item on a given index widget.
166 * @param obj The index object.
167 * @param letter Letter under which the item should be indexed
168 * @param func The function to call when the item is selected.
169 * @param data The item data to set for the index's item
170 * @return A handle to the item added or @c NULL, on errors
172 * Despite the most common usage of the @p letter argument is for
173 * single char strings, one could use arbitrary strings as index
176 * @c item will be the pointer returned back on @c "changed", @c
177 * "delay,changed" and @c "selected" smart events.
181 EAPI Elm_Object_Item *elm_index_item_prepend(Evas_Object *obj, const char *letter, Evas_Smart_Cb func, const void *data);
184 * Insert a new item into the index object after item @p after.
186 * @param obj The index object.
187 * @param after The index item to insert after.
188 * @param letter Letter under which the item should be indexed
189 * @param func The function to call when the item is clicked.
190 * @param data The item data to set for the index's item
191 * @return A handle to the item added or @c NULL, on errors
193 * Despite the most common usage of the @p letter argument is for
194 * single char strings, one could use arbitrary strings as index
197 * @c item will be the pointer returned back on @c "changed", @c
198 * "delay,changed" and @c "selected" smart events.
200 * @note If @p relative is @c NULL this function will behave as
201 * elm_index_item_append().
205 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);
208 * Insert a new item into the index object before item @p before.
210 * @param obj The index object.
211 * @param before The index item to insert after.
212 * @param letter Letter under which the item should be indexed
213 * @param func The function to call when the item is clicked.
214 * @param data The item data to set for the index's item
215 * @return A handle to the item added or @c NULL, on errors
217 * Despite the most common usage of the @p letter argument is for
218 * single char strings, one could use arbitrary strings as index
221 * @c item will be the pointer returned back on @c "changed", @c
222 * "delay,changed" and @c "selected" smart events.
224 * @note If @p relative is @c NULL this function will behave as
225 * elm_index_item_prepend().
229 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);
232 * Insert a new item into the given index widget, using @p cmp_func
233 * function to sort items (by item handles).
235 * @param obj The index object.
236 * @param letter Letter under which the item should be indexed
237 * @param func The function to call when the item is clicked.
238 * @param data The item data to set for the index's item
239 * @param cmp_func The comparing function to be used to sort index
240 * items <b>by #index item handles</b>
241 * @param cmp_data_func A @b fallback function to be called for the
242 * sorting of index items <b>by item data</b>). It will be used
243 * when @p cmp_func returns @c 0 (equality), which means an index
244 * item with provided item data already exists. To decide which
245 * data item should be pointed to by the index item in question, @p
246 * cmp_data_func will be used. If @p cmp_data_func returns a
247 * non-negative value, the previous index item data will be
248 * replaced by the given @p item pointer. If the previous data need
249 * to be freed, it should be done by the @p cmp_data_func function,
250 * because all references to it will be lost. If this function is
251 * not provided (@c NULL is given), index items will be @b
252 * duplicated, if @p cmp_func returns @c 0.
253 * @return A handle to the item added or @c NULL, on errors
255 * Despite the most common usage of the @p letter argument is for
256 * single char strings, one could use arbitrary strings as index
259 * @c item will be the pointer returned back on @c "changed", @c
260 * "delay,changed" and @c "selected" smart events.
264 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);
267 * Find a given index widget's item, <b>using item data</b>.
269 * @param obj The index object
270 * @param data The item data pointed to by the desired index item
271 * @return The index item handle, if found, or @c NULL otherwise
275 EAPI Elm_Object_Item *elm_index_item_find(Evas_Object *obj, const void *data);
278 * Removes @b all items from a given index widget.
280 * @param obj The index object.
282 * If deletion callbacks are set, via elm_object_item_del_cb_set(),
283 * that callback function will be called for each item in @p obj.
287 EAPI void elm_index_item_clear(Evas_Object *obj);
290 * Go to a given items level on a index widget
292 * @param obj The index object
293 * @param level The index level (one of @c 0 or @c 1)
297 EAPI void elm_index_level_go(Evas_Object *obj, int level);
300 * Get the letter (string) set on a given index widget item.
302 * @param item The index item handle
303 * @return The letter string set on @p it
307 EAPI const char *elm_index_item_letter_get(const Elm_Object_Item *item);
310 * Set the indicator as to be disabled.
312 * @param obj The index object
313 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
315 * In Index widget, Indicator notes popup text, which shows a letter has been selecting.
317 * @see elm_index_indicator_disabled_get()
321 EAPI void elm_index_indicator_disabled_set(Evas_Object *obj, Eina_Bool disabled);
324 * Get the value of indicator's disabled status.
326 * @param obj The index object
327 * @return EINA_TRUE if the indicator is disabled.
329 * @see elm_index_indicator_disabled_set()
333 EAPI Eina_Bool elm_index_indicator_disabled_get(const Evas_Object *obj);
336 * Enable or disable horizontal mode on the index object
338 * @param obj The index object.
339 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
340 * disable it, i.e., to enable vertical mode. it's an area one @ref Fingers
341 * "finger" wide on the bottom side of the index widget's container.
343 * @note Vertical mode is set by default.
345 * On horizontal mode items are displayed on index from left to right,
346 * instead of from top to bottom. Also, the index will scroll horizontally.
348 * @see elm_index_horizontal_get()
352 EAPI void elm_index_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
355 * Get a value whether horizontal mode is enabled or not.
357 * @param obj The index object.
358 * @return @c EINA_TRUE means horizontal mode selection is enabled.
359 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
360 * @c EINA_FALSE is returned.
362 * @see elm_index_horizontal_set() for details.
366 EAPI Eina_Bool elm_index_horizontal_get(const Evas_Object *obj);