* @}
*/
- /* genlist */
+ /**
+ * @defgroup Genlist Genlist
+ *
+ * This widget aims to have more expansive list than the simple list in
+ * Elementary that could have more flexible items and allow many more entries
+ * while still being fast and low on memory usage. At the same time it was
+ * also made to be able to do tree structures. But the price to pay is more
+ * complexity when it comes to usage. If all you want is a simple list with
+ * icons and a single label, use the normal @ref List object.
+ *
+ * Genlist has a fairly large API, mostly because it's relatively complex,
+ * trying to be both expansive, powerful and efficient. First we will begin
+ * an overview on the theory behind genlist.
+ *
+ * @section Genlist_Item_Class Genlist item classes - creating items
+ *
+ * In order to have the ability to add and delete items on the fly, genlist
+ * implements a class (callback) system where the application provides a
+ * structure with information about that type of item (genlist may contain
+ * multiple different items with different classes, states and styles).
+ * Genlist will call the functions in this struct (methods) when an item is
+ * "realized" (i.e., created dynamically, while the user is scrolling the
+ * grid). All objects will simply be deleted when no longer needed with
+ * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
+ * following members:
+ * - @c item_style - This is a constant string and simply defines the name
+ * of the item style. It @b must be specified and the default should be @c
+ * "default".
+ *
+ * - @c func - A struct with pointers to functions that will be called when
+ * an item is going to be actually created. All of them receive a @c data
+ * parameter that will point to the same data passed to
+ * elm_genlist_item_append() and related item creation functions, and a @c
+ * obj parameter that points to the genlist object itself.
+ *
+ * The function pointers inside @c func are @c label_get, @c icon_get, @c
+ * state_get and @c del. The 3 first functions also receive a @c part
+ * parameter described below. A brief description of these functions follows:
+ *
+ * - @c label_get - The @c part parameter is the name string of one of the
+ * existing text parts in the Edje group implementing the item's theme.
+ * This function @b must return a strdup'()ed string, as the caller will
+ * free() it when done. See #GenlistItemLabelGetFunc.
+ * - @c icon_get - The @c part parameter is the name string of one of the
+ * existing (icon) swallow parts in the Edje group implementing the item's
+ * theme. It must return @c NULL, when no icon is desired, or a valid
+ * object handle, otherwise. The object will be deleted by the genlist on
+ * its deletion or when the item is "unrealized". See
+ * #GenlistItemIconGetFunc.
+ * - @c func.state_get - The @c part parameter is the name string of one of
+ * the state parts in the Edje group implementing the item's theme. Return
+ * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
+ * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
+ * and @c "elm" as "emission" and "source" arguments, respectively, when
+ * the state is true (the default is false), where @c XXX is the name of
+ * the (state) part. See #GenlistItemStateGetFunc.
+ * - @c func.del - This is intended for use when genlist items are deleted,
+ * so any data attached to the item (e.g. its data parameter on creation)
+ * can be deleted. See #GenlistItemDelFunc.
+ *
+ * @section Genlist_Items Structure of items
+ *
+ * An item in a genlist can have 0 or more text labels (they can be regular
+ * text or textblock Evas objects - that's up to the style to determine), 0
+ * or more icons (which are simply objects swallowed into the genlist item's
+ * theming Edje object) and 0 or more <b>boolean states</b>, which have the
+ * behavior left to the user to define. The Edje part names for each of
+ * these properties will be looked up, in the theme file for the genlist,
+ * under the Edje (string) data items named @c "labels", @c "icons" and @c
+ * "states", respectively. For each of those properties, if more than one
+ * part is provided, they must have names listed separated by spaces in the
+ * data fields. For the default genlist item theme, we have @b one label
+ * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
+ * "elm.swallow.end") and @b no state parts.
+ *
+ * A genlist item may be at one of several styles. Elementary provides one
+ * by default - "default", but this can be extended by system or application
+ * custom themes/overlays/extensions (see @ref Theme "themes" for more
+ * details).
+ *
+ * @section Genlist_Manipulation Editing and Navigating
+ *
+ * Items can be added by several calls. All of them return a @ref
+ * Elm_Genlist_Item handle that is an internal member inside the genlist.
+ * They all take a data parameter that is meant to be used for a handle to
+ * the applications internal data (eg the struct with the original item
+ * data). The parent parameter is the parent genlist item this belongs to if
+ * it is a tree or an indexed group, and NULL if there is no parent. The
+ * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
+ * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
+ * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
+ * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
+ * is set then this item is group index item that is displayed at the top
+ * until the next group comes. The func parameter is a convenience callback
+ * that is called when the item is selected and the data parameter will be
+ * the func_data parameter, obj be the genlist object and event_info will be
+ * the genlist item.
+ *
+ * elm_genlist_item_append() adds an item to the end of the list, or if
+ * there is a parent, to the end of all the child items of the parent.
+ * elm_genlist_item_prepend() is the same but adds to the beginning of
+ * the list or children list. elm_genlist_item_insert_before() inserts at
+ * item before another item and elm_genlist_item_insert_after() inserts after
+ * the indicated item.
+ *
+ * The application can clear the list with elm_genlist_clear() which deletes
+ * all the items in the list and elm_genlist_item_del() will delete a specific
+ * item. elm_genlist_item_subitems_clear() will clear all items that are
+ * children of the indicated parent item.
+ *
+ * To help inspect list items you can jump to the item at the top of the list
+ * with elm_genlist_first_item_get() which will return the item pointer, and
+ * similarly elm_genlist_last_item_get() gets the item at the end of the list.
+ * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
+ * and previous items respectively relative to the indicated item. Using
+ * these calls you can walk the entire item list/tree. Note that as a tree
+ * the items are flattened in the list, so elm_genlist_item_parent_get() will
+ * let you know which item is the parent (and thus know how to skip them if
+ * wanted).
+ *
+ * @section Genlist_Muti_Selection Multi-selection
+ *
+ * If the application wants multiple items to be able to be selected,
+ * elm_genlist_multi_select_set() can enable this. If the list is
+ * single-selection only (the default), then elm_genlist_selected_item_get()
+ * will return the selected item, if any, or NULL I none is selected. If the
+ * list is multi-select then elm_genlist_selected_items_get() will return a
+ * list (that is only valid as long as no items are modified (added, deleted,
+ * selected or unselected)).
+ *
+ * @section Genlist_Usage_Hints Usage hints
+ *
+ * There are also convenience functions. elm_genlist_item_genlist_get() will
+ * return the genlist object the item belongs to. elm_genlist_item_show()
+ * will make the scroller scroll to show that specific item so its visible.
+ * elm_genlist_item_data_get() returns the data pointer set by the item
+ * creation functions.
+ *
+ * If an item changes (state of boolean changes, label or icons change),
+ * then use elm_genlist_item_update() to have genlist update the item with
+ * the new state. Genlist will re-realize the item thus call the functions
+ * in the _Elm_Genlist_Item_Class for that item.
+ *
+ * To programmatically (un)select an item use elm_genlist_item_selected_set().
+ * To get its selected state use elm_genlist_item_selected_get(). Similarly
+ * to expand/contract an item and get its expanded state, use
+ * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
+ * again to make an item disabled (unable to be selected and appear
+ * differently) use elm_genlist_item_disabled_set() to set this and
+ * elm_genlist_item_disabled_get() to get the disabled state.
+ *
+ * In general to indicate how the genlist should expand items horizontally to
+ * fill the list area, use elm_genlist_horizontal_mode_set(). Valid modes are
+ * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
+ * mode means that if items are too wide to fit, the scroller will scroll
+ * horizontally. Otherwise items are expanded to fill the width of the
+ * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
+ * to the viewport width and limited to that size. This can be combined with
+ * a different style that uses edjes' ellipsis feature (cutting text off like
+ * this: "tex...").
+ *
+ * Items will only call their selection func and callback when first becoming
+ * selected. Any further clicks will do nothing, unless you enable always
+ * select with elm_genlist_always_select_mode_set(). This means even if
+ * selected, every click will make the selected callbacks be called.
+ * elm_genlist_no_select_mode_set() will turn off the ability to select
+ * items entirely and they will neither appear selected nor call selected
+ * callback functions.
+ *
+ * Remember that you can create new styles and add your own theme augmentation
+ * per application with elm_theme_extension_add(). If you absolutely must
+ * have a specific style that overrides any theme the user or system sets up
+ * you can use elm_theme_overlay_add() to add such a file.
+ *
+ * @section Genlist_Implementation Implementation
+ *
+ * Evas tracks every object you create. Every time it processes an event
+ * (mouse move, down, up etc.) it needs to walk through objects and find out
+ * what event that affects. Even worse every time it renders display updates,
+ * in order to just calculate what to re-draw, it needs to walk through many
+ * many many objects. Thus, the more objects you keep active, the more
+ * overhead Evas has in just doing its work. It is advisable to keep your
+ * active objects to the minimum working set you need. Also remember that
+ * object creation and deletion carries an overhead, so there is a
+ * middle-ground, which is not easily determined. But don't keep massive lists
+ * of objects you can't see or use. Genlist does this with list objects. It
+ * creates and destroys them dynamically as you scroll around. It groups them
+ * into blocks so it can determine the visibility etc. of a whole block at
+ * once as opposed to having to walk the whole list. This 2-level list allows
+ * for very large numbers of items to be in the list (tests have used up to
+ * 2,000,000 items). Also genlist employs a queue for adding items. As items
+ * may be different sizes, every item added needs to be calculated as to its
+ * size and thus this presents a lot of overhead on populating the list, this
+ * genlist employs a queue. Any item added is queued and spooled off over
+ * time, actually appearing some time later, so if your list has many members
+ * you may find it takes a while for them to all appear, with your process
+ * consuming a lot of CPU while it is busy spooling.
+ *
+ * Genlist also implements a tree structure, but it does so with callbacks to
+ * the application, with the application filling in tree structures when
+ * requested (allowing for efficient building of a very deep tree that could
+ * even be used for file-management). See the above smart signal callbacks for
+ * details.
+ *
+ * @section Genlist_Smart_Events Genlist smart events
+ *
+ * Signals that you can add callbacks for are:
+ * - @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" - This is called when a user has made an item selected.
+ * The event_info parameter is the genlist item that was selected.
+ * - @c "unselected" - This is called when a user has made an item
+ * unselected. The event_info parameter is the genlist item that was
+ * unselected.
+ * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
+ * called and the item is now meant to be expanded. The event_info
+ * parameter is the genlist item that was indicated to expand. It is the
+ * job of this callback to then fill in the child items.
+ * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
+ * called and the item is now meant to be contracted. The event_info
+ * parameter is the genlist item that was indicated to contract. It is the
+ * job of this callback to then delete the child items.
+ * - @c "expand,request" - This is called when a user has indicated they want
+ * to expand a tree branch item. The callback should decide if the item can
+ * expand (has any children) and then call elm_genlist_item_expanded_set()
+ * appropriately to set the state. The event_info parameter is the genlist
+ * item that was indicated to expand.
+ * - @c "contract,request" - This is called when a user has indicated they
+ * want to contract a tree branch item. The callback should decide if the
+ * item can contract (has any children) and then call
+ * elm_genlist_item_expanded_set() appropriately to set the state. The
+ * event_info parameter is the genlist item that was indicated to contract.
+ * - @c "realized" - This is called when the item in the list is created as a
+ * real evas object. event_info parameter is the genlist item that was
+ * created. The object may be deleted at any time, so it is up to the
+ * caller to not use the object pointer from elm_genlist_item_object_get()
+ * in a way where it may point to freed objects.
+ * - @c "unrealized" - This is called just before an item is unrealized.
+ * After this call icon objects provided will be deleted and the item
+ * object itself delete or be put into a floating cache.
+ * - @c "drag,start,up" - This is called when the item in the list has been
+ * dragged (not scrolled) up.
+ * - @c "drag,start,down" - This is called when the item in the list has been
+ * dragged (not scrolled) down.
+ * - @c "drag,start,left" - This is called when the item in the list has been
+ * dragged (not scrolled) left.
+ * - @c "drag,start,right" - This is called when the item in the list has
+ * been dragged (not scrolled) right.
+ * - @c "drag,stop" - This is called when the item in the list has stopped
+ * being dragged.
+ * - @c "drag" - This is called when the item in the list is being dragged.
+ * - @c "longpressed" - This is called when the item is pressed for a certain
+ * amount of time. By default it's 1 second.
+ * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
+ * the top edge.
+ * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
+ * until the bottom edge.
+ * - @c "scroll,edge,left" - This is called when the genlist is scrolled
+ * until the left edge.
+ * - @c "scroll,edge,right" - This is called when the genlist is scrolled
+ * until the right edge.
+ * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
+ * swiped left.
+ * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
+ * swiped right.
+ * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
+ * swiped up.
+ * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
+ * swiped down.
+ * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
+ * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
+ * multi-touch pinched in.
+ * - @c "swipe" - This is called when the genlist is swiped.
+ */
+
+ /**
+ * @addtogroup Genlist
+ * @{
+ */
+
+ /**
+ * @enum _Elm_Genlist_Item_Flags
+ * @typedef Elm_Genlist_Item_Flags
+ *
+ * Defines if the item is of any special type (has subitems or it's the
+ * index of a group), or is just a simple item.
+ *
+ * @ingroup Genlist
+ */
typedef enum _Elm_Genlist_Item_Flags
{
- ELM_GENLIST_ITEM_NONE = 0,
- ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
- ELM_GENLIST_ITEM_GROUP = (1 << 1)
+ ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
+ ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
+ ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
} Elm_Genlist_Item_Flags;
- typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
+ typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
- typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
- typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
- typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
- typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
- typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
+ typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
+ typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
+ typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
+ typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
+ typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
+ /**
+ * @struct _Elm_Genlist_Item_Class
+ *
+ * Genlist item class definition structs.
+ *
+ * This struct contains the style and fetching functions that will define the
+ * contents of each item.
+ *
+ * @see @ref Genlist_Item_Class
+ */
struct _Elm_Genlist_Item_Class
{
- const char *item_style;
+ const char *item_style; /**< style of this class. */
struct
{
- GenlistItemLabelGetFunc label_get;
- GenlistItemIconGetFunc icon_get;
- GenlistItemStateGetFunc state_get;
- GenlistItemDelFunc del;
+ GenlistItemLabelGetFunc label_get; /**< Label fetching class function for genlist item classes.*/
+ GenlistItemIconGetFunc icon_get; /**< Icon fetching class function for genlist item classes. */
+ GenlistItemStateGetFunc state_get; /**< State fetching class function for genlist item classes. */
+ GenlistItemDelFunc del; /**< Deletion class function for genlist item classes. */
GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
} func;
const char *mode_item_style;
};
+ /**
+ * Add a new Genlist object
+ *
+ * @param parent The parent object
+ * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Genlist
+ */
EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * Clear the genlist
+ *
+ * This clears all items in the list, leaving it empty.
+ *
+ * @param obj The genlist object
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Enable or disable multi-selection in the genlist
+ *
+ * @param obj The genlist object
+ * @param multi Multi-select enable/disable. Default is disabled.
+ *
+ * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
+ * the list. This allows more than 1 item to be selected. To retrieve the list
+ * of selected items, use elm_genlist_selected_items_get().
+ *
+ * @see elm_genlist_selected_items_get()
+ * @see elm_genlist_multi_select_get()
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
+ /**
+ * Gets if multi-selection in genlist is enabled or disabled.
+ *
+ * @param obj The genlist object
+ * @return Multi-select enabled/disabled
+ * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
+ *
+ * @see elm_genlist_multi_select_set()
+ *
+ * @ingroup Genlist
+ */
EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * This sets the horizontal stretching mode.
+ *
+ * @param obj The genlist object
+ * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
+ *
+ * This sets the mode used for sizing items horizontally. Valid modes
+ * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
+ * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
+ * the scroller will scroll horizontally. Otherwise items are expanded
+ * to fill the width of the viewport of the scroller. If it is
+ * ELM_LIST_LIMIT, items will be expanded to the viewport width and
+ * limited to that size.
+ *
+ * @see elm_genlist_horizontal_mode_get()
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
+ /**
+ * Gets the horizontal stretching mode.
+ *
+ * @param obj The genlist object
+ * @return The mode to use
+ * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
+ *
+ * @see elm_genlist_horizontal_mode_set()
+ *
+ * @ingroup Genlist
+ */
EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the always select mode.
+ *
+ * @param obj The genlist object
+ * @param always_select The always select mode (@c EINA_TRUE = on, @c
+ * EINA_FALSE = off). Default is @c EINA_FALSE.
+ *
+ * Items will only call their selection func and callback when first
+ * becoming selected. Any further clicks will do nothing, unless you
+ * enable always select with elm_genlist_always_select_mode_set().
+ * This means that, even if selected, every click will make the selected
+ * callbacks be called.
+ *
+ * @see elm_genlist_always_select_mode_get()
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
+ /**
+ * Get the always select mode.
+ *
+ * @param obj The genlist object
+ * @return The always select mode
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off)
+ *
+ * @see elm_genlist_always_select_mode_set()
+ *
+ * @ingroup Genlist
+ */
EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Enable/disable the no select mode.
+ *
+ * @param obj The genlist object
+ * @param no_select The no select mode
+ * (EINA_TRUE = on, EINA_FALSE = off)
+ *
+ * This will turn off the ability to select items entirely and they
+ * will neither appear selected nor call selected callback functions.
+ *
+ * @see elm_genlist_no_select_mode_get()
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
+ /**
+ * Gets whether the no select mode is enabled.
+ *
+ * @param obj The genlist object
+ * @return The no select mode
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off)
+ *
+ * @see elm_genlist_no_select_mode_set()
+ *
+ * @ingroup Genlist
+ */
EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Enable/disable compress mode.
+ *
+ * @param obj The genlist object
+ * @param compress The compress mode
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
+ *
+ * This will enable the compress mode where items are "compressed"
+ * horizontally to fit the genlist scrollable viewport width. This is
+ * special for genlist. Do not rely on
+ * elm_genlist_horizontal_mode_set() being set to @c ELM_LIST_COMPRESS to
+ * work as genlist needs to handle it specially.
+ *
+ * @see elm_genlist_compress_mode_get()
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
+ /**
+ * Get whether the compress mode is enabled.
+ *
+ * @param obj The genlist object
+ * @return The compress mode
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off)
+ *
+ * @see elm_genlist_compress_mode_set()
+ *
+ * @ingroup Genlist
+ */
EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Enable/disable height-for-width mode.
+ *
+ * @param obj The genlist object
+ * @param setting The height-for-width mode (@c EINA_TRUE = on,
+ * @c EINA_FALSE = off). Default is @c EINA_FALSE.
+ *
+ * With height-for-width mode the item width will be fixed (restricted
+ * to a minimum of) to the list width when calculating its size in
+ * order to allow the height to be calculated based on it. This allows,
+ * for instance, text block to wrap lines if the Edje part is
+ * configured with "text.min: 0 1".
+ *
+ * @note This mode will make list resize slower as it will have to
+ * recalculate every item height again whenever the list width
+ * changes!
+ *
+ * @note When height-for-width mode is enabled, it also enables
+ * compress mode (see elm_genlist_compress_mode_set()) and
+ * disables homogeneous (see elm_genlist_homogeneous_set()).
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
+ /**
+ * Get whether the height-for-width mode is enabled.
+ *
+ * @param obj The genlist object
+ * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
+ * off)
+ *
+ * @ingroup Genlist
+ */
EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Enable/disable horizontal and vertical bouncing effect.
+ *
+ * @param obj The genlist object
+ * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
+ * EINA_FALSE = off). Default is @c EINA_FALSE.
+ * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
+ * EINA_FALSE = off). Default is @c EINA_TRUE.
+ *
+ * This will enable or disable the scroller bouncing effect for the
+ * genlist. See elm_scroller_bounce_set() for details.
+ *
+ * @see elm_scroller_bounce_set()
+ * @see elm_genlist_bounce_get()
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
+ /**
+ * Get whether the horizontal and vertical bouncing effect is enabled.
+ *
+ * @param obj The genlist object
+ * @param h_bounce Pointer to a bool to receive if the bounce horizontally
+ * option is set.
+ * @param v_bounce Pointer to a bool to receive if the bounce vertically
+ * option is set.
+ *
+ * @see elm_genlist_bounce_set()
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
+ /**
+ * Enable/disable homogenous mode.
+ *
+ * @param obj The genlist object
+ * @param homogeneous Assume the items within the genlist are of the
+ * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
+ * EINA_FALSE.
+ *
+ * This will enable the homogeneous mode where items are of the same
+ * height and width so that genlist may do the lazy-loading at its
+ * maximum (which increases the performance for scrolling the list). This
+ * implies 'compressed' mode.
+ *
+ * @see elm_genlist_compress_mode_set()
+ * @see elm_genlist_homogeneous_get()
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
+ /**
+ * Get whether the homogenous mode is enabled.
+ *
+ * @param obj The genlist object
+ * @return Assume the items within the genlist are of the same height
+ * and width (EINA_TRUE = on, EINA_FALSE = off)
+ *
+ * @see elm_genlist_homogeneous_set()
+ *
+ * @ingroup Genlist
+ */
EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the maximum number of items within an item block
+ *
+ * @param obj The genlist object
+ * @param n Maximum number of items within an item block. Default is 32.
+ *
+ * This will configure the block count to tune to the target with
+ * particular performance matrix.
+ *
+ * A block of objects will be used to reduce the number of operations due to
+ * many objects in the screen. It can determine the visibility, or if the
+ * object has changed, it theme needs to be updated, etc. doing this kind of
+ * calculation to the entire block, instead of per object.
+ *
+ * The default value for the block count is enough for most lists, so unless
+ * you know you will have a lot of objects visible in the screen at the same
+ * time, don't try to change this.
+ *
+ * @see elm_genlist_block_count_get()
+ * @see @ref Genlist_Implementation
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
+ /**
+ * Get the maximum number of items within an item block
+ *
+ * @param obj The genlist object
+ * @return Maximum number of items within an item block
+ *
+ * @see elm_genlist_block_count_set()
+ *
+ * @ingroup Genlist
+ */
EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the timeout in seconds for the longpress event.
+ *
+ * @param obj The genlist object
+ * @param timeout timeout in seconds. Default is 1.
+ *
+ * This option will change how long it takes to send an event "longpressed"
+ * after the mouse down signal is sent to the list. If this event occurs, no
+ * "clicked" event will be sent.
+ *
+ * @see elm_genlist_longpress_timeout_set()
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
+ /**
+ * Get the timeout in seconds for the longpress event.
+ *
+ * @param obj The genlist object
+ * @return timeout in seconds
+ *
+ * @see elm_genlist_longpress_timeout_get()
+ *
+ * @ingroup Genlist
+ */
EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/* operations to add items */
EAPI Elm_Genlist_Item *elm_genlist_item_append(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
EAPI Elm_Genlist_Item *elm_genlist_item_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func,const void *func_data);
EAPI Elm_Genlist_Item *elm_genlist_item_direct_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
/* operations to retrieve existing items */
+ /**
+ * Get the selectd item in the genlist.
+ *
+ * @param obj The genlist object
+ * @return The selected item, or NULL if none is selected.
+ *
+ * This gets the selected item in the list (if multi-selection is enabled, only
+ * the item that was first selected in the list is returned - which is not very
+ * useful, so see elm_genlist_selected_items_get() for when multi-selection is
+ * used).
+ *
+ * If no item is selected, NULL is returned.
+ *
+ * @see elm_genlist_selected_items_get()
+ *
+ * @ingroup Genlist
+ */
EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Get a list of selected items in the genlist.
+ *
+ * @param obj The genlist object
+ * @return The list of selected items, or NULL if none are selected.
+ *
+ * It returns a list of the selected items. This list pointer is only valid so
+ * long as the selection doesn't change (no items are selected or unselected, or
+ * unselected implicitly by deletion). The list contains Elm_Genlist_Item
+ * pointers. The order of the items in this list is the order which they were
+ * selected, i.e. the first item in this list is the first item that was
+ * selected, and so on.
+ *
+ * @note If not in multi-select mode, consider using function
+ * elm_genlist_selected_item_get() instead.
+ *
+ * @see elm_genlist_multi_select_set()
+ * @see elm_genlist_selected_item_get()
+ *
+ * @ingroup Genlist
+ */
EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Get a list of realized items in genlist
+ *
+ * @param obj The genlist object
+ * @return The list of realized items, nor NULL if none are realized.
+ *
+ * This returns a list of the realized items in the genlist. The list
+ * contains Elm_Genlist_Item pointers. The list must be freed by the
+ * caller when done with eina_list_free(). The item pointers in the
+ * list are only valid so long as those items are not deleted or the
+ * genlist is not deleted.
+ *
+ * @see elm_genlist_realized_items_update()
+ *
+ * @ingroup Genlist
+ */
EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Get the item that is at the x, y canvas coords.
+ *
+ * @param obj The gelinst object.
+ * @param x The input x coordinate
+ * @param y The input y coordinate
+ * @param posret The position relative to the item returned here
+ * @return The item at the coordinates or NULL if none
+ *
+ * This returns the item at the given coordinates (which are canvas
+ * relative, not object-relative). If an item is at that coordinate,
+ * that item handle is returned, and if @p posret is not NULL, the
+ * integer pointed to is set to a value of -1, 0 or 1, depending if
+ * the coordinate is on the upper portion of that item (-1), on the
+ * middle section (0) or on the lower part (1). If NULL is returned as
+ * an item (no item found there), then posret may indicate -1 or 1
+ * based if the coordinate is above or below all items respectively in
+ * the genlist.
+ *
+ * @ingroup Genlist
+ */
EAPI Elm_Genlist_Item *elm_genlist_at_xy_item_get(const Evas_Object *obj, Evas_Coord x, Evas_Coord y, int *posret) EINA_ARG_NONNULL(1);
EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * Set the scrollbar policy
+ *
+ * @param obj The genlist object
+ * @param policy_h Horizontal scrollbar policy.
+ * @param policy_v Vertical scrollbar policy.
+ *
+ * This sets the scrollbar visibility policy for the given genlist
+ * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
+ * made visible if it is needed, and otherwise kept hidden.
+ * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
+ * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
+ * respectively for the horizontal and vertical scrollbars. Default is
+ * #ELM_SMART_SCROLLER_POLICY_AUTO
+ *
+ * @see elm_genlist_scroller_policy_get()
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
+ /**
+ * Get the scrollbar policy
+ *
+ * @param obj The genlist object
+ * @param policy_h Pointer to store the horizontal scrollbar policy.
+ * @param policy_v Pointer to store the vertical scrollbar policy.
+ *
+ * @see elm_genlist_scroller_policy_set()
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
/* available item styles:
* default
EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
+ /**
+ * Update the contents of all realized items.
+ *
+ * @param obj The genlist object.
+ *
+ * This updates all realized items by calling all the item class functions again
+ * to get the icons, labels and states. Use this when the original
+ * item data has changed and the changes are desired to be reflected.
+ *
+ * @see elm_genlist_realized_items_get()
+ *
+ * @ingroup Genlist
+ */
EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
- /* Signals that you can add callbacks for are:
- * - @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.
- * "selected" - This is called when a user has made an item selected. The
- * event_info parameter is the genlist item that was selected.
- * "unselected" - This is called when a user has made an item unselected. The
- * event_info parameter is the genlist item that was
- * unselected.
- * "expanded" - This is called when elm_genlist_item_expanded_set() is called
- * and the item is now meant to be expanded. The event_info
- * parameter is the genlist item that was indicated to expand.
- * It is the job of this callback to then fill in the child
- * items.
- * "contracted" - This is called when elm_genlist_item_expanded_set() is
- * called and the item is now meant to be contracted. The
- * event_info parameter is the genlist item that was indicated
- * to contract. It is the job of this callback to then delete
- * the child items.
- * "expand,request" - This is called when a user has indicated they want to
- * expand a tree branch item. The callback should decide
- * if the item can expand (has any children) and then call
- * elm_genlist_item_expanded_set() appropriately to set
- * the state. The event_info parameter is the genlist item
- * that was indicated to expand.
- * "contract,request" - This is called when a user has indicated they want to
- * contract a tree branch item. The callback should
- * decide if the item can contract (has any children)
- * and then call elm_genlist_item_expanded_set()
- * appropriately to set the state. The event_info
- * parameter is the genlist item that was indicated to
- * contract.
- * "realized" - This is called when the item in the list is created as a real
- * evas object. event_info parameter is the genlist item that
- * was created. The object may be deleted at any time, so it is
- * up to the caller to not use the object pointer from
- * elm_genlist_item_object_get() in a way where it may point to
- * freed objects.
- * "unrealized" - This is called just before an item is unrealized. After
- * this call icon objects provided will be deleted and the
- * item object itself delete or be put into a floating cache.
- * "drag,start,up" - This is called when the item in the list has been
- * dragged (not scrolled) up.
- * "drag,start,down" - This is called when the item in the list has been
- * dragged (not scrolled) down.
- * "drag,start,left" - This is called when the item in the list has been
- * dragged (not scrolled) left.
- * "drag,start,right" - This is called when the item in the list has been
- * dragged (not scrolled) right.
- * "drag,stop" - This is called when the item in the list has stopped being
- * dragged.
- * "drag" - This is called when the item in the list is being dragged.
- * "longpressed" - This is called when the item is pressed for a certain
- * amount of time. By default it's 1 second.
- * "scroll,edge,top" - This is called when the genlist is scrolled until the
- * top edge.
- * "scroll,edge,bottom" - This is called when the genlist is scrolled until
- * the bottom edge.
- * "scroll,edge,left" - This is called when the genlist is scrolled until the
- * left edge.
- * "scroll,edge,right" - This is called when the genlist is scrolled until
- * the right edge.
- * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
- * left.
- * "multi,swipe,right" - This is called when the genlist is multi-touch
- * swiped right.
- * "multi,swipe,up" - This is called when the genlist is multi-touch swiped
- * up.
- * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
- * down.
- * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
- * out.
- * "multi,pinch,in" - This is called when the genlist is multi-touch pinched
- * in.
- * "swipe" - This is called when the genlist is swiped.
+
+ /**
+ * @}
*/
/**
#define MAX_ITEMS_PER_BLOCK 32
#define REORDER_EFFECT_TIME 0.5
-/**
- * @defgroup Genlist Genlist
- *
- * The aim was to have more expansive list than the simple list in
- * Elementary that could have more flexible items and allow many more entries
- * while still being fast and low on memory usage. At the same time it was
- * also made to be able to do tree structures. But the price to pay is more
- * complex when it comes to usage. If all you want is a simple list with
- * icons and a single label, use the normal List object.
- *
- * Genlist has a fairly large API, mostly because it's relatively complex,
- * trying to be both expansive, powerful and efficient. First we will begin
- * an overview on the theory behind genlist.
- *
- * Evas tracks every object you create. Every time it processes an event
- * (mouse move, down, up etc.) it needs to walk through objects and find out
- * what event that affects. Even worse every time it renders display updates,
- * in order to just calculate what to re-draw, it needs to walk through many
- * many many objects. Thus, the more objects you keep active, the more
- * overhead Evas has in just doing its work. It is advisable to keep your
- * active objects to the minimum working set you need. Also remember that
- * object creation and deletion carries an overhead, so there is a
- * middle-ground, which is not easily determined. But don't keep massive lists
- * of objects you can't see or use. Genlist does this with list objects. It
- * creates and destroys them dynamically as you scroll around. It groups them
- * into blocks so it can determine the visibility etc. of a whole block at
- * once as opposed to having to walk the whole list. This 2-level list allows
- * for very large numbers of items to be in the list (tests have used up to
- * 2,000,000 items). Also genlist employs a queue for adding items. As items
- * may be different sizes, every item added needs to be calculated as to its
- * size and thus this presents a lot of overhead on populating the list, this
- * genlist employs a queue. Any item added is queued and spooled off over
- * time, actually appearing some time later, so if your list has many members
- * you may find it takes a while for them to all appear, with your process
- * consuming a lot of CPU while it is busy spooling.
- *
- * Genlist also implements a tree structure, but it does so with callbacks to
- * the application, with the application filling in tree structures when
- * requested (allowing for efficient building of a very deep tree that could
- * even be used for file-management). See the above smart signal callbacks for
- * details.
- *
- * An item in the genlist world can have 0 or more text labels (they can be
- * regular text or textblock - that's up to the style to determine), 0 or
- * more icons (which are simply objects swallowed into the genlist item) and
- * 0 or more boolean states that can be used for check, radio or other
- * indicators by the edje theme style. An item may be one of several styles
- * (Elementary provides 4 by default - "default", "double_label", "group_index"
- * and "icon_top_text_bottom", but this can be extended by system or
- * application custom themes/overlays/extensions).
- *
- * In order to implement the ability to add and delete items on the fly,
- * Genlist implements a class/callback system where the application provides
- * a structure with information about that type of item (genlist may contain
- * multiple different items with different classes, states and styles).
- * Genlist will call the functions in this struct (methods) when an item is
- * "realized" (that is created dynamically while scrolling). All objects will
- * simply be deleted when no longer needed with evas_object_del(). The
- * Elm_Genlist_Item_Class structure contains the following members:
- *
- * item_style - This is a constant string and simply defines the name of the
- * item style. It must be specified and the default should be "default".
- *
- * func.label_get - This function is called when an actual item object is
- * created. The data parameter is the data parameter passed to
- * elm_genlist_item_append() and related item creation functions. The obj
- * parameter is the genlist object and the part parameter is the string name
- * of the text part in the edje design that is listed as one of the possible
- * labels that can be set. This function must return a strudup()'ed string as
- * the caller will free() it when done.
- *
- * func.icon_get - This function is called when an actual item object is
- * created. The data parameter is the data parameter passed to
- * elm_genlist_item_append() and related item creation functions. The obj
- * parameter is the genlist object and the part parameter is the string name
- * of the icon part in the edje design that is listed as one of the possible
- * icons that can be set. This must return NULL for no object or a valid
- * object. The object will be deleted by genlist on shutdown or when the item
- * is unrealized.
- *
- * func.state_get - This function is called when an actual item object is
- * created. The data parameter is the data parameter passed to
- * elm_genlist_item_append() and related item creation functions. The obj
- * parameter is the genlist object and the part parameter is the string name
- * of the state part in the edje design that is listed as one of the possible
- * states that can be set. Return 0 for false or 1 for true. Genlist will
- * emit a signal to the edje object with "elm,state,XXX,active" "elm" when
- * true (the default is false), where XXX is the name of the part.
- *
- * func.del - This is called when elm_genlist_item_del() is called on an
- * item, elm_genlist_clear() is called on the genlist, or
- * elm_genlist_item_subitems_clear() is called to clear sub-items. This is
- * intended for use when actual genlist items are deleted, so any backing
- * data attached to the item (e.g. its data parameter on creation) can be
- * deleted.
- *
- * Items can be added by several calls. All of them return a Elm_Genlist_Item
- * handle that is an internal member inside the genlist. They all take a data
- * parameter that is meant to be used for a handle to the applications
- * internal data (eg the struct with the original item data). The parent
- * parameter is the parent genlist item this belongs to if it is a tree or
- * an indexed group, and NULL if there is no parent. The flags can be a bitmask
- * of ELM_GENLIST_ITEM_NONE, ELM_GENLIST_ITEM_SUBITEMS and
- * ELM_GENLIST_ITEM_GROUP. If ELM_GENLIST_ITEM_SUBITEMS is set then this item
- * is displayed as an item that is able to expand and have child items.
- * If ELM_GENLIST_ITEM_GROUP is set then this item is group idex item that is
- * displayed at the top until the next group comes. The func parameter is a
- * convenience callback that is called when the item is selected and the data
- * parameter will be the func_data parameter, obj be the genlist object and
- * event_info will be the genlist item.
- *
- * elm_genlist_item_append() appends an item to the end of the list, or if
- * there is a parent, to the end of all the child items of the parent.
- * elm_genlist_item_prepend() is the same but prepends to the beginning of
- * the list or children list. elm_genlist_item_insert_before() inserts at
- * item before another item and elm_genlist_item_insert_after() inserts after
- * the indicated item.
- *
- * The application can clear the list with elm_genlist_clear() which deletes
- * all the items in the list and elm_genlist_item_del() will delete a specific
- * item. elm_genlist_item_subitems_clear() will clear all items that are
- * children of the indicated parent item.
- *
- * If the application wants multiple items to be able to be selected,
- * elm_genlist_multi_select_set() can enable this. If the list is
- * single-selection only (the default), then elm_genlist_selected_item_get()
- * will return the selected item, if any, or NULL I none is selected. If the
- * list is multi-select then elm_genlist_selected_items_get() will return a
- * list (that is only valid as long as no items are modified (added, deleted,
- * selected or unselected)).
- *
- * To help inspect list items you can jump to the item at the top of the list
- * with elm_genlist_first_item_get() which will return the item pointer, and
- * similarly elm_genlist_last_item_get() gets the item at the end of the list.
- * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
- * and previous items respectively relative to the indicated item. Using
- * these calls you can walk the entire item list/tree. Note that as a tree
- * the items are flattened in the list, so elm_genlist_item_parent_get() will
- * let you know which item is the parent (and thus know how to skip them if
- * wanted).
- *
- * There are also convenience functions. elm_genlist_item_genlist_get() will
- * return the genlist object the item belongs to. elm_genlist_item_show()
- * will make the scroller scroll to show that specific item so its visible.
- * elm_genlist_item_data_get() returns the data pointer set by the item
- * creation functions.
- *
- * If an item changes (state of boolean changes, label or icons change),
- * then use elm_genlist_item_update() to have genlist update the item with
- * the new state. Genlist will re-realize the item thus call the functions
- * in the _Elm_Genlist_Item_Class for that item.
- *
- * To programmatically (un)select an item use elm_genlist_item_selected_set().
- * To get its selected state use elm_genlist_item_selected_get(). Similarly
- * to expand/contract an item and get its expanded state, use
- * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
- * again to make an item disabled (unable to be selected and appear
- * differently) use elm_genlist_item_disabled_set() to set this and
- * elm_genlist_item_disabled_get() to get the disabled state.
- *
- * In general to indicate how the genlist should expand items horizontally to
- * fill the list area, use elm_genlist_horizontal_mode_set(). Valid modes are
- * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
- * mode means that if items are too wide to fit, the scroller will scroll
- * horizontally. Otherwise items are expanded to fill the width of the
- * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
- * to the viewport width and limited to that size. This can be combined with
- * a different style that uses edjes' ellipsis feature (cutting text off like
- * this: "tex...").
- *
- * Items will only call their selection func and callback when first becoming
- * selected. Any further clicks will do nothing, unless you enable always
- * select with elm_genlist_always_select_mode_set(). This means even if
- * selected, every click will make the selected callbacks be called.
- * elm_genlist_no_select_mode_set() will turn off the ability to select
- * items entirely and they will neither appear selected nor call selected
- * callback functions.
- *
- * Remember that you can create new styles and add your own theme augmentation
- * per application with elm_theme_extension_add(). If you absolutely must
- * have a specific style that overrides any theme the user or system sets up
- * you can use elm_theme_overlay_add() to add such a file.
- *
- */
-
typedef struct _Widget_Data Widget_Data;
typedef struct _Item_Block Item_Block;
typedef struct _Pan Pan;
}
}
-/**
- * Add a new Genlist object
- *
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
- *
- * @ingroup Genlist
- */
EAPI Evas_Object *
elm_genlist_add(Evas_Object *parent)
{
}
/**
- * Append item to the end of the genlist
+ * Add item to the end of the genlist
*
- * This appends the given item to the end of the list or the end of
+ * This adds the given item to the end of the list or the end of
* the children if the parent is given.
*
* @param obj The genlist object
}
/**
- * Prepend item at start of the genlist
+ * Add item at start of the genlist
*
* This adds an item to the beginning of the list or beginning of the
* children of the parent if given.
return it;
}
-/**
- * Clear the genlist
- *
- * This clears all items in the list, leaving it empty.
- *
- * @param obj The genlist object
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_clear(Evas_Object *obj)
{
evas_event_thaw_eval(evas_object_evas_get(wd->obj));
}
-/**
- * Enable or disable multi-select in the genlist
- *
- * This enables (EINA_TRUE) or disables (EINA_FALSE) multi-select in
- * the list. This allows more than 1 item to be selected.
- *
- * @param obj The genlist object
- * @param multi Multi-select enable/disable
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_multi_select_set(Evas_Object *obj,
Eina_Bool multi)
wd->multi = multi;
}
-/**
- * Gets if multi-select in genlist is enable or disable
- *
- * @param obj The genlist object
- * @return Multi-select enable/disable
- * (EINA_TRUE = enabled/EINA_FALSE = disabled)
- *
- * @ingroup Genlist
- */
EAPI Eina_Bool
elm_genlist_multi_select_get(const Evas_Object *obj)
{
return wd->multi;
}
-/**
- * Get the selectd item in the genlist
- *
- * This gets the selected item in the list (if multi-select is enabled
- * only the first item in the list is selected - which is not very
- * useful, so see elm_genlist_selected_items_get() for when
- * multi-select is used).
- *
- * If no item is selected, NULL is returned.
- *
- * @param obj The genlist object
- * @return The selected item, or NULL if none.
- *
- * @ingroup Genlist
- */
EAPI Elm_Genlist_Item *
elm_genlist_selected_item_get(const Evas_Object *obj)
{
return NULL;
}
-/**
- * Get a list of selected items in the genlist
- *
- * This returns a list of the selected items. This list pointer is
- * only valid so long as no items are selected or unselected (or
- * unselected implicitly by deletion). The list contains
- * Elm_Genlist_Item pointers.
- *
- * @param obj The genlist object
- * @return The list of selected items, nor NULL if none are selected.
- *
- * @ingroup Genlist
- */
EAPI const Eina_List *
elm_genlist_selected_items_get(const Evas_Object *obj)
{
return wd->selected;
}
-/**
- * Get a list of realized items in genlist
- *
- * This returns a list of the realized items in the genlist. The list
- * contains Elm_Genlist_Item pointers. The list must be freed by the
- * caller when done with eina_list_free(). The item pointers in the
- * list are only valid so long as those items are not deleted or the
- * genlist is not deleted.
- *
- * @param obj The genlist object
- * @return The list of realized items, nor NULL if none are realized.
- *
- * @ingroup Genlist
- */
EAPI Eina_List *
elm_genlist_realized_items_get(const Evas_Object *obj)
{
return list;
}
-/**
- * Get the item that is at the x, y canvas coords
- *
- * This returns the item at the given coordinates (which are canvas
- * relative not object-relative). If an item is at that coordinate,
- * that item handle is returned, and if @p posret is not NULL, the
- * integer pointed to is set to a value of -1, 0 or 1, depending if
- * the coordinate is on the upper portion of that item (-1), on the
- * middle section (0) or on the lower part (1). If NULL is returned as
- * an item (no item found there), then posret may indicate -1 or 1
- * based if the coordinate is above or below all items respectively in
- * the genlist.
- *
- * @param it The item
- * @param x The input x coordinate
- * @param y The input y coordinate
- * @param posret The position relative to the item returned here
- * @return The item at the coordinates or NULL if none
- *
- * @ingroup Genlist
- */
EAPI Elm_Genlist_Item *
elm_genlist_at_xy_item_get(const Evas_Object *obj,
Evas_Coord x,
return elm_widget_item_cursor_engine_only_get(item);
}
-/**
- * This sets the horizontal stretching mode
- *
- * This sets the mode used for sizing items horizontally. Valid modes
- * are ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is
- * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
- * the scroller will scroll horizontally. Otherwise items are expanded
- * to fill the width of the viewport of the scroller. If it is
- * ELM_LIST_LIMIT, Items will be expanded to the viewport width and
- * limited to that size.
- *
- * @param obj The genlist object
- * @param mode The mode to use
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_horizontal_mode_set(Evas_Object *obj,
Elm_List_Mode mode)
_sizing_eval(obj);
}
-/**
- * Gets the horizontal stretching mode
- *
- * @param obj The genlist object
- * @return The mode to use
- * (ELM_LIST_LIMIT, ELM_LIST_SCROLL)
- *
- * @ingroup Genlist
- */
EAPI Elm_List_Mode
elm_genlist_horizontal_mode_get(const Evas_Object *obj)
{
return wd->mode;
}
-/**
- * Set the always select mode.
- *
- * Items will only call their selection func and callback when first
- * becoming selected. Any further clicks will do nothing, unless you
- * enable always select with elm_genlist_always_select_mode_set().
- * This means even if selected, every click will make the selected
- * callbacks be called.
- *
- * @param obj The genlist object
- * @param always_select The always select mode
- * (EINA_TRUE = on, EINA_FALSE = off)
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_always_select_mode_set(Evas_Object *obj,
Eina_Bool always_select)
wd->always_select = always_select;
}
-/**
- * Get the always select mode.
- *
- * @param obj The genlist object
- * @return The always select mode
- * (EINA_TRUE = on, EINA_FALSE = off)
- *
- * @ingroup Genlist
- */
EAPI Eina_Bool
elm_genlist_always_select_mode_get(const Evas_Object *obj)
{
return wd->always_select;
}
-/**
- * Set no select mode
- *
- * This will turn off the ability to select items entirely and they
- * will neither appear selected nor call selected callback functions.
- *
- * @param obj The genlist object
- * @param no_select The no select mode
- * (EINA_TRUE = on, EINA_FALSE = off)
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_no_select_mode_set(Evas_Object *obj,
Eina_Bool no_select)
wd->no_select = no_select;
}
-/**
- * Gets no select mode
- *
- * @param obj The genlist object
- * @return The no select mode
- * (EINA_TRUE = on, EINA_FALSE = off)
- *
- * @ingroup Genlist
- */
EAPI Eina_Bool
elm_genlist_no_select_mode_get(const Evas_Object *obj)
{
return wd->no_select;
}
-/**
- * Set compress mode
- *
- * This will enable the compress mode where items are "compressed"
- * horizontally to fit the genlist scrollable viewport width. This is
- * special for genlist. Do not rely on
- * elm_genlist_horizontal_mode_set() being set to ELM_LIST_COMPRESS to
- * work as genlist needs to handle it specially.
- *
- * @param obj The genlist object
- * @param compress The compress mode
- * (EINA_TRUE = on, EINA_FALSE = off)
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_compress_mode_set(Evas_Object *obj,
Eina_Bool compress)
if (!compress) elm_genlist_homogeneous_set(obj, EINA_FALSE);
}
-/**
- * Get the compress mode
- *
- * @param obj The genlist object
- * @return The compress mode
- * (EINA_TRUE = on, EINA_FALSE = off)
- *
- * @ingroup Genlist
- */
EAPI Eina_Bool
elm_genlist_compress_mode_get(const Evas_Object *obj)
{
return wd->compress;
}
-/**
- * Set height-for-width mode
- *
- * With height-for-width mode the item width will be fixed (restricted
- * to a minimum of) to the list width when calculating its size in
- * order to allow the height to be calculated based on it. This allows,
- * for instance, text block to wrap lines if the Edje part is
- * configured with "text.min: 0 1".
- *
- * @note This mode will make list resize slower as it will have to
- * recalculate every item height again whenever the list width
- * changes!
- *
- * @note When height-for-width mode is enabled, it also enables
- * compress mode (see elm_genlist_compress_mode_set()) and
- * disables homogeneous (see elm_genlist_homogeneous_set()).
- *
- * @param obj The genlist object
- * @param setting The height-for-width mode (EINA_TRUE = on,
- * EINA_FALSE = off)
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_height_for_width_mode_set(Evas_Object *obj,
Eina_Bool height_for_width)
}
}
-/**
- * Get the height-for-width mode
- *
- * @param obj The genlist object
- * @return The height-for-width mode (EINA_TRUE = on, EINA_FALSE =
- * off)
- *
- * @ingroup Genlist
- */
EAPI Eina_Bool
elm_genlist_height_for_width_mode_get(const Evas_Object *obj)
{
return wd->height_for_width;
}
-/**
- * Set bounce mode
- *
- * This will enable or disable the scroller bounce mode for the
- * genlist. See elm_scroller_bounce_set() for details
- *
- * @param obj The genlist object
- * @param h_bounce Allow bounce horizontally
- * @param v_bounce Allow bounce vertically
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_bounce_set(Evas_Object *obj,
Eina_Bool h_bounce,
elm_smart_scroller_bounce_allow_set(wd->scr, h_bounce, v_bounce);
}
-/**
- * Get the bounce mode
- *
- * @param obj The genlist object
- * @param h_bounce Allow bounce horizontally
- * @param v_bounce Allow bounce vertically
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_bounce_get(const Evas_Object *obj,
Eina_Bool *h_bounce,
elm_smart_scroller_bounce_allow_get(wd->scr, h_bounce, v_bounce);
}
-/**
- * Set homogenous mode
- *
- * This will enable the homogeneous mode where items are of the same
- * height and width so that genlist may do the lazy-loading at its
- * maximum. This implies 'compressed' mode.
- *
- * @param obj The genlist object
- * @param homogeneous Assume the items within the genlist are of the
- * same height and width (EINA_TRUE = on, EINA_FALSE = off)
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_homogeneous_set(Evas_Object *obj,
Eina_Bool homogeneous)
wd->homogeneous = homogeneous;
}
-/**
- * Get the homogenous mode
- *
- * @param obj The genlist object
- * @return Assume the items within the genlist are of the same height
- * and width (EINA_TRUE = on, EINA_FALSE = off)
- *
- * @ingroup Genlist
- */
EAPI Eina_Bool
elm_genlist_homogeneous_get(const Evas_Object *obj)
{
return wd->homogeneous;
}
-/**
- * Set the maximum number of items within an item block
- *
- * This will configure the block count to tune to the target with
- * particular performance matrix.
- *
- * @param obj The genlist object
- * @param n Maximum number of items within an item block
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_block_count_set(Evas_Object *obj,
int n)
_item_cache_clean(wd);
}
-/**
- * Get the maximum number of items within an item block
- *
- * @param obj The genlist object
- * @return Maximum number of items within an item block
- *
- * @ingroup Genlist
- */
EAPI int
elm_genlist_block_count_get(const Evas_Object *obj)
{
return wd->max_items_per_block;
}
-/**
- * Set the timeout in seconds for the longpress event
- *
- * @param obj The genlist object
- * @param timeout timeout in seconds
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_longpress_timeout_set(Evas_Object *obj,
double timeout)
wd->longpress_timeout = timeout;
}
-/**
- * Get the timeout in seconds for the longpress event
- *
- * @param obj The genlist object
- * @return timeout in seconds
- *
- * @ingroup Genlist
- */
EAPI double
elm_genlist_longpress_timeout_get(const Evas_Object *obj)
{
return wd->longpress_timeout;
}
-/**
- * Set the scrollbar policy
- *
- * This sets the scrollbar visibility policy for the given genlist
- * scroller. ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
- * made visible if it is needed, and otherwise kept hidden.
- * ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
- * ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
- * respectively for the horizontal and vertical scrollbars.
- *
- * @param obj The genlist object
- * @param policy_h Horizontal scrollbar policy
- * @param policy_v Vertical scrollbar policy
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_scroller_policy_set(Evas_Object *obj,
Elm_Scroller_Policy policy_h,
elm_smart_scroller_policy_set(wd->scr, policy_h, policy_v);
}
-/**
- * Get the scrollbar policy
- *
- * @param obj The genlist object
- * @param policy_h Horizontal scrollbar policy
- * @param policy_v Vertical scrollbar policy
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_scroller_policy_get(const Evas_Object *obj,
Elm_Scroller_Policy *policy_h,
if (policy_v) *policy_v = (Elm_Scroller_Policy)s_policy_v;
}
-/**
- * Update the contents of all realized items
- *
- * This updates all realized items by calling all the item class functions again
- * to get the icons, labels and states. Use this when the original
- * item data has changed and the changes are desired to be reflected.
- *
- * @param it The item
- *
- * @ingroup Genlist
- */
EAPI void
elm_genlist_realized_items_update(Evas_Object *obj)
{
projects / framework / uifw / elementary.git / commitdiff