Tizen Native API
|
Functions | |
void | elm_object_tooltip_show (Evas_Object *obj) |
Force show tooltip of object. | |
void | elm_object_tooltip_hide (Evas_Object *obj) |
Force hide tooltip of object. | |
void | elm_object_tooltip_text_set (Evas_Object *obj, const char *text) |
Set the text to be displayed inside the tooltip. | |
void | elm_object_tooltip_content_cb_set (Evas_Object *obj, Elm_Tooltip_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) |
Set the content to be shown in the tooltip object. | |
void | elm_object_tooltip_unset (Evas_Object *obj) |
Unset tooltip from object. | |
void | elm_object_tooltip_style_set (Evas_Object *obj, const char *style) |
Set a different style for this object tooltip. | |
const char * | elm_object_tooltip_style_get (const Evas_Object *obj) |
Get the style for this object tooltip. | |
Eina_Bool | elm_object_tooltip_window_mode_set (Evas_Object *obj, Eina_Bool disable) |
Disable size restrictions on an object's tooltip. | |
Eina_Bool | elm_object_tooltip_window_mode_get (const Evas_Object *obj) |
Get size restriction state of an object's tooltip. | |
Typedefs | |
typedef Evas_Object *(* | Elm_Tooltip_Content_Cb )(void *data, Evas_Object *obj, Evas_Object *tooltip) |
typedef Evas_Object *(* | Elm_Tooltip_Item_Content_Cb )(void *data, Evas_Object *obj, Evas_Object *tooltip, void *item) |
The Tooltip is an (internal, for now) smart object used to show a content in a frame on mouse hover of objects(or widgets), with tips/information about them.
Typedef Documentation
typedef Evas_Object*(* Elm_Tooltip_Content_Cb)(void *data, Evas_Object *obj, Evas_Object *tooltip) |
Called back when a widget's tooltip is activated and needs content.
- Parameters:
-
data user-data given to elm_object_tooltip_content_cb_set() obj owner widget. tooltip The tooltip object (affix content to this!)
typedef Evas_Object*(* Elm_Tooltip_Item_Content_Cb)(void *data, Evas_Object *obj, Evas_Object *tooltip, void *item) |
Called back when a widget's item tooltip is activated and needs content.
- Parameters:
-
data user-data given to elm_object_tooltip_content_cb_set() obj owner widget. tooltip The tooltip object (affix content to this!) item context dependent item. As an example, if tooltip was set on elm_list item, then it is of this type.
Enumeration Type Documentation
enum Elm_Tooltip_Orient |
Possible orient values for tooltip.
These values should be used in conjunction to Elm Object Tooltip Orient Set function to set the position around which the tooltip should appear(relative to its parent)
- Enumerator:
Function Documentation
double elm_config_tooltip_delay_get | ( | void | ) |
Get the duration after which tooltip will be shown.
- Since :
- 2.3
- Returns:
- Duration after which tooltip will be shown.
void elm_config_tooltip_delay_set | ( | double | delay | ) |
Set the duration after which tooltip will be shown.
- Since :
- 2.3
- Parameters:
-
[in] delay Duration after which tooltip will be shown.
void elm_object_tooltip_content_cb_set | ( | Evas_Object * | obj, |
Elm_Tooltip_Content_Cb | func, | ||
const void * | data, | ||
Evas_Smart_Cb | del_cb | ||
) |
Set the content to be shown in the tooltip object.
- Since :
- 2.3
- Parameters:
-
[in] obj The object being attached a tooltip. [in] func The function used to create the tooltip contents. [in] data What to provide to func as callback data/context. [in] del_cb Function called when data is not needed anymore, either when another callback replaces func
, the tooltip is unset with elm_object_tooltip_unset() or the owner object obj dies. This callback receives as the first parameter the given data, andevent_info
is NULL.
- Remarks:
- Setup the tooltip to object. The object can have only one tooltip, so any previous tooltip data is removed.
func
(withdata
) 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.
void elm_object_tooltip_hide | ( | Evas_Object * | obj | ) |
Force hide tooltip of object.
- Since :
- 2.3
- Parameters:
-
[in] obj Target object
- Remarks:
- Force hide the tooltip and (re)enable future mouse interations.
void elm_object_tooltip_show | ( | Evas_Object * | obj | ) |
Force show tooltip of object.
- Since :
- 2.3
- Parameters:
-
[in] obj Target object
- Remarks:
- Force show the tooltip and disable hide on mouse_out. If another content is set as tooltip, the visible tooltip will be hidden and showed again with new content. This can force show more than one tooltip at a time.
const char* elm_object_tooltip_style_get | ( | const Evas_Object * | obj | ) |
Get the style for this object tooltip.
- Since :
- 2.3
- Parameters:
-
[in] obj an object with tooltip already set.
- Returns:
- style the theme style in use, defaults to "default". If the object does not have a tooltip set, then NULL is returned.
void elm_object_tooltip_style_set | ( | Evas_Object * | obj, |
const char * | style | ||
) |
Set a different style for this object tooltip.
- Since :
- 2.3
- Remarks:
- before you set a style you should define a tooltip with elm_object_tooltip_content_cb_set() or elm_object_tooltip_text_set().
- Parameters:
-
[in] obj an object with tooltip already set. [in] style the theme style to use (default, transparent, ...)
void elm_object_tooltip_text_set | ( | Evas_Object * | obj, |
const char * | text | ||
) |
Set the text to be displayed inside the tooltip.
- Since :
- 2.3
- Parameters:
-
[in] obj The tooltip object. [in] text The text to be displayed.
void elm_object_tooltip_unset | ( | Evas_Object * | obj | ) |
Unset tooltip from object.
- Since :
- 2.3
- Parameters:
-
[in] obj Target object
- Remarks:
- Remove tooltip from object. The callback provided as del_cb to elm_object_tooltip_content_cb_set() will be called to notify it is not used anymore.
- See also:
- elm_object_tooltip_content_cb_set()
Eina_Bool elm_object_tooltip_window_mode_get | ( | const Evas_Object * | obj | ) |
Get size restriction state of an object's tooltip.
- Since :
- 2.3
- Parameters:
-
[in] obj The tooltip's anchor object
- Returns:
- If
EINA_TRUE
, size restrictions are disabled
- Remarks:
- 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.
Eina_Bool elm_object_tooltip_window_mode_set | ( | Evas_Object * | obj, |
Eina_Bool | disable | ||
) |
Disable size restrictions on an object's tooltip.
- Since :
- 2.3
- Parameters:
-
[in] obj The tooltip's anchor object [in] disable If EINA_TRUE
, size restrictions are disabled
- Returns:
EINA_FALSE
on failure,EINA_TRUE
on success
- Remarks:
- 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.