1093 lines
35 KiB
C
1093 lines
35 KiB
C
/**
|
|
* @defgroup List List
|
|
* @ingroup Elementary
|
|
*
|
|
* @image html list_inheritance_tree.png
|
|
* @image latex list_inheritance_tree.eps
|
|
*
|
|
* @image html img/widget/list/preview-00.png
|
|
* @image latex img/widget/list/preview-00.eps width=\textwidth
|
|
*
|
|
* @image html img/list.png
|
|
* @image latex img/list.eps width=\textwidth
|
|
*
|
|
* A list widget is a container whose children are displayed
|
|
* vertically or horizontally, in order, and can be selected. The list
|
|
* can accept only one or multiple item selections. Also has many
|
|
* modes of items displaying.
|
|
*
|
|
* A list is a very simple type of list widget. For more robust lists,
|
|
* @ref Genlist should probably be used.
|
|
*
|
|
* This widget inherits from the @ref Layout one, so that all the
|
|
* functions acting on it also work for list objects.
|
|
*
|
|
* This widget emits the following signals, besides the ones sent from
|
|
* @ref Layout:
|
|
* - @c "activated" - The user has double-clicked or pressed
|
|
* (enter|return|spacebar) on an item. The @c event_info parameter
|
|
* is the item that was activated.
|
|
* - @c "clicked,double" - The user has double-clicked an item.
|
|
* The @c event_info parameter is the item that was double-clicked.
|
|
* - @c "selected" - when the user selected an item
|
|
* - @c "unselected" - when the user unselected an item
|
|
* - @c "longpressed" - an item in the list is long-pressed
|
|
* - @c "edge,top" - the list is scrolled until the top edge
|
|
* - @c "edge,bottom" - the list is scrolled until the bottom edge
|
|
* - @c "edge,left" - the list is scrolled until the left edge
|
|
* - @c "edge,right" - the list is scrolled until the right edge
|
|
* - @c "highlighted" - an item in the list is highlighted. This is called when
|
|
* the user presses an item or keyboard selection is done so the item is
|
|
* physically highlighted. The %c event_info parameter is the item that was
|
|
* highlighted.
|
|
* - @c "unhighlighted" - an item in the list is unhighlighted. This is called
|
|
* when the user releases an item or keyboard selection is moved so the item
|
|
* is physically unhighlighted. The %c event_info parameter is the item that
|
|
* was unhighlighted.
|
|
* - @c "language,changed" - the program's language changed
|
|
*
|
|
* Available styles for it are:
|
|
* - @c "default"
|
|
*
|
|
* Default content parts of the list items that you can use are:
|
|
* @li @c "start" - A start position object in the list item
|
|
* @li @c "end" - An end position object in the list item
|
|
*
|
|
* Default text parts of the list items that you can use are:
|
|
* @li @c "default" - label in the list item
|
|
*
|
|
* Supported @c elm_object_item common APIs.
|
|
* @li @ref elm_object_item_disabled_set
|
|
* @li @ref elm_object_item_disabled_get
|
|
* @li @ref elm_object_item_part_text_set
|
|
* @li @ref elm_object_item_part_text_get
|
|
* @li @ref elm_object_item_part_content_set
|
|
* @li @ref elm_object_item_part_content_get
|
|
* @li @ref elm_object_item_part_content_unset
|
|
*
|
|
* This widget implements the @b @ref elm-scrollable-interface
|
|
* interface, so that all (non-deprecated) functions for the base @ref
|
|
* Scroller widget also work for lists.
|
|
*
|
|
* Some calls on the list's API are marked as @b deprecated, as they
|
|
* just wrap the scrollable widgets counterpart functions. Use the
|
|
* ones we point you to, for each case of deprecation here, instead --
|
|
* eventually the deprecated ones will be discarded (next major
|
|
* release).
|
|
*
|
|
* List of examples:
|
|
* @li @ref list_example_01
|
|
* @li @ref list_example_02
|
|
* @li @ref list_example_03
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup List
|
|
* @{
|
|
*/
|
|
|
|
#define ELM_OBJ_LIST_CLASS elm_obj_list_class_get()
|
|
|
|
const Eo_Class *elm_obj_list_class_get(void) EINA_CONST;
|
|
|
|
extern EAPI Eo_Op ELM_OBJ_LIST_BASE_ID;
|
|
|
|
enum
|
|
{
|
|
ELM_OBJ_LIST_SUB_ID_GO,
|
|
ELM_OBJ_LIST_SUB_ID_MULTI_SELECT_SET,
|
|
ELM_OBJ_LIST_SUB_ID_MULTI_SELECT_GET,
|
|
ELM_OBJ_LIST_SUB_ID_MODE_SET,
|
|
ELM_OBJ_LIST_SUB_ID_MODE_GET,
|
|
ELM_OBJ_LIST_SUB_ID_HORIZONTAL_SET,
|
|
ELM_OBJ_LIST_SUB_ID_HORIZONTAL_GET,
|
|
ELM_OBJ_LIST_SUB_ID_SELECT_MODE_SET,
|
|
ELM_OBJ_LIST_SUB_ID_SELECT_MODE_GET,
|
|
ELM_OBJ_LIST_SUB_ID_CLEAR,
|
|
ELM_OBJ_LIST_SUB_ID_ITEMS_GET,
|
|
ELM_OBJ_LIST_SUB_ID_SELECTED_ITEM_GET,
|
|
ELM_OBJ_LIST_SUB_ID_SELECTED_ITEMS_GET,
|
|
ELM_OBJ_LIST_SUB_ID_ITEM_APPEND,
|
|
ELM_OBJ_LIST_SUB_ID_ITEM_PREPEND,
|
|
ELM_OBJ_LIST_SUB_ID_ITEM_INSERT_BEFORE,
|
|
ELM_OBJ_LIST_SUB_ID_ITEM_INSERT_AFTER,
|
|
ELM_OBJ_LIST_SUB_ID_ITEM_SORTED_INSERT,
|
|
ELM_OBJ_LIST_SUB_ID_FIRST_ITEM_GET,
|
|
ELM_OBJ_LIST_SUB_ID_LAST_ITEM_GET,
|
|
ELM_OBJ_LIST_SUB_ID_LAST
|
|
};
|
|
|
|
#define ELM_OBJ_LIST_ID(sub_id) (ELM_OBJ_LIST_BASE_ID + sub_id)
|
|
|
|
|
|
/**
|
|
* @def elm_obj_list_go
|
|
* @since 1.8
|
|
*
|
|
* Starts the list.
|
|
*
|
|
*
|
|
* @see elm_list_go
|
|
*/
|
|
#define elm_obj_list_go() ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_GO)
|
|
|
|
/**
|
|
* @def elm_obj_list_multi_select_set
|
|
* @since 1.8
|
|
*
|
|
* Enable or disable multiple items selection on the list object.
|
|
*
|
|
* @param[in] multi
|
|
*
|
|
* @see elm_list_multi_select_set
|
|
*/
|
|
#define elm_obj_list_multi_select_set(multi) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_MULTI_SELECT_SET), EO_TYPECHECK(Eina_Bool, multi)
|
|
|
|
/**
|
|
* @def elm_obj_list_multi_select_get
|
|
* @since 1.8
|
|
*
|
|
* Get a value whether multiple items selection is enabled or not.
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_multi_select_get
|
|
*/
|
|
#define elm_obj_list_multi_select_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_MULTI_SELECT_GET), EO_TYPECHECK(Eina_Bool *, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_mode_set
|
|
* @since 1.8
|
|
*
|
|
* Set which mode to use for the list object.
|
|
*
|
|
* @param[in] mode
|
|
*
|
|
* @see elm_list_mode_set
|
|
*/
|
|
#define elm_obj_list_mode_set(mode) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_MODE_SET), EO_TYPECHECK(Elm_List_Mode, mode)
|
|
|
|
/**
|
|
* @def elm_obj_list_mode_get
|
|
* @since 1.8
|
|
*
|
|
* Get the mode the list is at.
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_mode_get
|
|
*/
|
|
#define elm_obj_list_mode_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_MODE_GET), EO_TYPECHECK(Elm_List_Mode *, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_horizontal_set
|
|
* @since 1.8
|
|
*
|
|
* Enable or disable horizontal mode on the list object.
|
|
*
|
|
* @param[in] horizontal
|
|
*
|
|
* @see elm_list_horizontal_set
|
|
*/
|
|
#define elm_obj_list_horizontal_set(horizontal) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_HORIZONTAL_SET), EO_TYPECHECK(Eina_Bool, horizontal)
|
|
|
|
/**
|
|
* @def elm_obj_list_horizontal_get
|
|
* @since 1.8
|
|
*
|
|
* Get a value whether horizontal mode is enabled or not.
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_horizontal_get
|
|
*/
|
|
#define elm_obj_list_horizontal_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_HORIZONTAL_GET), EO_TYPECHECK(Eina_Bool *, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_select_mode_set
|
|
* @since 1.8
|
|
*
|
|
* No description supplied by the EAPI.
|
|
*
|
|
* @param[in] mode
|
|
*
|
|
* @see elm_list_select_mode_set
|
|
*/
|
|
#define elm_obj_list_select_mode_set(mode) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_SELECT_MODE_SET), EO_TYPECHECK(Elm_Object_Select_Mode, mode)
|
|
|
|
/**
|
|
* @def elm_obj_list_select_mode_get
|
|
* @since 1.8
|
|
*
|
|
* No description supplied by the EAPI.
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_select_mode_get
|
|
*/
|
|
#define elm_obj_list_select_mode_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_SELECT_MODE_GET), EO_TYPECHECK(Elm_Object_Select_Mode *, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_bounce_set
|
|
* @since 1.8
|
|
*
|
|
* Set bouncing behaviour when the scrolled content reaches an edge.
|
|
*
|
|
* @param[in] h_bounce
|
|
* @param[in] v_bounce
|
|
*
|
|
* @see elm_list_bounce_set
|
|
*/
|
|
#define elm_obj_list_bounce_set(h_bounce, v_bounce) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_BOUNCE_SET), EO_TYPECHECK(Eina_Bool, h_bounce), EO_TYPECHECK(Eina_Bool, v_bounce)
|
|
|
|
/**
|
|
* @def elm_obj_list_bounce_get
|
|
* @since 1.8
|
|
*
|
|
* Get the bouncing behaviour of the internal scroller.
|
|
*
|
|
* @param[out] h_bounce
|
|
* @param[out] v_bounce
|
|
*
|
|
* @see elm_list_bounce_get
|
|
*/
|
|
#define elm_obj_list_bounce_get(h_bounce, v_bounce) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_BOUNCE_GET), EO_TYPECHECK(Eina_Bool *, h_bounce), EO_TYPECHECK(Eina_Bool *, v_bounce)
|
|
|
|
/**
|
|
* @def elm_obj_list_scroller_policy_set
|
|
* @since 1.8
|
|
*
|
|
* Set the scrollbar policy.
|
|
*
|
|
* @param[in] policy_h
|
|
* @param[in] policy_v
|
|
*
|
|
* @see elm_list_scroller_policy_set
|
|
*/
|
|
#define elm_obj_list_scroller_policy_set(policy_h, policy_v) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_SCROLLER_POLICY_SET), EO_TYPECHECK(Elm_Scroller_Policy, policy_h), EO_TYPECHECK(Elm_Scroller_Policy, policy_v)
|
|
|
|
/**
|
|
* @def elm_obj_list_scroller_policy_get
|
|
* @since 1.8
|
|
*
|
|
* Get the scrollbar policy.
|
|
*
|
|
* @param[out] policy_h
|
|
* @param[out] policy_v
|
|
*
|
|
* @see elm_list_scroller_policy_get
|
|
*/
|
|
#define elm_obj_list_scroller_policy_get(policy_h, policy_v) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_SCROLLER_POLICY_GET), EO_TYPECHECK(Elm_Scroller_Policy *, policy_h), EO_TYPECHECK(Elm_Scroller_Policy *, policy_v)
|
|
|
|
/**
|
|
* @def elm_obj_list_clear
|
|
* @since 1.8
|
|
*
|
|
* Remove all list's items.
|
|
*
|
|
*
|
|
* @see elm_list_clear
|
|
*/
|
|
#define elm_obj_list_clear() ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_CLEAR)
|
|
|
|
/**
|
|
* @def elm_obj_list_items_get
|
|
* @since 1.8
|
|
*
|
|
* Get a list of all the list items.
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_items_get
|
|
*/
|
|
#define elm_obj_list_items_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_ITEMS_GET), EO_TYPECHECK(const Eina_List **, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_selected_item_get
|
|
* @since 1.8
|
|
*
|
|
* Get the selected item.
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_selected_item_get
|
|
*/
|
|
#define elm_obj_list_selected_item_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_SELECTED_ITEM_GET), EO_TYPECHECK(Elm_Object_Item **, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_selected_items_get
|
|
* @since 1.8
|
|
*
|
|
* Return a list of the currently selected list items.
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_selected_items_get
|
|
*/
|
|
#define elm_obj_list_selected_items_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_SELECTED_ITEMS_GET), EO_TYPECHECK(const Eina_List **, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_item_append
|
|
* @since 1.8
|
|
*
|
|
* Append a new item to the list object.
|
|
*
|
|
* @param[in] label
|
|
* @param[in] icon
|
|
* @param[in] end
|
|
* @param[in] func
|
|
* @param[in] data
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_item_append
|
|
*/
|
|
#define elm_obj_list_item_append(label, icon, end, func, data, ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_ITEM_APPEND), EO_TYPECHECK(const char *, label), EO_TYPECHECK(Evas_Object *, icon), EO_TYPECHECK(Evas_Object *, end), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_item_prepend
|
|
* @since 1.8
|
|
*
|
|
* Prepend a new item to the list object.
|
|
*
|
|
* @param[in] label
|
|
* @param[in] icon
|
|
* @param[in] end
|
|
* @param[in] func
|
|
* @param[in] data
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_item_prepend
|
|
*/
|
|
#define elm_obj_list_item_prepend(label, icon, end, func, data, ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_ITEM_PREPEND), EO_TYPECHECK(const char *, label), EO_TYPECHECK(Evas_Object *, icon), EO_TYPECHECK(Evas_Object *, end), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_item_insert_before
|
|
* @since 1.8
|
|
*
|
|
* Insert a new item into the list object before item before.
|
|
*
|
|
* @param[in] before
|
|
* @param[in] label
|
|
* @param[in] icon
|
|
* @param[in] end
|
|
* @param[in] func
|
|
* @param[in] data
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_item_insert_before
|
|
*/
|
|
#define elm_obj_list_item_insert_before(before, label, icon, end, func, data, ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_ITEM_INSERT_BEFORE), EO_TYPECHECK(Elm_Object_Item *, before), EO_TYPECHECK(const char *, label), EO_TYPECHECK(Evas_Object *, icon), EO_TYPECHECK(Evas_Object *, end), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_item_insert_after
|
|
* @since 1.8
|
|
*
|
|
* Insert a new item into the list object after item after.
|
|
*
|
|
* @param[in] after
|
|
* @param[in] label
|
|
* @param[in] icon
|
|
* @param[in] end
|
|
* @param[in] func
|
|
* @param[in] data
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_item_insert_after
|
|
*/
|
|
#define elm_obj_list_item_insert_after(after, label, icon, end, func, data, ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_ITEM_INSERT_AFTER), EO_TYPECHECK(Elm_Object_Item *, after), EO_TYPECHECK(const char *, label), EO_TYPECHECK(Evas_Object *, icon), EO_TYPECHECK(Evas_Object *, end), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Elm_Object_Item **, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_item_sorted_insert
|
|
* @since 1.8
|
|
*
|
|
* Insert a new item into the sorted list object.
|
|
*
|
|
* @param[in] label
|
|
* @param[in] icon
|
|
* @param[in] end
|
|
* @param[in] func
|
|
* @param[in] data
|
|
* @param[in] cmp_func
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_item_sorted_insert
|
|
*/
|
|
#define elm_obj_list_item_sorted_insert(label, icon, end, func, data, cmp_func, ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_ITEM_SORTED_INSERT), EO_TYPECHECK(const char *, label), EO_TYPECHECK(Evas_Object *, icon), EO_TYPECHECK(Evas_Object *, end), EO_TYPECHECK(Evas_Smart_Cb, func), EO_TYPECHECK(const void *, data), EO_TYPECHECK(Eina_Compare_Cb, cmp_func), EO_TYPECHECK(Elm_Object_Item **, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_first_item_get
|
|
* @since 1.8
|
|
*
|
|
* Get the first item in the list
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_first_item_get
|
|
*/
|
|
#define elm_obj_list_first_item_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_FIRST_ITEM_GET), EO_TYPECHECK(Elm_Object_Item **, ret)
|
|
|
|
/**
|
|
* @def elm_obj_list_last_item_get
|
|
* @since 1.8
|
|
*
|
|
* Get the last item in the list
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_list_last_item_get
|
|
*/
|
|
#define elm_obj_list_last_item_get(ret) ELM_OBJ_LIST_ID(ELM_OBJ_LIST_SUB_ID_LAST_ITEM_GET), EO_TYPECHECK(Elm_Object_Item **, ret)
|
|
|
|
/**
|
|
* @enum Elm_List_Mode
|
|
* @typedef Elm_List_Mode
|
|
*
|
|
* Set list's resizing behavior, transverse axis scrolling and items
|
|
* cropping. See each mode's description for more details.
|
|
*
|
|
* @note Default value is #ELM_LIST_SCROLL.
|
|
*
|
|
* Values here @b don't work as bitmasks -- only one can be chosen at
|
|
* a time.
|
|
*
|
|
* @see elm_list_mode_set()
|
|
* @see elm_list_mode_get()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
typedef enum
|
|
{
|
|
ELM_LIST_COMPRESS = 0, /**< The list @b won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zeroed dimensions. The list will respect the container's geometry and, if any of its items won't fit into its @b transverse axis, one won't be able to scroll it in that direction. */
|
|
ELM_LIST_SCROLL, /**< Default value. This is the same as #ELM_LIST_COMPRESS, with the exception that if any of its items won't fit into its transverse axis, one @b will be able to scroll it in that direction. */
|
|
ELM_LIST_LIMIT, /**< Sets a minimum size hint on the list object, so that containers may respect it (and resize itself to fit the child properly). More specifically, a @b minimum size hint will be set for its @b transverse axis, so that the @b largest item in that direction fits well. This is naturally bound by the list object's maximum size hints, set externally. */
|
|
ELM_LIST_EXPAND, /**< Besides setting a minimum size on the transverse axis, just like on #ELM_LIST_LIMIT, the list will set a minimum size on the @b longitudinal axis, trying to reserve space to all its children to be visible at a time. . This is naturally bound by the list object's maximum size hints, set externally. */
|
|
ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
|
|
} Elm_List_Mode;
|
|
|
|
/**
|
|
* Add a new list widget to the given parent Elementary
|
|
* (container) object.
|
|
*
|
|
* @param parent The parent object.
|
|
* @return a new list widget handle or @c NULL, on errors.
|
|
*
|
|
* This function inserts a new list widget on the canvas.
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Evas_Object *elm_list_add(Evas_Object *parent);
|
|
|
|
/**
|
|
* Starts the list.
|
|
*
|
|
* @param obj The list object
|
|
*
|
|
* @note Call before running show() on the list object.
|
|
* @warning If not called, it won't display the list properly.
|
|
*
|
|
* @code
|
|
* li = elm_list_add(win);
|
|
* elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
|
|
* elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
|
|
* elm_list_go(li);
|
|
* evas_object_show(li);
|
|
* @endcode
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI void elm_list_go(Evas_Object *obj);
|
|
|
|
/**
|
|
* Enable or disable multiple items selection on the list object.
|
|
*
|
|
* @param obj The list object
|
|
* @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
|
|
* disable it.
|
|
*
|
|
* Disabled by default. If disabled, the user can select a single item of
|
|
* the list each time. Selected items are highlighted on list.
|
|
* If enabled, many items can be selected.
|
|
*
|
|
* If a selected item is selected again, it will be unselected.
|
|
*
|
|
* @see elm_list_multi_select_get()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi);
|
|
|
|
/**
|
|
* Get a value whether multiple items selection is enabled or not.
|
|
*
|
|
* @see elm_list_multi_select_set() for details.
|
|
*
|
|
* @param obj The list object.
|
|
* @return @c EINA_TRUE means multiple items selection is enabled.
|
|
* @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
|
|
* @c EINA_FALSE is returned.
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* Set which mode to use for the list object.
|
|
*
|
|
* @param obj The list object
|
|
* @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS,
|
|
* #ELM_LIST_SCROLL, #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
|
|
*
|
|
* Set list's resize behavior, transverse axis scroll and
|
|
* items cropping. See each mode's description for more details.
|
|
*
|
|
* @note Default value is #ELM_LIST_SCROLL.
|
|
*
|
|
* Only one mode at a time can be set. If a previous one was set, it
|
|
* will be changed by the new mode after this call. Bitmasks won't
|
|
* work here as well.
|
|
*
|
|
* @warning This function's behavior will clash with those of
|
|
* elm_scroller_content_min_limit(), so use either one of them, but
|
|
* not both.
|
|
*
|
|
* @see elm_list_mode_get()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode);
|
|
|
|
/**
|
|
* Get the mode the list is at.
|
|
*
|
|
* @param obj The list object
|
|
* @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL, #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
|
|
*
|
|
* @note see elm_list_mode_set() for more information.
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* Enable or disable horizontal mode on the list object.
|
|
*
|
|
* @param obj The list object.
|
|
* @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
|
|
* disable it, i.e., to enable vertical mode.
|
|
*
|
|
* @note Vertical mode is set by default.
|
|
*
|
|
* On horizontal mode items are displayed on list from left to right,
|
|
* instead of from top to bottom. Also, the list will scroll horizontally.
|
|
* Each item will presents left icon on top and right icon, or end, at
|
|
* the bottom.
|
|
*
|
|
* @see elm_list_horizontal_get()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal);
|
|
|
|
/**
|
|
* Get a value whether horizontal mode is enabled or not.
|
|
*
|
|
* @param obj The list 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_list_horizontal_set() for details.
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* Set the list select mode.
|
|
*
|
|
* @param obj The list object
|
|
* @param mode The select mode
|
|
*
|
|
* elm_list_select_mode_set() changes item select mode in the list widget.
|
|
* - ELM_OBJECT_SELECT_MODE_DEFAULT : Items will only call their selection func and
|
|
* callback when first becoming selected. Any further clicks will
|
|
* do nothing, unless you set always select mode.
|
|
* - ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
|
|
* every click will make the selected callbacks be called.
|
|
* - ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select items
|
|
* entirely and they will neither appear selected nor call selected
|
|
* callback functions.
|
|
*
|
|
* @see elm_list_select_mode_get()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI void elm_list_select_mode_set(Evas_Object *obj, Elm_Object_Select_Mode mode);
|
|
|
|
/**
|
|
* Get the list select mode.
|
|
*
|
|
* @param obj The list object
|
|
* @return The select mode
|
|
* (If getting mode is failed, it returns ELM_OBJECT_SELECT_MODE_MAX)
|
|
*
|
|
* @see elm_list_select_mode_set()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Elm_Object_Select_Mode elm_list_select_mode_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* Append a new item to the list object.
|
|
*
|
|
* @param obj The list object.
|
|
* @param label The label of the list item.
|
|
* @param icon The icon object to use for the left side of the item. An
|
|
* icon can be any Evas object, but usually it is an icon created
|
|
* with elm_icon_add().
|
|
* @param end The icon object to use for the right side of the item. An
|
|
* icon can be any Evas object.
|
|
* @param func The function to call when the item is clicked.
|
|
* @param data The data to associate with the item for related callbacks.
|
|
*
|
|
* @return The created item or @c NULL upon failure.
|
|
*
|
|
* A new item will be created and appended to the list, i.e., will
|
|
* be set as @b last item.
|
|
*
|
|
* Items created with this method can be deleted with elm_object_item_del().
|
|
*
|
|
* Associated @p data can be properly freed when item is deleted if a
|
|
* callback function is set with elm_object_item_del_cb_set().
|
|
*
|
|
* If a function is passed as argument, it will be called every time this item
|
|
* is selected, i.e., the user clicks over an unselected item.
|
|
* If always select is enabled it will call this function every time
|
|
* user clicks over an item (already selected or not).
|
|
* If such function isn't needed, just passing
|
|
* @c NULL as @p func is enough. The same should be done for @p data.
|
|
*
|
|
* Simple example (with no function callback or data associated):
|
|
* @code
|
|
* li = elm_list_add(win);
|
|
* ic = elm_icon_add(win);
|
|
* elm_image_file_set(ic, "path/to/image", NULL);
|
|
* elm_icon_resizable_set(ic, EINA_TRUE, EINA_TRUE);
|
|
* elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
|
|
* elm_list_go(li);
|
|
* evas_object_show(li);
|
|
* @endcode
|
|
*
|
|
* @see elm_list_select_mode_set()
|
|
* @see elm_object_item_del()
|
|
* @see elm_object_item_del_cb_set()
|
|
* @see elm_list_clear()
|
|
* @see elm_icon_add()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Elm_Object_Item *elm_list_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data);
|
|
|
|
/**
|
|
* Prepend a new item to the list object.
|
|
*
|
|
* @param obj The list object.
|
|
* @param label The label of the list item.
|
|
* @param icon The icon object to use for the left side of the item. An
|
|
* icon can be any Evas object, but usually it is an icon created
|
|
* with elm_icon_add().
|
|
* @param end The icon object to use for the right side of the item. An
|
|
* icon can be any Evas object.
|
|
* @param func The function to call when the item is clicked.
|
|
* @param data The data to associate with the item for related callbacks.
|
|
*
|
|
* @return The created item or @c NULL upon failure.
|
|
*
|
|
* A new item will be created and prepended to the list, i.e., will
|
|
* be set as @b first item.
|
|
*
|
|
* Items created with this method can be deleted with elm_object_item_del().
|
|
*
|
|
* Associated @p data can be properly freed when item is deleted if a
|
|
* callback function is set with elm_object_item_del_cb_set().
|
|
*
|
|
* If a function is passed as argument, it will be called every time this item
|
|
* is selected, i.e., the user clicks over an unselected item.
|
|
* If always select is enabled it will call this function every time
|
|
* user clicks over an item (already selected or not).
|
|
* If such function isn't needed, just passing
|
|
* @c NULL as @p func is enough. The same should be done for @p data.
|
|
*
|
|
* @see elm_list_item_append() for a simple code example.
|
|
* @see elm_list_select_mode_set()
|
|
* @see elm_object_item_del()
|
|
* @see elm_object_item_del_cb_set()
|
|
* @see elm_list_clear()
|
|
* @see elm_icon_add()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Elm_Object_Item *elm_list_item_prepend(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data);
|
|
|
|
/**
|
|
* Insert a new item into the list object before item @p before.
|
|
*
|
|
* @param obj The list object.
|
|
* @param before The list item to insert before.
|
|
* @param label The label of the list item.
|
|
* @param icon The icon object to use for the left side of the item. An
|
|
* icon can be any Evas object, but usually it is an icon created
|
|
* with elm_icon_add().
|
|
* @param end The icon object to use for the right side of the item. An
|
|
* icon can be any Evas object.
|
|
* @param func The function to call when the item is clicked.
|
|
* @param data The data to associate with the item for related callbacks.
|
|
*
|
|
* @return The created item or @c NULL upon failure.
|
|
*
|
|
* A new item will be created and added to the list. Its position in
|
|
* this list will be just before item @p before.
|
|
*
|
|
* Items created with this method can be deleted with elm_object_item_del().
|
|
*
|
|
* Associated @p data can be properly freed when item is deleted if a
|
|
* callback function is set with elm_object_item_del_cb_set().
|
|
*
|
|
* If a function is passed as argument, it will be called every time this item
|
|
* is selected, i.e., the user clicks over an unselected item.
|
|
* If always select is enabled it will call this function every time
|
|
* user clicks over an item (already selected or not).
|
|
* If such function isn't needed, just passing
|
|
* @c NULL as @p func is enough. The same should be done for @p data.
|
|
*
|
|
* @see elm_list_item_append() for a simple code example.
|
|
* @see elm_list_select_mode_set()
|
|
* @see elm_object_item_del()
|
|
* @see elm_object_item_del_cb_set()
|
|
* @see elm_list_clear()
|
|
* @see elm_icon_add()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Elm_Object_Item *elm_list_item_insert_before(Evas_Object *obj, Elm_Object_Item *before, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data);
|
|
|
|
/**
|
|
* Insert a new item into the list object after item @p after.
|
|
*
|
|
* @param obj The list object.
|
|
* @param after The list item to insert after.
|
|
* @param label The label of the list item.
|
|
* @param icon The icon object to use for the left side of the item. An
|
|
* icon can be any Evas object, but usually it is an icon created
|
|
* with elm_icon_add().
|
|
* @param end The icon object to use for the right side of the item. An
|
|
* icon can be any Evas object.
|
|
* @param func The function to call when the item is clicked.
|
|
* @param data The data to associate with the item for related callbacks.
|
|
*
|
|
* @return The created item or @c NULL upon failure.
|
|
*
|
|
* A new item will be created and added to the list. Its position in
|
|
* this list will be just after item @p after.
|
|
*
|
|
* Items created with this method can be deleted with elm_object_item_del().
|
|
*
|
|
* Associated @p data can be properly freed when item is deleted if a
|
|
* callback function is set with elm_object_item_del_cb_set().
|
|
*
|
|
* If a function is passed as argument, it will be called every time this item
|
|
* is selected, i.e., the user clicks over an unselected item.
|
|
* If always select is enabled it will call this function every time
|
|
* user clicks over an item (already selected or not).
|
|
* If such function isn't needed, just passing
|
|
* @c NULL as @p func is enough. The same should be done for @p data.
|
|
*
|
|
* @see elm_list_item_append() for a simple code example.
|
|
* @see elm_list_select_mode_set()
|
|
* @see elm_object_item_del()
|
|
* @see elm_object_item_del_cb_set()
|
|
* @see elm_list_clear()
|
|
* @see elm_icon_add()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Elm_Object_Item *elm_list_item_insert_after(Evas_Object *obj, Elm_Object_Item *after, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data);
|
|
|
|
/**
|
|
* Insert a new item into the sorted list object.
|
|
*
|
|
* @param obj The list object.
|
|
* @param label The label of the list item.
|
|
* @param icon The icon object to use for the left side of the item. An
|
|
* icon can be any Evas object, but usually it is an icon created
|
|
* with elm_icon_add().
|
|
* @param end The icon object to use for the right side of the item. An
|
|
* icon can be any Evas object.
|
|
* @param func The function to call when the item is clicked.
|
|
* @param data The data to associate with the item for related callbacks.
|
|
* @param cmp_func The comparing function to be used to sort list
|
|
* items <b>by #Elm_Object_Item item handles</b>. This function will
|
|
* receive two items and compare them, returning a non-negative integer
|
|
* if the second item should be place after the first, or negative value
|
|
* if should be placed before.
|
|
*
|
|
* @return The created item or @c NULL upon failure.
|
|
*
|
|
* @note This function inserts values into a list object assuming it was
|
|
* sorted and the result will be sorted.
|
|
*
|
|
* A new item will be created and added to the list. Its position in
|
|
* this list will be found comparing the new item with previously inserted
|
|
* items using function @p cmp_func.
|
|
*
|
|
* Items created with this method can be deleted with elm_object_item_del().
|
|
*
|
|
* Associated @p data can be properly freed when item is deleted if a
|
|
* callback function is set with elm_object_item_del_cb_set().
|
|
*
|
|
* If a function is passed as argument, it will be called every time this item
|
|
* is selected, i.e., the user clicks over an unselected item.
|
|
* If always select is enabled it will call this function every time
|
|
* user clicks over an item (already selected or not).
|
|
* If such function isn't needed, just passing
|
|
* @c NULL as @p func is enough. The same should be done for @p data.
|
|
*
|
|
* @see elm_list_item_append() for a simple code example.
|
|
* @see elm_list_select_mode_set()
|
|
* @see elm_object_item_del()
|
|
* @see elm_object_item_del_cb_set()
|
|
* @see elm_list_clear()
|
|
* @see elm_icon_add()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Elm_Object_Item *elm_list_item_sorted_insert(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data, Eina_Compare_Cb cmp_func);
|
|
|
|
/**
|
|
* Remove all list's items.
|
|
*
|
|
* @param obj The list object
|
|
*
|
|
* @see elm_object_item_del()
|
|
* @see elm_list_item_append()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI void elm_list_clear(Evas_Object *obj);
|
|
|
|
/**
|
|
* Get a list of all the list items.
|
|
*
|
|
* @param obj The list object
|
|
* @return An @c Eina_List of list items, #Elm_Object_Item,
|
|
* or @c NULL on failure.
|
|
*
|
|
* @see elm_list_item_append()
|
|
* @see elm_object_item_del()
|
|
* @see elm_list_clear()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* Get the selected item.
|
|
*
|
|
* @param obj The list object.
|
|
* @return The selected list item.
|
|
*
|
|
* The selected item can be unselected with function
|
|
* elm_list_item_selected_set().
|
|
*
|
|
* The selected item always will be highlighted on list.
|
|
*
|
|
* @see elm_list_selected_items_get()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Elm_Object_Item *elm_list_selected_item_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* Return a list of the currently selected list items.
|
|
*
|
|
* @param obj The list object.
|
|
* @return An @c Eina_List of list items, #Elm_Object_Item,
|
|
* or @c NULL on failure.
|
|
*
|
|
* Multiple items can be selected if multi select is enabled. It can be
|
|
* done with elm_list_multi_select_set().
|
|
*
|
|
* @see elm_list_selected_item_get()
|
|
* @see elm_list_multi_select_set()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* Set the selected state of an item.
|
|
*
|
|
* @param it The list 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,
|
|
* unless multiple selection is enabled with elm_list_multi_select_set().
|
|
* Previously selected item can be get with function
|
|
* elm_list_selected_item_get().
|
|
*
|
|
* Selected items will be highlighted.
|
|
*
|
|
* @see elm_list_item_selected_get()
|
|
* @see elm_list_selected_item_get()
|
|
* @see elm_list_multi_select_set()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI void elm_list_item_selected_set(Elm_Object_Item *it, Eina_Bool selected);
|
|
|
|
/*
|
|
* Get whether the @p item is selected or not.
|
|
*
|
|
* @param it The list item.
|
|
* @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
|
|
* it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
|
|
*
|
|
* @see elm_list_selected_item_set() for details.
|
|
* @see elm_list_item_selected_get()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Eina_Bool elm_list_item_selected_get(const Elm_Object_Item *it);
|
|
|
|
/**
|
|
* Set or unset item as a separator.
|
|
*
|
|
* @param it The list item.
|
|
* @param setting @c EINA_TRUE to set item @p it as separator or
|
|
* @c EINA_FALSE to unset, i.e., item will be used as a regular item.
|
|
*
|
|
* Items aren't set as separator by default.
|
|
*
|
|
* If set as separator it will display separator theme, so won't display
|
|
* icons or label.
|
|
*
|
|
* @see elm_list_item_separator_get()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI void elm_list_item_separator_set(Elm_Object_Item *it, Eina_Bool setting);
|
|
|
|
/**
|
|
* Get a value whether item is a separator or not.
|
|
*
|
|
* @see elm_list_item_separator_set() for details.
|
|
*
|
|
* @param it The list item.
|
|
* @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
|
|
* indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Eina_Bool elm_list_item_separator_get(const Elm_Object_Item *it);
|
|
|
|
/**
|
|
* Show @p item in the list view.
|
|
*
|
|
* @param it The list item to be shown.
|
|
*
|
|
* It won't animate list until item is visible. If such behavior is wanted,
|
|
* use elm_list_bring_in() instead.
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI void elm_list_item_show(Elm_Object_Item *it);
|
|
|
|
/**
|
|
* Bring in the given item to list view.
|
|
*
|
|
* @param it The item.
|
|
*
|
|
* This causes list to jump to the given item @p item and show it
|
|
* (by scrolling), if it is not fully visible.
|
|
*
|
|
* This may use animation to do so and take a period of time.
|
|
*
|
|
* If animation isn't wanted, elm_list_item_show() can be used.
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI void elm_list_item_bring_in(Elm_Object_Item *it);
|
|
|
|
/**
|
|
* Get the real Evas(Edje) object created to implement the view of a given
|
|
* list @p item.
|
|
*
|
|
* @param it The list item
|
|
* @return The base Edje object associated with @p it.
|
|
*
|
|
* Base object is the @c Evas_Object that represents that item.
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Evas_Object *elm_list_item_object_get(const Elm_Object_Item *it);
|
|
|
|
/**
|
|
* Get the item before @p it in list.
|
|
*
|
|
* @param it The list item.
|
|
* @return The item before @p it, or @c NULL if none or on failure.
|
|
*
|
|
* @note If it is the first item, @c NULL will be returned.
|
|
*
|
|
* @see elm_list_item_append()
|
|
* @see elm_list_items_get()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Elm_Object_Item *elm_list_item_prev(const Elm_Object_Item *it);
|
|
|
|
/**
|
|
* Get the item after @p it in list.
|
|
*
|
|
* @param it The list item.
|
|
* @return The item after @p it, or @c NULL if none or on failure.
|
|
*
|
|
* @note If it is the last item, @c NULL will be returned.
|
|
*
|
|
* @see elm_list_item_append()
|
|
* @see elm_list_items_get()
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Elm_Object_Item *elm_list_item_next(const Elm_Object_Item *it);
|
|
|
|
/**
|
|
* Get the first item in the list
|
|
*
|
|
* This returns the first item in the list.
|
|
*
|
|
* @param obj The list object
|
|
* @return The first item, or NULL if none
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Elm_Object_Item *elm_list_first_item_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* Get the last item in the list
|
|
*
|
|
* This returns the last item in the list.
|
|
*
|
|
* @return The last item, or NULL if none
|
|
*
|
|
* @ingroup List
|
|
*/
|
|
EAPI Elm_Object_Item *elm_list_last_item_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @}
|
|
*/
|