Tooltips

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. More...

Typedefs

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.
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.

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)
 Sets 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)
 Retrieve size restriction state of an object's tooltip.

Detailed Description

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:
datauser-data given to elm_object_tooltip_content_cb_set()
objowner widget.
tooltipThe 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:
datauser-data given to elm_object_tooltip_content_cb_set()
objowner widget.
tooltipThe tooltip object (affix content to this!)
itemcontext dependent item. As an example, if tooltip was set on elm_list item, then it is of this type.

Function Documentation

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.

Setup the tooltip to object. The object can have only one tooltip, so any previous tooltip data is removed. func(with 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.

Parameters:
objthe object being attached a tooltip.
functhe function used to create the tooltip contents.
datawhat to provide to func as callback data/context.
del_cbcalled 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, and event_info is NULL.

Referenced by elm_object_tooltip_text_set().

void elm_object_tooltip_hide ( Evas_Object *  obj)

Force hide tooltip of object.

Parameters:
objTarget object

Force hide the tooltip and (re)enable future mouse interations.

void elm_object_tooltip_show ( Evas_Object *  obj)

Force show tooltip of object.

Parameters:
objTarget object

Force show the tooltip and disable hide on mouse_out. If another content is set as tooltip, the visible tooltip will hididen 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.

Parameters:
objan 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 
)

Sets a different style for this object tooltip.

Note:
before you set a style you should define a tooltip with elm_object_tooltip_content_cb_set() or elm_object_tooltip_text_set().
Parameters:
objan object with tooltip already set.
stylethe 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.

Set the text to be shown in the tooltip object.

Parameters:
objThe tooltip object.
textThe text to be displayed.
objTarget object
textThe text to set in the content

Setup the text as tooltip to object. The object can have only one tooltip, so any previous tooltip data is removed. This method call internaly the elm_tooltip_content_cb_set().

References elm_object_tooltip_content_cb_set().

void elm_object_tooltip_unset ( Evas_Object *  obj)

Unset tooltip from object.

Parameters:
objTarget object

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)

Retrieve size restriction state of an object's tooltip.

Parameters:
objThe tooltip's anchor object
Returns:
If EINA_TRUE, size restrictions are disabled

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.

Referenced by elm_genlist_item_tooltip_window_mode_get().

Eina_Bool elm_object_tooltip_window_mode_set ( Evas_Object *  obj,
Eina_Bool  disable 
)

Disable size restrictions on an object's tooltip.

Parameters:
objThe tooltip's anchor object
disableIf EINA_TRUE, size restrictions are disabled
Returns:
EINA_FALSE on failure, EINA_TRUE on success

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.