1 /** 2 * @defgroup Elm_List_Group List 3 * @ingroup Elementary 4 * 5 * @image html list_inheritance_tree.png 6 * @image latex list_inheritance_tree.eps 7 * 8 * @image html img/widget/list/preview-00.png 9 * @image latex img/widget/list/preview-00.eps width=\textwidth 10 * 11 * @image html img/list.png 12 * @image latex img/list.eps width=\textwidth 13 * 14 * A list widget is a container whose children are displayed 15 * vertically or horizontally, in order, and can be selected. The list 16 * can accept only one or multiple item selections. Also has many 17 * modes of items displaying. 18 * 19 * A list is a very simple type of list widget. For more robust lists, 20 * @ref Genlist should probably be used. 21 * 22 * This widget inherits from the @ref Elm_Layout one, so that all the 23 * functions acting on it also work for list objects. 24 * 25 * This widget emits the following signals, besides the ones sent from 26 * @ref Elm_Layout : 27 * - @c "activated" - The user has double-clicked or pressed 28 * (enter|return|spacebar) on an item. The @p event_info parameter 29 * is the item that was activated. 30 * - @c "clicked,double" - The user has double-clicked an item. 31 * The @p event_info parameter is the item that was double-clicked. 32 * - @c "clicked,right" - The user has right-clicked an item. The @p 33 * event_info parameter is the item that was right-clicked. (since 1.13) 34 * - @c "selected" - when the user selected an item 35 * - @c "unselected" - when the user unselected an item 36 * - @c "longpressed" - an item in the list is long-pressed 37 * - @c "edge,top" - the list is scrolled until the top edge 38 * - @c "edge,bottom" - the list is scrolled until the bottom edge 39 * - @c "edge,left" - the list is scrolled until the left edge 40 * - @c "edge,right" - the list is scrolled until the right edge 41 * - @c "highlighted" - an item in the list is highlighted. This is called when 42 * the user presses an item or keyboard selection is done so the item is 43 * physically highlighted. The @p event_info parameter is the item that was 44 * highlighted. 45 * - @c "unhighlighted" - an item in the list is unhighlighted. This is called 46 * when the user releases an item or keyboard selection is moved so the item 47 * is physically unhighlighted. The @p event_info parameter is the item that 48 * was unhighlighted. 49 * - @c "language,changed" - the program's language changed 50 * - @c "focused" - When the list has received focus. (since 1.8) 51 * - @c "unfocused" - When the list has lost focus. (since 1.8) 52 * - @c "item,focused" - When the list item has received focus. (since 1.10) 53 * - @c "item,unfocused" - When the list item has lost focus. (since 1.10) 54 * 55 * Available styles for it are: 56 * - @c "default" 57 * 58 * Default content parts of the list items that you can use are: 59 * @li @c "start" - A start position object in the list item 60 * @li @c "end" - An end position object in the list item 61 * Another parts for customized styles are not accepted. 62 * 63 * Default text parts of the list items that you can use are: 64 * @li @c "default" - A label in the list item 65 * Another parts for customized styles are not accepted. 66 * 67 * Supported @c elm_object_item common APIs. 68 * @li @ref elm_object_item_disabled_set 69 * @li @ref elm_object_item_disabled_get 70 * @li @ref elm_object_item_part_text_set 71 * @li @ref elm_object_item_part_text_get 72 * @li @ref elm_object_item_part_content_set 73 * @li @ref elm_object_item_part_content_get 74 * @li @ref elm_object_item_part_content_unset 75 * @li @ref elm_object_item_del 76 * @li @ref elm_object_item_signal_emit 77 * 78 * This widget implements the @ref elm-scrollable-interface 79 * interface, so that all (non-deprecated) functions for the base @ref 80 * Scroller widget also work for lists. 81 * 82 * Some calls on the list's API are marked as @b deprecated, as they 83 * just wrap the scrollable widgets counterpart functions. Use the 84 * ones we point you to, for each case of deprecation here, instead -- 85 * eventually the deprecated ones will be discarded (next major 86 * release). 87 * 88 * List of examples: 89 * @li @ref list_example_01 90 * @li @ref list_example_02 91 * @li @ref list_example_03 92 */ 93 94 /** 95 * @addtogroup Elm_List_Group 96 * @{ 97 */ 98 99 #ifndef EFL_NOLEGACY_API_SUPPORT 100 #include <elm_list_legacy.h> 101 #endif 102 103 /** 104 * @} 105 */ 106
