2019-03-05 14:00:37 -08:00
|
|
|
#ifndef _ELM_WIDGET_ITEM_EO_H_
|
|
|
|
#define _ELM_WIDGET_ITEM_EO_H_
|
|
|
|
|
|
|
|
#ifndef _ELM_WIDGET_ITEM_EO_CLASS_TYPE
|
|
|
|
#define _ELM_WIDGET_ITEM_EO_CLASS_TYPE
|
|
|
|
|
|
|
|
typedef Eo Elm_Widget_Item;
|
|
|
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifndef _ELM_WIDGET_ITEM_EO_TYPES
|
|
|
|
#define _ELM_WIDGET_ITEM_EO_TYPES
|
|
|
|
|
|
|
|
|
|
|
|
#endif
|
|
|
|
/** Elementary widget item class
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
#define ELM_WIDGET_ITEM_CLASS elm_widget_item_class_get()
|
|
|
|
|
efl: make all _class_get() functions const
please note, not the return type, but the function.
When appending __attribute__((const)) to a function, the compiler is
told that its enough to call this function once in a function.
This is quite often happening when we are efl_data_scope_get and
efl_super in a function that is different from a implemented function.
The compiler now starts to remove the calls that aggressivly that we
need to ensure that these calls are not removed, which means, the static
function calls, and the eo init are now checking the return value of
these functions, to ensure that they are called.
Please note that you now have to be carefull when your app calls
eo_shutdown, if it does so, you *must* call it at the end of a function,
or never call class_get after that anymore.
Overall this improves elm test runs 0.1s which is fair i guess, the main
thing that is faster is textrendering, where is also the point where
this is the most beneficial.
Please note, this replaces 42 occurences of double _class_get() ... THAT
is a sign!
Reviewed-by: Stefan Schmidt <stefan@datenfreihafen.org>
Reviewed-by: Daniel Kolesa <daniel@octaforge.org>
Differential Revision: https://phab.enlightenment.org/D12057
2020-07-16 03:39:23 -07:00
|
|
|
EWAPI const Efl_Class *elm_widget_item_class_get(void) EINA_CONST;
|
2019-03-05 14:00:37 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control size restriction state of an object's tooltip
|
|
|
|
*
|
|
|
|
* This function returns whether a tooltip is allowed to expand beyond its
|
|
|
|
* parent window's canvas. It will instead be limited only by the size of the
|
|
|
|
* display.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] disable If @c true, size restrictions are disabled
|
|
|
|
*
|
|
|
|
* @return @c false on failure, @c true on success
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI Eina_Bool elm_wdg_item_tooltip_window_mode_set(Eo *obj, Eina_Bool disable);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control size restriction state of an object's tooltip
|
|
|
|
*
|
|
|
|
* This function returns whether a tooltip is allowed to expand beyond its
|
|
|
|
* parent window's canvas. It will instead be limited only by the size of the
|
|
|
|
* display.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return If @c true, size restrictions are disabled
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI Eina_Bool elm_wdg_item_tooltip_window_mode_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control a different style for this item tooltip.
|
|
|
|
*
|
|
|
|
* @note before you set a style you should define a tooltip with
|
|
|
|
* @ref elm_wdg_item_tooltip_content_cb_set or
|
|
|
|
* @ref elm_wdg_item_tooltip_text_set
|
|
|
|
*
|
|
|
|
* See: elm_object_tooltip_style_set() for more details.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] style The theme style used/to use (default, transparent, ...)
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_tooltip_style_set(Eo *obj, const char *style);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control a different style for this item tooltip.
|
|
|
|
*
|
|
|
|
* @note before you set a style you should define a tooltip with
|
|
|
|
* @ref elm_wdg_item_tooltip_content_cb_set or
|
|
|
|
* @ref elm_wdg_item_tooltip_text_set
|
|
|
|
*
|
|
|
|
* See: elm_object_tooltip_style_set() for more details.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The theme style used/to use (default, transparent, ...)
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI const char *elm_wdg_item_tooltip_style_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control the type of mouse pointer/cursor decoration to be shown, when
|
|
|
|
* the mouse pointer is over the given item
|
|
|
|
*
|
|
|
|
* This function works analogously as elm_object_cursor_set(), but here the
|
|
|
|
* cursor's changing area is restricted to the item's area, and not the whole
|
|
|
|
* widget's. Note that that item cursors have precedence over widget cursors,
|
|
|
|
* so that a mouse over an item with custom cursor set will always show that
|
|
|
|
* cursor.
|
|
|
|
*
|
|
|
|
* If this function is called twice for an object, a previously set cursor will
|
|
|
|
* be unset on the second call.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] cursor The cursor type's name
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_cursor_set(Eo *obj, const char *cursor);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control the type of mouse pointer/cursor decoration to be shown, when
|
|
|
|
* the mouse pointer is over the given item
|
|
|
|
*
|
|
|
|
* This function works analogously as elm_object_cursor_set(), but here the
|
|
|
|
* cursor's changing area is restricted to the item's area, and not the whole
|
|
|
|
* widget's. Note that that item cursors have precedence over widget cursors,
|
|
|
|
* so that a mouse over an item with custom cursor set will always show that
|
|
|
|
* cursor.
|
|
|
|
*
|
|
|
|
* If this function is called twice for an object, a previously set cursor will
|
|
|
|
* be unset on the second call.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The cursor type's name
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI const char *elm_wdg_item_cursor_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control a different @c style for a given custom cursor set for an
|
|
|
|
* item.
|
|
|
|
*
|
|
|
|
* This function only makes sense when one is using custom mouse cursor
|
|
|
|
* decorations defined in a theme file, which can have, given a cursor
|
|
|
|
* name/type, alternate styles on it. It works analogously as
|
|
|
|
* elm_object_cursor_style_set(), but here applies only to item objects.
|
|
|
|
*
|
|
|
|
* @warning Before you set a cursor style you should have defined a custom
|
|
|
|
* cursor previously on the item, with @ref elm_wdg_item_cursor_set
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] style The theme style to use/in use (e.g. $"default",
|
|
|
|
* $"transparent", etc)
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_cursor_style_set(Eo *obj, const char *style);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control a different @c style for a given custom cursor set for an
|
|
|
|
* item.
|
|
|
|
*
|
|
|
|
* This function only makes sense when one is using custom mouse cursor
|
|
|
|
* decorations defined in a theme file, which can have, given a cursor
|
|
|
|
* name/type, alternate styles on it. It works analogously as
|
|
|
|
* elm_object_cursor_style_set(), but here applies only to item objects.
|
|
|
|
*
|
|
|
|
* @warning Before you set a cursor style you should have defined a custom
|
|
|
|
* cursor previously on the item, with @ref elm_wdg_item_cursor_set
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The theme style to use/in use (e.g. $"default", $"transparent", etc)
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI const char *elm_wdg_item_cursor_style_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control if the (custom)cursor for a given item should be searched in
|
|
|
|
* its theme, also, or should only rely on the rendering engine.
|
|
|
|
*
|
|
|
|
* @note This call is of use only if you've set a custom cursor for items, with
|
|
|
|
* @ref elm_wdg_item_cursor_set.
|
|
|
|
*
|
|
|
|
* @note By default, cursors will only be looked for between those provided by
|
|
|
|
* the rendering engine.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] engine_only Use @c true to have cursors looked for only on those
|
|
|
|
* provided by the rendering engine, @c false to have them searched on the
|
|
|
|
* widget's theme, as well.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_cursor_engine_only_set(Eo *obj, Eina_Bool engine_only);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control if the (custom)cursor for a given item should be searched in
|
|
|
|
* its theme, also, or should only rely on the rendering engine.
|
|
|
|
*
|
|
|
|
* @note This call is of use only if you've set a custom cursor for items, with
|
|
|
|
* @ref elm_wdg_item_cursor_set.
|
|
|
|
*
|
|
|
|
* @note By default, cursors will only be looked for between those provided by
|
|
|
|
* the rendering engine.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return Use @c true to have cursors looked for only on those provided by the
|
|
|
|
* rendering engine, @c false to have them searched on the widget's theme, as
|
|
|
|
* well.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI Eina_Bool elm_wdg_item_cursor_engine_only_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control a content of an object item
|
|
|
|
*
|
|
|
|
* This sets a new object to an item as a content object. If any object was
|
|
|
|
* already set as a content object in the same part, previous object will be
|
|
|
|
* deleted automatically.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] part The content part name (NULL for the default content)
|
|
|
|
* @param[in] content The content of the object item
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_part_content_set(Eo *obj, const char *part, Efl_Canvas_Object *content);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control a content of an object item
|
|
|
|
*
|
|
|
|
* This sets a new object to an item as a content object. If any object was
|
|
|
|
* already set as a content object in the same part, previous object will be
|
|
|
|
* deleted automatically.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] part The content part name (NULL for the default content)
|
|
|
|
*
|
|
|
|
* @return The content of the object item
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI Efl_Canvas_Object *elm_wdg_item_part_content_get(const Eo *obj, const char *part);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control a label of an object item
|
|
|
|
*
|
|
|
|
* @note Elementary object items may have many labels
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] part The text part name (NULL for the default label)
|
|
|
|
* @param[in] label Text of the label
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_part_text_set(Eo *obj, const char *part, const char *label);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control a label of an object item
|
|
|
|
*
|
|
|
|
* @note Elementary object items may have many labels
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] part The text part name (NULL for the default label)
|
|
|
|
*
|
|
|
|
* @return Text of the label
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI const char *elm_wdg_item_part_text_get(const Eo *obj, const char *part);
|
|
|
|
|
|
|
|
#ifdef ELM_WIDGET_ITEM_PROTECTED
|
|
|
|
/**
|
|
|
|
* @brief Save additional text part content
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] part Part name
|
|
|
|
* @param[in] label Label name
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_part_text_custom_set(Eo *obj, const char *part, const char *label);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef ELM_WIDGET_ITEM_PROTECTED
|
|
|
|
/**
|
|
|
|
* @brief Get additional text part content
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] part Part name
|
|
|
|
*
|
|
|
|
* @return Label name
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI const char *elm_wdg_item_part_text_custom_get(const Eo *obj, const char *part);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control the object item focused
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] focused The focused state
|
|
|
|
*
|
|
|
|
* @since 1.10
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_focus_set(Eo *obj, Eina_Bool focused);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control the object item focused
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The focused state
|
|
|
|
*
|
|
|
|
* @since 1.10
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI Eina_Bool elm_wdg_item_focus_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control the style of an object item
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] style The style of object item
|
|
|
|
*
|
|
|
|
* @since 1.9
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_style_set(Eo *obj, const char *style);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control the style of an object item
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The style of object item
|
|
|
|
*
|
|
|
|
* @since 1.9
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI const char *elm_wdg_item_style_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control the disabled state of a widget item.
|
|
|
|
*
|
|
|
|
* Elementary object item can be disabled, in which state they won't receive
|
|
|
|
* input and, in general, will be themed differently from their normal state,
|
|
|
|
* usually greyed out. Useful for contexts where you don't want your users to
|
|
|
|
* interact with some of the parts of you interface.
|
|
|
|
*
|
|
|
|
* This sets the state for the widget item, either disabling it or enabling it
|
|
|
|
* back.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] disable @c true, if the widget item is disabled, @c false if it's
|
|
|
|
* enabled (or on errors)
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_disabled_set(Eo *obj, Eina_Bool disable);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Control the disabled state of a widget item.
|
|
|
|
*
|
|
|
|
* Elementary object item can be disabled, in which state they won't receive
|
|
|
|
* input and, in general, will be themed differently from their normal state,
|
|
|
|
* usually greyed out. Useful for contexts where you don't want your users to
|
|
|
|
* interact with some of the parts of you interface.
|
|
|
|
*
|
|
|
|
* This sets the state for the widget item, either disabling it or enabling it
|
|
|
|
* back.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return @c true, if the widget item is disabled, @c false if it's enabled
|
|
|
|
* (or on errors)
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI Eina_Bool elm_wdg_item_disabled_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get highlight order
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return List of evas canvas objects
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI const Eina_List *elm_wdg_item_access_order_get(Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Set highlight order
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] objs Order of objects to pass highlight
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_access_order_set(Eo *obj, Eina_List *objs);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the widget object's handle which contains a given item
|
|
|
|
*
|
|
|
|
* @note This returns the widget object itself that an item belongs to. Note:
|
|
|
|
* Every elm_object_item supports this API
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The widget object
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI Efl_Canvas_Object *elm_wdg_item_widget_get(const Eo *obj);
|
|
|
|
|
|
|
|
#ifdef ELM_WIDGET_ITEM_PROTECTED
|
|
|
|
/** notify deletion of widget item
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_pre_notify_del(Eo *obj);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Set the text to be shown in a given object item's tooltips.
|
|
|
|
*
|
|
|
|
* Setup the text as tooltip to object. The item can have only one tooltip, so
|
|
|
|
* any previous tooltip data - set with this function or
|
|
|
|
* @ref elm_wdg_item_tooltip_content_cb_set - is removed.
|
|
|
|
*
|
|
|
|
* See: elm_object_tooltip_text_set() for more details.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] text The text to set in the content.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_tooltip_text_set(Eo *obj, const char *text);
|
|
|
|
|
|
|
|
#ifdef ELM_WIDGET_ITEM_PROTECTED
|
|
|
|
/**
|
|
|
|
* @brief Set widget item tooltip as a text string
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] text Tooltip text
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_tooltip_translatable_text_set(Eo *obj, const char *text);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Unset tooltip from item.
|
|
|
|
*
|
|
|
|
* Remove tooltip from item. The callback provided as del_cb to
|
|
|
|
* @ref elm_wdg_item_tooltip_content_cb_set will be called to notify it is not
|
|
|
|
* used anymore.
|
|
|
|
*
|
|
|
|
* See: elm_object_tooltip_unset() for more details. See:
|
|
|
|
* @ref elm_wdg_item_tooltip_content_cb_set
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_tooltip_unset(Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Unset any custom mouse pointer/cursor decoration set to be shown,
|
|
|
|
* when the mouse pointer is over the given item, thus making it show the
|
|
|
|
* default cursor again.
|
|
|
|
*
|
|
|
|
* Use this call to undo any custom settings on this item's cursor decoration,
|
|
|
|
* bringing it back to defaults (no custom style set).
|
|
|
|
*
|
|
|
|
* See: elm_object_cursor_unset() See: @ref elm_wdg_item_cursor_set
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_cursor_unset(Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Unset a content of an object item
|
|
|
|
*
|
|
|
|
* @note Elementary object items may have many contents
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] part The content part name to unset (NULL for the default
|
|
|
|
* content)
|
|
|
|
*
|
|
|
|
* @return Content object
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI Efl_Canvas_Object *elm_wdg_item_part_content_unset(Eo *obj, const char *part);
|
|
|
|
|
|
|
|
#ifdef ELM_WIDGET_ITEM_PROTECTED
|
|
|
|
/** Update additional text part content
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_part_text_custom_update(Eo *obj);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Add a callback for a signal emitted by object item edje.
|
|
|
|
*
|
|
|
|
* This function connects a callback function to a signal emitted by the edje
|
|
|
|
* object of the object item. Globs can occur in either the emission or source
|
|
|
|
* name.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] emission The signal's name.
|
|
|
|
* @param[in] source The signal's source.
|
|
|
|
* @param[in] func The callback function to be executed when the signal is
|
|
|
|
* emitted.
|
|
|
|
* @param[in] data A pointer to data to pass to the callback function.
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_signal_callback_add(Eo *obj, const char *emission, const char *source, Elm_Object_Item_Signal_Cb func, void *data);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Remove a signal-triggered callback from a object item edje object.
|
|
|
|
*
|
|
|
|
* This function removes the last callback, previously attached to a signal
|
|
|
|
* emitted by an underlying Edje object of @c it, whose parameters @c emission,
|
|
|
|
* @c source and @c func match exactly with those passed to a previous call to
|
|
|
|
* @ref elm_wdg_item_signal_callback_add. The data pointer that was passed to
|
|
|
|
* this call will be returned.
|
|
|
|
*
|
|
|
|
* See: @ref elm_wdg_item_signal_callback_add
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] emission The signal's name.
|
|
|
|
* @param[in] source The signal's source.
|
|
|
|
* @param[in] func The callback function to be executed when the signal is
|
|
|
|
* emitted.
|
|
|
|
*
|
|
|
|
* @return The data pointer of the signal callback or @c NULL, on errors.
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void *elm_wdg_item_signal_callback_del(Eo *obj, const char *emission, const char *source, Elm_Object_Item_Signal_Cb func);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Send a signal to the edje object of the widget item.
|
|
|
|
*
|
|
|
|
* This function sends a signal to the edje object of the obj item. An edje
|
|
|
|
* program can respond to a signal by specifying matching 'signal' and 'source'
|
|
|
|
* fields. Don't use this unless you want to also handle resetting of part
|
|
|
|
* states to default on every unrealize in case of genlist/gengrid.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] emission The signal's name.
|
|
|
|
* @param[in] source The signal's source.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_signal_emit(Eo *obj, const char *emission, const char *source);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Set the text to read out when in accessibility mode
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] txt The text that describes the widget to people with poor or no
|
|
|
|
* vision
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_access_info_set(Eo *obj, const char *txt);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get an accessible object of the object item.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return Accessible object of the object item or NULL for any error
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI Efl_Canvas_Object *elm_wdg_item_access_object_get(const Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Set the text for an object item's part, marking it as translatable.
|
|
|
|
*
|
|
|
|
* The string to set as @c text must be the original one. Do not pass the
|
|
|
|
* return of @c gettext() here. Elementary will translate the string internally
|
|
|
|
* and set it on the object item using @ref elm_wdg_item_part_text_set, also
|
|
|
|
* storing the original string so that it can be automatically translated when
|
|
|
|
* the language is changed with elm_language_set(). The @c domain will be
|
|
|
|
* stored along to find the translation in the correct catalog. It can be NULL,
|
|
|
|
* in which case it will use whatever domain was set by the application with
|
|
|
|
* @c textdomain(). This is useful in case you are building a library on top of
|
|
|
|
* Elementary that will have its own translatable strings, that should not be
|
|
|
|
* mixed with those of programs using the library.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] part The name of the part to set
|
|
|
|
* @param[in] domain The translation domain to use
|
|
|
|
* @param[in] label The original, non-translated text to set
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_domain_translatable_part_text_set(Eo *obj, const char *part, const char *domain, const char *label);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the original string set as translatable for an object item.
|
|
|
|
*
|
|
|
|
* When setting translated strings, the function
|
|
|
|
* @ref elm_wdg_item_part_text_get will return the translation returned by
|
|
|
|
* @c gettext(). To get the original string use this function.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] part The name of the part that was set
|
|
|
|
*
|
|
|
|
* @return The original, untranslated string
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI const char *elm_wdg_item_translatable_part_text_get(const Eo *obj, const char *part);
|
|
|
|
|
|
|
|
#ifdef ELM_WIDGET_ITEM_PROTECTED
|
|
|
|
/** Query translate
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_translate(Eo *obj);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Mark the part text to be translatable or not.
|
|
|
|
*
|
|
|
|
* Once you mark the part text to be translatable, the text will be translated
|
|
|
|
* internally regardless of @ref elm_wdg_item_part_text_set and
|
|
|
|
* @ref elm_wdg_item_domain_translatable_part_text_set. In other case, if you
|
|
|
|
* set the Elementary policy that all text will be translatable in default, you
|
|
|
|
* can set the part text to not be translated by calling this API.
|
|
|
|
*
|
|
|
|
* See: @ref elm_wdg_item_domain_translatable_part_text_set See:
|
|
|
|
* @ref elm_wdg_item_part_text_set See: elm_policy()
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] part The part name of the translatable text
|
|
|
|
* @param[in] domain The translation domain to use
|
|
|
|
* @param[in] translatable @c true, the part text will be translated
|
|
|
|
* internally. @c false, otherwise.
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_domain_part_text_translatable_set(Eo *obj, const char *part, const char *domain, Eina_Bool translatable);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief This returns track object of the item.
|
|
|
|
*
|
|
|
|
* @note This gets a rectangle object that represents the object item's
|
|
|
|
* internal object. If you want to check the geometry, visibility of the item,
|
|
|
|
* you can call the evas apis such as evas_object_geometry_get(),
|
|
|
|
* evas_object_visible_get() to the track object. Note that all of the widget
|
|
|
|
* items may/may not have the internal object so this api may return @c NULL if
|
|
|
|
* the widget item doesn't have it. Additionally, the widget item is
|
|
|
|
* managed/controlled by the widget, the widget item could be changed(moved,
|
2020-06-22 11:24:38 -07:00
|
|
|
* resized even deleted) anytime by it's own widget's decision. So please don't
|
2019-03-05 14:00:37 -08:00
|
|
|
* change the track object as well as don't keep the track object in your side
|
|
|
|
* as possible but get the track object at the moment you need to refer.
|
|
|
|
* Otherwise, you need to add some callbacks to the track object to track it's
|
|
|
|
* attributes changes.
|
|
|
|
*
|
|
|
|
* @warning After use the track object, please call the
|
|
|
|
* @ref elm_wdg_item_untrack() paired to elm_object_item_track definitely to
|
|
|
|
* free the track object properly. Don't delete the track object.
|
|
|
|
*
|
|
|
|
* See: @ref elm_wdg_item_untrack See: @ref elm_wdg_item_track_get
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return The track object
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI Efl_Canvas_Object *elm_wdg_item_track(Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief This retrieve the track object of the item.
|
|
|
|
*
|
|
|
|
* @note This retrieves the track object that was returned from
|
|
|
|
* @ref elm_wdg_item_track.
|
|
|
|
*
|
|
|
|
* See: @ref elm_wdg_item_track See: @ref elm_wdg_item_track_get
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_untrack(Eo *obj);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the track object reference count.
|
|
|
|
*
|
|
|
|
* @note This gets the reference count for the track object. Whenever you call
|
|
|
|
* the @ref elm_wdg_item_track, the reference count will be increased by one.
|
|
|
|
* Likely the reference count will be decreased again when you call the
|
|
|
|
* @ref elm_wdg_item_untrack. Unless the reference count reaches to zero, the
|
|
|
|
* track object won't be deleted. So please be sure to call
|
|
|
|
* @ref elm_wdg_item_untrack() paired to the elm_object_item_track call count.
|
|
|
|
*
|
|
|
|
* See: @ref elm_wdg_item_track See: @ref elm_wdg_item_track_get
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return Track object reference count
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI int elm_wdg_item_track_get(const Eo *obj);
|
|
|
|
|
|
|
|
#ifdef ELM_WIDGET_ITEM_PROTECTED
|
|
|
|
/** Query track_cancel
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_track_cancel(Eo *obj);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Set the function to be called when an item from the widget is freed.
|
|
|
|
*
|
|
|
|
* @note Every elm_object_item supports this API
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] del_cb The function called
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_del_cb_set(Eo *obj, Evas_Smart_Cb del_cb);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Set the content to be shown in the tooltip item.
|
|
|
|
*
|
|
|
|
* Setup the tooltip to item. The item can have only one tooltip, so any
|
|
|
|
* previous tooltip data is removed. @c func(with @c data) will be called every
|
|
|
|
* time that need show the tooltip and it should return a valid Evas_Object.
|
|
|
|
* This object is then managed fully by tooltip system and is deleted when the
|
|
|
|
* tooltip is gone.
|
|
|
|
*
|
|
|
|
* See: elm_object_tooltip_content_cb_set() for more details.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] func The function used to create the tooltip contents.
|
|
|
|
* @param[in] data What to provide to @c func as callback data/context.
|
|
|
|
* @param[in] del_cb Called when data is not needed anymore, either when
|
|
|
|
* another callback replaces @c func, the tooltip is unset with
|
|
|
|
* @ref elm_wdg_item_tooltip_unset or the owner @c item dies. This callback
|
|
|
|
* receives as the first parameter the given @c data, and @c event_info is the
|
|
|
|
* item.
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_tooltip_content_cb_set(Eo *obj, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Register object item as an accessible object.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
*
|
|
|
|
* @return Accessible object of the object item or NULL for any error
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI Efl_Canvas_Object *elm_wdg_item_access_register(Eo *obj);
|
|
|
|
|
|
|
|
/** Unregister accessible object of the object item.
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_access_unregister(Eo *obj);
|
|
|
|
|
|
|
|
/** Unset highlight order
|
|
|
|
*
|
|
|
|
* @since 1.8
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_access_order_unset(Eo *obj);
|
|
|
|
|
|
|
|
#ifdef ELM_WIDGET_ITEM_PROTECTED
|
|
|
|
/** Disable widget item
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_disable(Eo *obj);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef ELM_WIDGET_ITEM_PROTECTED
|
|
|
|
/** Delete pre widget item
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
|
|
|
EOAPI void elm_wdg_item_del_pre(Eo *obj);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the next object with specific focus direction.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] dir Focus direction
|
|
|
|
*
|
|
|
|
* @return Focus next object
|
|
|
|
*
|
|
|
|
* @since 1.16
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
2019-03-07 07:48:33 -08:00
|
|
|
EOAPI Efl_Canvas_Object *elm_wdg_item_focus_next_object_get(const Eo *obj, Elm_Focus_Direction dir);
|
2019-03-05 14:00:37 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Set the next object with specific focus direction.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] next Focus next object
|
|
|
|
* @param[in] dir Focus direction
|
|
|
|
*
|
|
|
|
* @since 1.16
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
2019-03-07 07:48:33 -08:00
|
|
|
EOAPI void elm_wdg_item_focus_next_object_set(Eo *obj, Efl_Canvas_Object *next, Elm_Focus_Direction dir);
|
2019-03-05 14:00:37 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the next object item with specific focus direction.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] dir Focus direction
|
|
|
|
*
|
|
|
|
* @return Focus next object item
|
|
|
|
*
|
|
|
|
* @since 1.16
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
2019-03-07 07:48:33 -08:00
|
|
|
EOAPI Elm_Widget_Item *elm_wdg_item_focus_next_item_get(const Eo *obj, Elm_Focus_Direction dir);
|
2019-03-05 14:00:37 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Set the next object item with specific focus direction.
|
|
|
|
*
|
|
|
|
* @param[in] obj The object.
|
|
|
|
* @param[in] next_item Focus next object item
|
|
|
|
* @param[in] dir Focus direction
|
|
|
|
*
|
|
|
|
* @since 1.16
|
|
|
|
*
|
|
|
|
* @ingroup Elm_Widget_Item
|
|
|
|
*/
|
2019-03-07 07:48:33 -08:00
|
|
|
EOAPI void elm_wdg_item_focus_next_item_set(Eo *obj, Elm_Widget_Item *next_item, Elm_Focus_Direction dir);
|
2019-03-05 14:00:37 -08:00
|
|
|
|
|
|
|
#endif
|