1 /** 2 * @defgroup Elm_Index_Group Index 3 * @ingroup Elementary 4 * 5 * @image html index_inheritance_tree.png 6 * @image latex index_inheritance_tree.eps 7 * 8 * An index widget gives you an index for fast access to whichever 9 * group of other UI items one might have. It's a list of text 10 * items (usually letters, for alphabetically ordered access). 11 * 12 * Index widgets are by default hidden and just appear when the 13 * user clicks over it's reserved area in the canvas. In its 14 * default theme, it's an area one @ref Elm_Fingers "finger" wide on 15 * the right side of the index widget's container. 16 * 17 * When items on the index are selected, smart callbacks get 18 * called, so that its user can make other container objects to 19 * show a given area or child object depending on the index item 20 * selected. You'd probably be using an index together with @ref 21 * Elm_List "lists", @ref Elm_Genlist "generic lists" or @ref Elm_Gengrid 22 * "general grids". 23 * 24 * This widget inherits from the @ref Elm_Layout one, so that all the 25 * functions acting on it also work for index objects. 26 * 27 * This widget emits the following signals, besides the ones sent from 28 * @ref Elm_Layout : 29 * - @c "changed" - When the selected index item changes. @c 30 * event_info is the selected item's data pointer. 31 * - @c "delay,changed" - When the selected index item changes, but 32 * after a small idling period. @p event_info is the selected 33 * item's data pointer. 34 * - @c "selected" - When the user releases a mouse button and 35 * selects an item. @p event_info is the selected item's pointer. 36 * - @c "level,up" - when the user moves a finger from the first 37 * level to the second level 38 * - @c "level,down" - when the user moves a finger from the second 39 * level to the first level 40 * - @c "language,changed" - the program's language changed 41 * - @c "focused" - When the index has received focus. (since 1.8) 42 * - @c "unfocused" - When the index has lost focus. (since 1.8) 43 * 44 * The @c "delay,changed" event is so that it'll wait a small time 45 * before actually reporting those events and, moreover, just the 46 * last event happening on those time frames will actually be 47 * reported. 48 * 49 * Supported elm_object_item common APIs 50 * @li elm_object_item_del 51 * 52 * Here are some examples on its usage: 53 * @li @ref index_example_01 54 * @li @ref index_example_02 55 */ 56 57 /** 58 * @addtogroup Elm_Index_Group 59 * @{ 60 */ 61 62 #ifndef EFL_NOLEGACY_API_SUPPORT 63 #include <elm_index_legacy.h> 64 #endif 65 66 /** 67 * @} 68 */ 69