* @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.
+ * Elm_Object_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
+ * 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,
* 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
+ * all the items in the list and elm_object_item_del() will delete a specific
* item. elm_genlist_item_subitems_clear() will clear all items that are
* children of the indicated parent item.
*
* let you know which item is the parent (and thus know how to skip them if
* wanted).
*
- * @section Genlist_Muti_Selection Multi-selection
+ * @section Genlist_Multi_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
*
* @section Genlist_Usage_Hints Usage hints
*
- * There are also convenience functions. elm_genlist_item_genlist_get() will
+ * There are also convenience functions. elm_object_item_widget_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
+ * elm_object_item_data_get() returns the data pointer set by the item
* creation functions.
*
* If an item changes (state of boolean changes, text or contents change),
* 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.
+ * differently) use elm_object_item_disabled_set() to set this and
+ * elm_object_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_set(). Valid modes are
* 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.
+ * created.
* - @c "unrealized" - This is called just before an item is unrealized.
* After this call content objects provided will be deleted and the item
* object itself delete or be put into a floating cache.
* 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.
+ * amount of time. By default it's 1 second. The event_info parameter is the
+ * longpressed genlist item.
* - @c "scroll,anim,start" - This is called when scrolling animation has
* started.
* - @c "scroll,anim,stop" - This is called when scrolling animation has
* - @c "language,changed" - This is called when the program's language is
* changed.
*
+ * Supported elm_object common APIs
+ * @li elm_object_signal_emit()
+ *
+ * Supported elm_object_item common APIs
+ * @li elm_object_item_part_content_get()
+ * @li elm_object_item_part_content_set()
+ * @li elm_object_item_part_content_unset()
+ * @li elm_object_item_part_text_set()
+ * @li elm_object_item_part_text_get()
+ * @li elm_object_item_disabled_set()
+ * @li elm_object_item_disabled_get()
+ *
* @section Genlist_Examples Examples
*
* Here is a list of examples that use the genlist, trying to show some of
*
* @ingroup Genlist
*/
-typedef enum
+ typedef enum
{
ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
+ //XXX: ELM_GENLIST_ITEM_TREE
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;
+ ELM_GENLIST_ITEM_GROUP = (1 << 1), /**< index of a group of items */
+
+ ELM_GENLIST_ITEM_MAX = (1 << 2)
+} Elm_Genlist_Item_Type;
typedef enum
{
ELM_GENLIST_ITEM_FIELD_ALL = 0,
- ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
+ ELM_GENLIST_ITEM_FIELD_TEXT = (1 << 0),
ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
-} Elm_Genlist_Item_Field_Flags;
+} Elm_Genlist_Item_Field_Type;
typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
+
#define Elm_Genlist_Item_Class Elm_Gen_Item_Class
-typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
-#define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
/**
* This function inserts a new genlist widget on the canvas.
*
* @see elm_genlist_item_append()
- * @see elm_genlist_item_del()
+ * @see elm_object_item_del()
* @see elm_genlist_clear()
*
* @ingroup Genlist
*
* This removes (and deletes) all items in @p obj, leaving it empty.
*
- * @see elm_genlist_item_del(), to remove just one item.
+ * @see elm_object_item_del(), to remove just one item.
*
* @ingroup Genlist
*/
* ELM_LIST_LIMIT, items will be expanded to the viewport width and
* limited to that size.
*
- * @see elm_genlist_horizontal_get()
+ * @see elm_genlist_mode_get()
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode);
+EAPI void elm_genlist_mode_set(Evas_Object *obj, Elm_List_Mode mode);
/**
* Gets the horizontal stretching mode.
*
* @ingroup Genlist
*/
-EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj);
+EAPI Elm_List_Mode elm_genlist_mode_get(const Evas_Object *obj);
/**
* Set the always select mode.
*
* @ingroup Genlist
*/
+//XXX: How about elm_genlist_select_mode_set() ?
EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
/**
*
* @ingroup Genlist
*/
+//XXX: How about elm_genlist_select_mode_get() ?
EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj);
/**
*
* @ingroup Genlist
*/
+//XXX: elm_genlist_always_select_mode_set and elm_genlist_no_select_mode_set API could be merged to elm_genlist_select_mode_set()
EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
/**
*
* @ingroup Genlist
*/
+//XXX: elm_genlist_always_select_mode_get and elm_genlist_no_select_mode_get API could be merged to elm_genlist_select_mode_get()
EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj);
/**
- * 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_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);
-
-/**
- * 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);
-
-/**
- * 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);
-
-/**
- * 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);
-
-/**
* Enable/disable horizontal and vertical bouncing effect.
*
* @param obj The genlist object
EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
/**
- * Enable/disable homogeneous 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);
-
-/**
- * Get whether the homogeneous 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);
-
-/**
- * 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);
-
-/**
- * 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);
-
-/**
- * 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);
-
-/**
- * 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);
-
-/**
* Append a new item in a given genlist widget.
*
* @param obj The genlist object
* @param itc The item class for the item
* @param data The item data
* @param parent The parent item, or NULL if none
- * @param flags Item flags
+ * @param type Item type
* @param func Convenience function called when the item is selected
* @param func_data Data passed to @p func above.
* @return A handle to the item added or @c NULL if not possible
* @see elm_genlist_item_prepend()
* @see elm_genlist_item_insert_before()
* @see elm_genlist_item_insert_after()
- * @see elm_genlist_item_del()
+ * @see elm_object_item_del()
*
* @ingroup Genlist
*/
-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);
+EAPI Elm_Object_Item *elm_genlist_item_append(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data);
/**
* Prepend a new item in a given genlist widget.
* @param itc The item class for the item
* @param data The item data
* @param parent The parent item, or NULL if none
- * @param flags Item flags
+ * @param type Item type
* @param func Convenience function called when the item is selected
* @param func_data Data passed to @p func above.
* @return A handle to the item added or NULL if not possible
* @see elm_genlist_item_append()
* @see elm_genlist_item_insert_before()
* @see elm_genlist_item_insert_after()
- * @see elm_genlist_item_del()
+ * @see elm_object_item_del()
*
* @ingroup Genlist
*/
-EAPI Elm_Genlist_Item *elm_genlist_item_prepend(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);
+EAPI Elm_Object_Item *elm_genlist_item_prepend(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data);
/**
* Insert an item before another in a genlist widget
* @param obj The genlist object
* @param itc The item class for the item
* @param data The item data
+ * @param parent The parent item, or NULL if none
* @param before The item to place this new one before.
- * @param flags Item flags
+ * @param type Item type
* @param func Convenience function called when the item is selected
* @param func_data Data passed to @p func above.
* @return A handle to the item added or @c NULL if not possible
* @see elm_genlist_item_append()
* @see elm_genlist_item_prepend()
* @see elm_genlist_item_insert_after()
- * @see elm_genlist_item_del()
+ * @see elm_object_item_del()
*
* @ingroup Genlist
*/
-EAPI Elm_Genlist_Item *elm_genlist_item_insert_before(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item *before, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data);
+EAPI Elm_Object_Item *elm_genlist_item_insert_before(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Object_Item *before, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data);
/**
* Insert an item after another in a genlist widget
* @param obj The genlist object
* @param itc The item class for the item
* @param data The item data
+ * @param parent The parent item, or NULL if none
* @param after The item to place this new one after.
- * @param flags Item flags
+ * @param type Item type
* @param func Convenience function called when the item is selected
* @param func_data Data passed to @p func above.
* @return A handle to the item added or @c NULL if not possible
* @see elm_genlist_item_append()
* @see elm_genlist_item_prepend()
* @see elm_genlist_item_insert_before()
- * @see elm_genlist_item_del()
+ * @see elm_object_item_del()
*
* @ingroup Genlist
*/
-EAPI Elm_Genlist_Item *elm_genlist_item_insert_after(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item *after, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data);
+EAPI Elm_Object_Item *elm_genlist_item_insert_after(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Object_Item *after, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data);
/**
* Insert a new item into the sorted genlist object
* @param itc The item class for the item
* @param data The item data
* @param parent The parent item, or NULL if none
- * @param flags Item flags
+ * @param type Item type
* @param comp The function called for the sort
* @param func Convenience function called when item selected
* @param func_data Data passed to @p func above.
* @return A handle to the item added or NULL if not possible
*
+ * This inserts an item in the genlist based on user defined comparison
+ * function. The two arguments passed to the function @p func are genlist item
+ * handles to compare.
+ *
+ * @see elm_genlist_item_append()
+ * @see elm_genlist_item_prepend()
+ * @see elm_genlist_item_insert_after()
+ * @see elm_object_item_del()
+
* @ingroup Genlist
*/
-// XXX: deprecate elm_genlist_item_sorted_insert() and rename
-// elm_genlist_item_direct_sorted_insert()
-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);
+EAPI Elm_Object_Item *elm_genlist_item_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Object_Item *parent, Elm_Genlist_Item_Type type, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
/* operations to retrieve existing items */
/**
- * Get the selectd item in the genlist.
+ * Get the selected item in the genlist.
*
* @param obj The genlist object
* @return The selected item, or NULL if none is selected.
*
* @ingroup Genlist
*/
-EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj);
+EAPI Elm_Object_Item *elm_genlist_selected_item_get(const Evas_Object *obj);
/**
* Get a list of selected items in the genlist.
*
* 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
+ * unselected implicitly by deletion). The list contains genlist items
* 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.
EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj);
/**
- * Get the mode item style of items in the genlist
- * @param obj The genlist object
- * @return The mode item style string, or NULL if none is specified
- *
- * This is a constant string and simply defines the name of the
- * style that will be used for mode animations. It can be
- * @c NULL if you don't plan to use Genlist mode. See
- * elm_genlist_item_mode_set() for more info.
- *
- * @ingroup Genlist
- */
-EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj);
-
-/**
- * Set the mode item style of items in the genlist
- * @param obj The genlist object
- * @param style The mode item style string, or NULL if none is desired
- *
- * This is a constant string and simply defines the name of the
- * style that will be used for mode animations. It can be
- * @c NULL if you don't plan to use Genlist mode. See
- * elm_genlist_item_mode_set() for more info.
- *
- * @ingroup Genlist
- */
-EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style);
-
-/**
* 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
+ * contains 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.
EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj);
/**
- * 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);
-
-/**
* Get the first item in the genlist
*
* This returns the first item in the list.
*
* @ingroup Genlist
*/
-EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj);
+EAPI Elm_Object_Item *elm_genlist_first_item_get(const Evas_Object *obj);
/**
* Get the last item in the genlist
*
* @ingroup Genlist
*/
-EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj);
+EAPI Elm_Object_Item *elm_genlist_last_item_get(const Evas_Object *obj);
/**
* Set the scrollbar policy
* Get the @b next item in a genlist widget's internal list of items,
* given a handle to one of those items.
*
- * @param item The genlist item to fetch next from
+ * @param it The genlist item to fetch next from
* @return The item after @p item, or @c NULL if there's none (and
* on errors)
*
*
* @ingroup Genlist
*/
-EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item);
+EAPI Elm_Object_Item *elm_genlist_item_next_get(const Elm_Object_Item *it);
/**
* Get the @b previous item in a genlist widget's internal list of items,
* given a handle to one of those items.
*
- * @param item The genlist item to fetch previous from
+ * @param it The genlist item to fetch previous from
* @return The item before @p item, or @c NULL if there's none (and
* on errors)
*
*
* @ingroup Genlist
*/
-EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item);
-
-/**
- * Get the genlist object's handle which contains a given genlist
- * item
- *
- * @param item The item to fetch the container from
- * @return The genlist (parent) object
- *
- * This returns the genlist object itself that an item belongs to.
- *
- * @ingroup Genlist
- */
-EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item);
-
-/**
- * Get the parent item of the given item
- *
- * @param it The item
- * @return The parent of the item or @c NULL if it has no parent.
- *
- * This returns the item that was specified as parent of the item @p it on
- * elm_genlist_item_append() and insertion related functions.
- *
- * @ingroup Genlist
- */
-EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it);
-
-/**
- * Remove all sub-items (children) of the given item
- *
- * @param it The item
- *
- * This removes all items that are children (and their descendants) of the
- * given item @p it.
- *
- * @see elm_genlist_clear()
- * @see elm_genlist_item_del()
- *
- * @ingroup Genlist
- */
-EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item);
+EAPI Elm_Object_Item *elm_genlist_item_prev_get(const Elm_Object_Item *it);
/**
* Set whether a given genlist item is selected or not
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected);
+EAPI void elm_genlist_item_selected_set(Elm_Object_Item *it, Eina_Bool selected);
/**
* Get whether a given genlist item is selected or not
*
* @ingroup Genlist
*/
-EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item);
+EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Object_Item *it);
/**
- * Sets the expanded state of an item.
+ * Show the portion of a genlist's internal list containing a given
+ * item, immediately.
*
- * @param it The item
- * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
+ * @param it The item to display
*
- * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
- * expanded or not.
+ * This causes genlist to jump to the given item @p it and show it (by
+ * jumping to that position), if it is not fully visible.
*
- * The theme will respond to this change visually, and a signal "expanded" or
- * "contracted" will be sent from the genlist with a pointer to the item that
- * has been expanded/contracted.
- *
- * Calling this function won't show or hide any child of this item (if it is
- * a parent). You must manually delete and create them on the callbacks fo
- * the "expanded" or "contracted" signals.
- *
- * @see elm_genlist_item_expanded_get()
- *
- * @ingroup Genlist
- */
-EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded);
-
-/**
- * Get the expanded state of an item
- *
- * @param it The item
- * @return The expanded state
- *
- * This gets the expanded state of an item.
- *
- * @see elm_genlist_item_expanded_set()
- *
- * @ingroup Genlist
- */
-EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item);
-
-/**
- * Get the depth of expanded item
- *
- * @param it The genlist item object
- * @return The depth of expanded item
- *
- * @ingroup Genlist
- */
-EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it);
-
-/**
- * Set whether a given genlist item is disabled or not.
- *
- * @param it The item
- * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
- * to enable it back.
- *
- * A disabled item cannot be selected or unselected. It will also
- * change its appearance, to signal the user it's disabled.
- *
- * @see elm_genlist_item_disabled_get()
- *
- * @ingroup Genlist
- */
-EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled);
-
-/**
- * Get whether a given genlist item is disabled or not.
- *
- * @param it The item
- * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
- * (and on errors).
- *
- * @see elm_genlist_item_disabled_set() for more details
- *
- * @ingroup Genlist
- */
-EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item);
-
-/**
- * Sets the display only state of an item.
- *
- * @param it The item
- * @param display_only @c EINA_TRUE if the item is display only, @c
- * EINA_FALSE otherwise.
- *
- * A display only item cannot be selected or unselected. It is for
- * display only and not selecting or otherwise clicking, dragging
- * etc. by the user, thus finger size rules will not be applied to
- * this item.
- *
- * It's good to set group index items to display only state.
- *
- * @see elm_genlist_item_display_only_get()
- *
- * @ingroup Genlist
- */
-EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only);
-
-/**
- * Get the display only state of an item
- *
- * @param it The item
- * @return @c EINA_TRUE if the item is display only, @c
- * EINA_FALSE otherwise.
- *
- * @see elm_genlist_item_display_only_set()
- *
- * @ingroup Genlist
- */
-EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it);
-
-/**
- * Show the portion of a genlist's internal list containing a given
- * item, immediately.
- *
- * @param it The item to display
- *
- * This causes genlist to jump to the given item @p it and show it (by
- * immediately scrolling to that position), if it is not fully visible.
- *
- * @see elm_genlist_item_bring_in()
- * @see elm_genlist_item_top_show()
- * @see elm_genlist_item_middle_show()
+ * @see elm_genlist_item_bring_in()
+ * @see elm_genlist_item_top_show()
+ * @see elm_genlist_item_middle_show()
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_show(Elm_Genlist_Item *item);
+//XXX: elm_genlist_item_show(it, TOP/MIDDLE/BOTTOM/...); this kind of API would cover all similar APIs - item_show, item_top_show...
+EAPI void elm_genlist_item_show(Elm_Object_Item *it);
/**
* Animatedly bring in, to the visible are of a genlist, a given
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item);
+//XXX: elm_genlist_item_bring_in(it, TOP/MIDDLE/BOTTOM/...); this kind of API would cover all similar APIs - bring_in, top_bring_in ...
+EAPI void elm_genlist_item_bring_in(Elm_Object_Item *it);
/**
* Show the portion of a genlist's internal list containing a given
* @param it The item to display
*
* This causes genlist to jump to the given item @p it and show it (by
- * immediately scrolling to that position), if it is not fully visible.
+ * jumping to the top position), if it is not fully visible.
*
* The item will be positioned at the top of the genlist viewport.
*
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item);
+//XXX: elm_genlist_item_show(it, TOP/MIDDLE/BOTTOM/...); this kind of API would cover all similar APIs - item_show, item_top_show...
+EAPI void elm_genlist_item_top_show(Elm_Object_Item *it);
/**
* Animatedly bring in, to the visible are of a genlist, a given
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item);
+//XXX: elm_genlist_item_bring_in(it, TOP/MIDDLE/BOTTOM/...); this kind of API would cover all similar APIs - bring_in, top_bring_in ...
+EAPI void elm_genlist_item_top_bring_in(Elm_Object_Item *it);
/**
* Show the portion of a genlist's internal list containing a given
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it);
+//XXX: elm_genlist_item_show(it, TOP/MIDDLE/BOTTOM/...); this kind of API would cover all similar APIs - item_show, item_top_show...
+EAPI void elm_genlist_item_middle_show(Elm_Object_Item *it);
/**
* Animatedly bring in, to the visible are of a genlist, a given
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it);
+//XXX: elm_genlist_item_bring_in(it, TOP/MIDDLE/BOTTOM/...); this kind of API would cover all similar APIs - bring_in, top_bring_in ...
+EAPI void elm_genlist_item_middle_bring_in(Elm_Object_Item *it);
/**
- * Remove a genlist item from the its parent, deleting it.
+ * Update the contents of an item
+ *
+ * @param it The item
+ *
+ * This updates an item by calling all the item class functions again
+ * to get the contents, texts and states. Use this when the original
+ * item data has changed and the changes are desired to be reflected.
*
- * @param item The item to be removed.
- * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
+ * Use elm_genlist_realized_items_update() to update all already realized
+ * items.
*
- * @see elm_genlist_clear(), to remove all items in a genlist at
- * once.
+ * @see elm_genlist_realized_items_update()
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_del(Elm_Genlist_Item *item);
+EAPI void elm_genlist_item_update(Elm_Object_Item *it);
/**
- * Return the data associated to a given genlist item
- *
- * @param item The genlist item.
- * @return the data associated to this item.
+ * Update the item class of an item
*
- * This returns the @c data value passed on the
- * elm_genlist_item_append() and related item addition calls.
+ * @param it The item
+ * @param itc The item class for the item
*
- * @see elm_genlist_item_append()
- * @see elm_genlist_item_data_set()
+ * This sets another class of the item, changing the way that it is
+ * displayed. After changing the item class, elm_genlist_item_update() is
+ * called on the item @p it.
*
* @ingroup Genlist
*/
-EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item);
+EAPI void elm_genlist_item_item_class_update(Elm_Object_Item *it, const Elm_Genlist_Item_Class *itc);
/**
- * Set the data associated to a given genlist item
+ * Get the Genlist Item class for the given Genlist Item.
*
- * @param item The genlist item
- * @param data The new data pointer to set on it
+ * @param it The genlist item
*
- * This @b overrides the @c data value passed on the
- * elm_genlist_item_append() and related item addition calls. This
- * function @b won't call elm_genlist_item_update() automatically,
- * so you'd issue it afterwards if you want to hove the item
- * updated to reflect the that new data.
- *
- * @see elm_genlist_item_data_get()
+ * This returns the Genlist_Item_Class for the given item. It can be used to
+ * examine the function pointers and item_style.
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data);
+EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Object_Item *it);
/**
- * Tells genlist to "orphan" contents fetchs by the item class
- *
- * @param it The item
+ * Get the index of the item. It is only valid once displayed.
*
- * This instructs genlist to release references to contents in the item,
- * meaning that they will no longer be managed by genlist and are
- * floating "orphans" that can be re-used elsewhere if the user wants
- * to.
+ * @param it a genlist item
+ * @return the position inside the list of item.
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it);
+EAPI int elm_genlist_item_index_get(const Elm_Object_Item *it);
/**
- * Get the real Evas object created to implement the view of a
- * given genlist item
+ * Update the contents of all realized items.
+ *
+ * @param obj The genlist object.
*
- * @param item The genlist item.
- * @return the Evas object implementing this item's view.
+ * This updates all realized items by calling all the item class functions again
+ * to get the contents, texts and states. Use this when the original
+ * item data has changed and the changes are desired to be reflected.
*
- * This returns the actual Evas object used to implement the
- * specified genlist item's view. This may be @c NULL, as it may
- * not have been created or may have been deleted, at any time, by
- * the genlist. <b>Do not modify this object</b> (move, resize,
- * show, hide, etc.), as the genlist is controlling it. This
- * function is for querying, emitting custom signals or hooking
- * lower level callbacks for events on that object. Do not delete
- * this object under any circumstances.
+ * To update just one item, use elm_genlist_item_update().
*
- * @see elm_genlist_item_data_get()
+ * @see elm_genlist_realized_items_get()
+ * @see elm_genlist_item_update()
*
* @ingroup Genlist
*/
-EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it);
+EAPI void elm_genlist_realized_items_update(Evas_Object *obj);
/**
- * Update the contents of an item
+ * Return how many items are currently in a list
*
- * @param it The item
- *
- * This updates an item by calling all the item class functions again
- * to get the contents, texts and states. Use this when the original
- * item data has changed and the changes are desired to be reflected.
- *
- * Use elm_genlist_realized_items_update() to update all already realized
- * items.
+ * @param obj The list
+ * @return The total number of list items in the list
*
- * @see elm_genlist_realized_items_update()
+ * This behavior is O(1) and includes items which may or may not be realized.
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_update(Elm_Genlist_Item *item);
+EAPI unsigned int elm_genlist_items_count(const Evas_Object *obj);
+
+#define ELM_GENLIST_ITEM_CLASS_VERSION 2 /* current version number */
+#define ELM_GENLIST_ITEM_CLASS_HEADER ELM_GENLIST_ITEM_CLASS_VERSION, 0, 0
/**
- * Promote an item to the top of the list
+ * Add a new genlist item class in a given genlist widget.
*
- * @param it The item
+ * @return New allocated a genlist item class.
+ *
+ * This adds genlist item class for the genlist widget. When adding a item,
+ * genlist_item_{append, prepend, insert} function needs item class of the item.
+ * Given callback parameters are used at retrieving {text, content} of
+ * added item. Set as NULL if it's not used.
+ * If there's no available memory, return can be NULL.
+ *
+ * @see elm_genlist_item_class_free()
+ * @see elm_genlist_item_append()
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_promote(Elm_Gen_Item *it);
+EAPI Elm_Genlist_Item_Class *elm_genlist_item_class_new(void);
/**
- * Demote an item to the end of the list
+ * Remove a item class in a given genlist widget.
*
- * @param it The item
+ * @param itc The itc to be removed.
+ *
+ * This removes item class from the genlist widget.
+ * Whenever it has no more references to it, item class is going to be freed.
+ * Otherwise it just decreases its reference count.
+ *
+ * @see elm_genlist_item_class_new()
+ * @see elm_genlist_item_class_ref()
+ * @see elm_genlist_item_class_unref()
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_demote(Elm_Gen_Item *it);
+EAPI void elm_genlist_item_class_free(Elm_Genlist_Item_Class *itc);
/**
- * Update the part of an item
+ * Increments object reference count for the item class.
*
- * @param it The item
- * @param parts The name of item's part
- * @param itf The flags of item's part type
- *
- * This updates an item's part by calling item's fetching functions again
- * to get the contents, texts and states. Use this when the original
- * item data has changed and the changes are desired to be reflected.
- * Second parts argument is used for globbing to match '*', '?', and '.'
- * It can be used at updating multi fields.
+ * @param itc The given item class object to reference
*
- * Use elm_genlist_realized_items_update() to update an item's all
- * property.
+ * This API just increases its reference count for item class management.
*
- * @see elm_genlist_item_update()
+ * @see elm_genlist_item_class_unref()
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf);
+EAPI void elm_genlist_item_class_ref(Elm_Genlist_Item_Class *itc);
/**
- * Update the item class of an item
+ * Decrements object reference count for the item class.
*
- * @param it The item
- * @param itc The item class for the item
+ * @param itc The given item class object to reference
*
- * This sets another class fo the item, changing the way that it is
- * displayed. After changing the item class, elm_genlist_item_update() is
- * called on the item @p it.
+ * This API just decreases its reference count for item class management.
+ * Reference count can't be less than 0.
+ *
+ * @see elm_genlist_item_class_ref()
+ * @see elm_genlist_item_class_free()
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc);
-EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it);
+EAPI void elm_genlist_item_class_unref(Elm_Genlist_Item_Class *itc);
+
+
+
+//XXX: Need to review tooltip & cursor APIs
/**
* Set the text to be shown in a given genlist item's tooltips.
*
- * @param item The genlist item
+ * @param it The genlist item
* @param text The text to set in the content
*
* This call will setup the text to be used as tooltip to that item
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text);
+EAPI void elm_genlist_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
/**
* Set the content to be shown in a given genlist item's tooltips
*
- * @param item The genlist item.
+ * @param it The genlist item.
* @param func The function returning the tooltip contents.
* @param data What to provide to @a func as callback data/context.
* @param del_cb Called when data is not needed anymore, either when
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_tooltip_content_cb_set(Elm_Genlist_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
+EAPI void elm_genlist_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
/**
* Unset a tooltip from a given genlist item
*
- * @param item genlist item to remove a previously set tooltip from.
+ * @param it genlist item to remove a previously set tooltip from.
*
* This call removes any tooltip set on @p item. The callback
* provided as @c del_cb to
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item);
+EAPI void elm_genlist_item_tooltip_unset(Elm_Object_Item *it);
/**
* Set a different @b style for a given genlist item's tooltip.
*
- * @param item genlist item with tooltip set
+ * @param it genlist item with tooltip set
* @param style the <b>theme style</b> to use on tooltips (e.g. @c
* "default", @c "transparent", etc)
*
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style);
+EAPI void elm_genlist_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
/**
* Get the style set a given genlist item's tooltip.
*
- * @param item genlist item with tooltip already set on.
+ * @param it genlist item with tooltip already set on.
* @return style the theme style in use, which defaults to
* "default". If the object does not have a tooltip set,
* then @c NULL is returned.
*
* @ingroup Genlist
*/
-EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item);
+EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Object_Item *it);
/**
* @brief Disable size restrictions on an object's tooltip
- * @param item The tooltip's anchor object
+ * @param it The tooltip's anchor object
* @param disable If EINA_TRUE, size restrictions are disabled
* @return EINA_FALSE on failure, EINA_TRUE on success
*
- * This function allows a tooltip to expand beyond its parant window's canvas.
+ * This function allows a tooltip to expand beyond its parent window's canvas.
* It will instead be limited only by the size of the display.
*/
-EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_Genlist_Item *item, Eina_Bool disable);
+EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_set(Elm_Object_Item *it, Eina_Bool disable);
/**
* @brief Retrieve size restriction state of an object's tooltip
- * @param item The tooltip's anchor object
+ * @param it The tooltip's anchor object
* @return If EINA_TRUE, size restrictions are disabled
*
* This function returns whether a tooltip is allowed to expand beyond
- * its parant window's canvas.
+ * its parent window's canvas.
* It will instead be limited only by the size of the display.
*/
-EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_get(const Elm_Genlist_Item *item);
+EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_get(const Elm_Object_Item *it);
/**
* Set the type of mouse pointer/cursor decoration to be shown,
* when the mouse pointer is over the given genlist widget item
*
- * @param item genlist item to customize cursor on
+ * @param it genlist item to customize cursor on
* @param cursor the cursor type's name
*
* This function works analogously as elm_object_cursor_set(), but
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor);
+EAPI void elm_genlist_item_cursor_set(Elm_Object_Item *it, const char *cursor);
/**
* Get the type of mouse pointer/cursor decoration set to be shown,
* when the mouse pointer is over the given genlist widget item
*
- * @param item genlist item with custom cursor set
+ * @param it genlist item with custom cursor set
* @return the cursor type's name or @c NULL, if no custom cursors
* were set to @p item (and on errors)
*
*
* @ingroup Genlist
*/
-EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item);
+EAPI const char *elm_genlist_item_cursor_get(const Elm_Object_Item *it);
/**
* Unset any custom mouse pointer/cursor decoration set to be
* shown, when the mouse pointer is over the given genlist widget
* item, thus making it show the @b default cursor again.
*
- * @param item a genlist item
+ * @param it a genlist item
*
* Use this call to undo any custom settings on this item's cursor
* decoration, bringing it back to defaults (no custom style set).
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item);
+EAPI void elm_genlist_item_cursor_unset(Elm_Object_Item *it);
/**
* Set a different @b style for a given custom cursor set for a
* genlist item.
*
- * @param item genlist item with custom cursor set
+ * @param it genlist item with custom cursor set
* @param style the <b>theme style</b> to use (e.g. @c "default",
* @c "transparent", etc)
*
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style);
+EAPI void elm_genlist_item_cursor_style_set(Elm_Object_Item *it, const char *style);
/**
* Get the current @b style set for a given genlist item's custom
* cursor
*
- * @param item genlist item with custom cursor set.
+ * @param it genlist item with custom cursor set.
* @return style the cursor style in use. If the object does not
* have a cursor set, then @c NULL is returned.
*
*
* @ingroup Genlist
*/
-EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item);
+EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Object_Item *it);
/**
* Set if the (custom) cursor for a given genlist item should be
* searched in its theme, also, or should only rely on the
* rendering engine.
*
- * @param item item with custom (custom) cursor already set on
+ * @param it item with custom (custom) cursor already set on
* @param engine_only Use @c EINA_TRUE to have cursors looked for
* only on those provided by the rendering engine, @c EINA_FALSE to
* have them searched on the widget's theme, as well.
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only);
+EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
/**
* Get if the (custom) cursor for a given genlist item is being
* searched in its theme, also, or is only relying on the rendering
* engine.
*
- * @param item a genlist item
+ * @param it a genlist item
* @return @c EINA_TRUE, if cursors are being looked for only on
* those provided by the rendering engine, @c EINA_FALSE if they
* are being searched on the widget's theme, as well.
*
* @ingroup Genlist
*/
-EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item);
+EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Object_Item *it);
/**
- * Get the index of the item. It is only valid once displayed.
+ * Enable/disable compress mode.
*
- * @param item a genlist item
- * @return the position inside the list of item.
+ * @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_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 int elm_genlist_item_index_get(Elm_Gen_Item *it);
+// XXX: kill this. elm_genlist_height_for_width_mode_set() covers this.
+EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress);
/**
- * 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 contents, texts and states. Use this when the original
- * item data has changed and the changes are desired to be reflected.
+ * Get whether the compress mode is enabled.
*
- * To update just one item, use elm_genlist_item_update().
+ * @param obj The genlist object
+ * @return The compress mode
+ * (@c EINA_TRUE = on, @c EINA_FALSE = off)
*
- * @see elm_genlist_realized_items_get()
- * @see elm_genlist_item_update()
+ * @see elm_genlist_compress_mode_set()
*
* @ingroup Genlist
*/
-EAPI void elm_genlist_realized_items_update(Evas_Object *obj);
+EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj);
/**
- * Activate a genlist mode on an item
- *
- * @param item The genlist item
- * @param mode Mode name
- * @param mode_set Boolean to define set or unset mode.
- *
- * A genlist mode is a different way of selecting an item. Once a mode is
- * activated on an item, any other selected item is immediately unselected.
- * This feature provides an easy way of implementing a new kind of animation
- * for selecting an item, without having to entirely rewrite the item style
- * theme. However, the elm_genlist_selected_* API can't be used to get what
- * item is activate for a mode.
- *
- * The current item style will still be used, but applying a genlist mode to
- * an item will select it using a different kind of animation.
+ * Enable/disable height-for-width mode.
*
- * The current active item for a mode can be found by
- * elm_genlist_mode_item_get().
+ * @param obj The genlist object
+ * @param height_for_width The height-for-width mode (@c EINA_TRUE = on,
+ * @c EINA_FALSE = off). Default is @c EINA_FALSE.
*
- * The characteristics of genlist mode are:
- * - Only one mode can be active at any time, and for only one item.
- * - Genlist handles deactivating other items when one item is activated.
- * - A mode is defined in the genlist theme (edc), and more modes can easily
- * be added.
- * - A mode style and the genlist item style are different things. They
- * can be combined to provide a default style to the item, with some kind
- * of animation for that item when the mode is activated.
+ * 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".
*
- * When a mode is activated on an item, a new view for that item is created.
- * The theme of this mode defines the animation that will be used to transit
- * the item from the old view to the new view. This second (new) view will be
- * active for that item while the mode is active on the item, and will be
- * destroyed after the mode is totally deactivated from that item.
+ * @note This mode will make list resize slower as it will have to
+ * recalculate every item height again whenever the list width
+ * changes!
*
- * @see elm_genlist_mode_get()
- * @see elm_genlist_mode_item_get()
+ * @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_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set);
+//aspect
+//XXX: API name is ambiguous.. How about elm_genlist_mode_fixed_width_set?
+EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width);
/**
- * Get the last (or current) genlist mode used.
+ * Get whether the height-for-width mode is enabled.
*
* @param obj The genlist object
- *
- * This function just returns the name of the last used genlist mode. It will
- * be the current mode if it's still active.
- *
- * @see elm_genlist_item_mode_set()
- * @see elm_genlist_mode_item_get()
+ * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
+ * off)
*
* @ingroup Genlist
*/
-EAPI const char *elm_genlist_mode_get(const Evas_Object *obj);
+//XXX: API name is ambiguous elm_genlist_mode_fixed_width_get() ?????
+EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj);
+
+/**
+ * Enable/disable homogeneous 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);
+
+/**
+ * Get whether the homogeneous 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);
+
+/**
+ * Set the maximum number of items within an item block
+ *
+ * @param obj The genlist object
+ * @param count 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 count);
+
+/**
+ * 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);
+
+/**
+ * Set the timeout in seconds for the longpress event.
+ *
+ * @param obj The genlist object
+ * @param timeout timeout in seconds. Default is elm config value(1.0)
+ *
+ * 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.
+ *
+ * @warning If you set the longpress timeout value with this API, your genlist
+ * will not be affected by the longpress value of elementary config value
+ * later.
+ *
+ * @see elm_genlist_longpress_timeout_set()
+ *
+ * @ingroup Genlist
+ */
+EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout);
+
+/**
+ * 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);
+
+/**
+ * Get the item that is at the x, y canvas coords.
+ *
+ * @param obj The genlist 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_Object_Item *elm_genlist_at_xy_item_get(const Evas_Object *obj, Evas_Coord x, Evas_Coord y, int *posret);
+
+/**
+ * Get the parent item of the given item
+ *
+ * @param it The item
+ * @return The parent of the item or @c NULL if it has no parent.
+ *
+ * This returns the item that was specified as parent of the item @p it on
+ * elm_genlist_item_append() and insertion related functions.
+ *
+ * @ingroup Genlist
+ */
+EAPI Elm_Object_Item *elm_genlist_item_parent_get(const Elm_Object_Item *it);
+
+/**
+ * Remove all sub-items (children) of the given item
+ *
+ * @param it The item
+ *
+ * This removes all items that are children (and their descendants) of the
+ * given item @p it.
+ *
+ * @see elm_genlist_clear()
+ * @see elm_object_item_del()
+ *
+ * @ingroup Genlist
+ */
+EAPI void elm_genlist_item_subitems_clear(Elm_Object_Item *it);
+
+/**
+ * Sets the expanded state of an item.
+ *
+ * @param it The item
+ * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
+ *
+ * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
+ * expanded or not.
+ *
+ * The theme will respond to this change visually, and a signal "expanded" or
+ * "contracted" will be sent from the genlist with a pointer to the item that
+ * has been expanded/contracted.
+ *
+ * Calling this function won't show or hide any child of this item (if it is
+ * a parent). You must manually delete and create them on the callbacks of
+ * the "expanded" or "contracted" signals.
+ *
+ * @see elm_genlist_item_expanded_get()
+ *
+ * @ingroup Genlist
+ */
+EAPI void elm_genlist_item_expanded_set(Elm_Object_Item *it, Eina_Bool expanded);
+
+/**
+ * Get the expanded state of an item
+ *
+ * @param it The item
+ * @return The expanded state
+ *
+ * This gets the expanded state of an item.
+ *
+ * @see elm_genlist_item_expanded_set()
+ *
+ * @ingroup Genlist
+ */
+EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Object_Item *it);
+
+/**
+ * Get the depth of expanded item
+ *
+ * @param it The genlist item object
+ * @return The depth of expanded item
+ *
+ * @ingroup Genlist
+ */
+EAPI int elm_genlist_item_expanded_depth_get(const Elm_Object_Item *it);
+
+/**
+ * Sets the display only state of an item.
+ *
+ * @param it The item
+ * @param display_only @c EINA_TRUE if the item is display only, @c
+ * EINA_FALSE otherwise.
+ *
+ * A display only item cannot be selected or unselected. It is for
+ * display only and not selecting or otherwise clicking, dragging
+ * etc. by the user, thus finger size rules will not be applied to
+ * this item.
+ *
+ * It's good to set group index items to display only state.
+ *
+ * @see elm_genlist_item_display_only_get()
+ *
+ * @ingroup Genlist
+ */
+//XXX: elm_genlist_item_no_select_mode_set()?
+EAPI void elm_genlist_item_display_only_set(Elm_Object_Item *it, Eina_Bool display_only);
+
+/**
+ * Get the display only state of an item
+ *
+ * @param it The item
+ * @return @c EINA_TRUE if the item is display only, @c
+ * EINA_FALSE otherwise.
+ *
+ * @see elm_genlist_item_display_only_set()
+ *
+ * @ingroup Genlist
+ */
+//XXX: elm_genlist_item_no_select_mode_get()?
+EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Object_Item *it);
+
+/**
+ * Unset all contents fetched by the item class
+ *
+ * @param it The item
+ * @param l The contents list to return
+ *
+ * This instructs genlist to release references to contents in the item,
+ * meaning that they will no longer be managed by genlist and are
+ * floating "orphans" that can be re-used elsewhere if the user wants
+ * to.
+ *
+ * @ingroup Genlist
+ */
+EAPI void elm_genlist_item_all_contents_unset(Elm_Object_Item *it, Eina_List **l);
+
+/**
+ * Promote an item to the top of the list
+ *
+ * @param it The item
+ *
+ * @ingroup Genlist
+ */
+EAPI void elm_genlist_item_promote(Elm_Object_Item *it);
+
+/**
+ * Demote an item to the end of the list
+ *
+ * @param it The item
+ *
+ * @ingroup Genlist
+ */
+EAPI void elm_genlist_item_demote(Elm_Object_Item *it);
+
+/**
+ * Update the part of an item
+ *
+ * @param it The item
+ * @param parts The name of item's part
+ * @param itf The type of item's part type
+ *
+ * This updates an item's part by calling item's fetching functions again
+ * to get the contents, texts and states. Use this when the original
+ * item data has changed and the changes are desired to be reflected.
+ * Second parts argument is used for globbing to match '*', '?', and '.'
+ * It can be used at updating multi fields.
+ *
+ * Use elm_genlist_realized_items_update() to update an item's all
+ * property.
+ *
+ * @see elm_genlist_item_update()
+ *
+ * @ingroup Genlist
+ */
+EAPI void elm_genlist_item_fields_update(Elm_Object_Item *it, const char *parts, Elm_Genlist_Item_Field_Type itf);
+
+/**
+ * Activate a genlist mode on an item
+ *
+ * @param it The genlist item
+ * @param mode_type Mode name
+ * @param mode_set Boolean to define set or unset mode.
+ *
+ * A genlist mode is a different way of selecting an item. Once a mode is
+ * activated on an item, any other selected item is immediately unselected.
+ * This feature provides an easy way of implementing a new kind of animation
+ * for selecting an item, without having to entirely rewrite the item style
+ * theme. However, the elm_genlist_selected_* API can't be used to get what
+ * item is activate for a mode.
+ *
+ * The current item style will still be used, but applying a genlist mode to
+ * an item will select it using a different kind of animation.
+ *
+ * The current active item for a mode can be found by
+ * elm_genlist_mode_item_get().
+ *
+ * The characteristics of genlist mode are:
+ * - Only one mode can be active at any time, and for only one item.
+ * - Genlist handles deactivating other items when one item is activated.
+ * - A mode is defined in the genlist theme (edc), and more modes can easily
+ * be added.
+ * - A mode style and the genlist item style are different things. They
+ * can be combined to provide a default style to the item, with some kind
+ * of animation for that item when the mode is activated.
+ *
+ * When a mode is activated on an item, a new view for that item is created.
+ * The theme of this mode defines the animation that will be used to transit
+ * the item from the old view to the new view. This second (new) view will be
+ * active for that item while the mode is active on the item, and will be
+ * destroyed after the mode is totally deactivated from that item.
+ *
+ * @see elm_genlist_mode_get()
+ * @see elm_genlist_mode_item_get()
+ *
+ * @ingroup Genlist
+ */
+//XXX: How bout elm_genlist_effect_mode_set
+EAPI void elm_genlist_item_mode_set(Elm_Object_Item *it, const char *mode_type, Eina_Bool mode_set);
+
+/**
+ * Get the last (or current) genlist mode used.
+ *
+ * @param obj The genlist object
+ *
+ * This function just returns the name of the last used genlist mode. It will
+ * be the current mode if it's still active.
+ *
+ * @see elm_genlist_item_mode_set()
+ * @see elm_genlist_mode_item_get()
+ *
+ * @ingroup Genlist
+ */
+//XXX: looks weird... set the mode type to item and get the mode type from object...
+EAPI const char *elm_genlist_mode_type_get(const Evas_Object *obj);
/**
* Get active genlist mode item
*
* @ingroup Genlist
*/
-EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj);
+EAPI const Elm_Object_Item *elm_genlist_mode_item_get(const Evas_Object *obj);
/**
* Set reorder mode
EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj);
/**
+ * Get the Item's Type
+ *
+ * @param it The genlist item
+ * @return The item type.
+ *
+ * This function returns the item's type. Normally the item's type.
+ * If it failed, return value is ELM_GENLIST_ITEM_MAX
+ *
+ * @ingroup Genlist
+ */
+EAPI Elm_Genlist_Item_Type elm_genlist_item_type_get(const Elm_Object_Item *it);
+
+/**
+ * Set Genlist edit mode
+ *
+ * This sets Genlist edit mode.
+ *
+ * @param obj The Genlist object
+ * @param The edit mode status
+ * (EINA_TRUE = edit mode, EINA_FALSE = normal mode
+ *
+ * @ingroup Genlist
+ */
+//XXX: elm_genlist_effect_mode_set();
+EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode);
+
+/**
+ * Get Genlist edit mode
+ *
+ * @param obj The genlist object
+ * @return The edit mode status
+ * (EINA_TRUE = edit mode, EINA_FALSE = normal mode
+ *
+ * @ingroup Genlist
+ */
+//XXX: elm_genlist_all_items_effect_mode_get();
+EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj);
+
+/**
+ * Set the flip state of a given genlist item.
+ *
+ * @param it The genlist item object
+ * @param flip The flip mode
+ * (EINA_TRUE = on, EINA_FALSE = off)
+ *
+ * This function sets the flip state of a given genlist item.
+ * Flip mode overrides current item object.
+ * It can be used for on-the-fly item replace.
+ * Flip mode can be used with/without edit mode.
+ *
+ * @see elm_genlist_item_flip_get()
+ *
+ * @ingroup Genlist
+ */
+
+EAPI void elm_genlist_item_flip_set(Elm_Object_Item *it, Eina_Bool flip);
+
+/**
+ * Get the flip state of a given genlist item.
+ *
+ * @param it The genlist item object
+ *
+ * This function returns the flip state of a given genlist item.
+ * If the parameter is invalid, it returns EINA_FALSE.
+ *
+ * @see elm_genlist_item_flip_set()
+ *
+ * @ingroup Genlist
+ */
+
+EAPI Eina_Bool elm_genlist_item_flip_get(const Elm_Object_Item *it);
+
+/**
* @}
*/
projects / framework / uifw / elementary.git / blobdiff