Tizen Native API  3.0
Functions | Typedefs
Tooltips
Elementary Widgets

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.

Functions

void elm_object_tooltip_move_freeze_push (Evas_Object *obj)
void elm_object_tooltip_move_freeze_pop (Evas_Object *obj)
int elm_object_tooltip_move_freeze_get (const Evas_Object *obj)
void elm_object_tooltip_orient_set (Evas_Object *obj, Elm_Tooltip_Orient orient)
 Sets the orientation of the tooltip around the owner region.
Elm_Tooltip_Orient elm_object_tooltip_orient_get (const Evas_Object *obj)
 Returns the orientation of 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)

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.

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() to set the position around which the tooltip should appear(relative to its parent)

Enumerator:
ELM_TOOLTIP_ORIENT_NONE 

Default value, Tooltip moves with mouse pointer

ELM_TOOLTIP_ORIENT_TOP_LEFT 

Tooltip should appear at the top left of parent

ELM_TOOLTIP_ORIENT_TOP 

Tooltip should appear at the top of parent

ELM_TOOLTIP_ORIENT_TOP_RIGHT 

Tooltip should appear at the top right of parent

ELM_TOOLTIP_ORIENT_LEFT 

Tooltip should appear at the left of parent

ELM_TOOLTIP_ORIENT_CENTER 

Tooltip should appear at the center of parent

ELM_TOOLTIP_ORIENT_RIGHT 

Tooltip should appear at the right of parent

ELM_TOOLTIP_ORIENT_BOTTOM_LEFT 

Tooltip should appear at the bottom left of parent

ELM_TOOLTIP_ORIENT_BOTTOM 

Tooltip should appear at the bottom of parent

ELM_TOOLTIP_ORIENT_BOTTOM_RIGHT 

Tooltip should appear at the bottom right of parent

ELM_TOOLTIP_ORIENT_LAST 

Sentinel value, don't use

Function Documentation

int elm_object_tooltip_move_freeze_get ( const Evas_Object *  obj)

Get the movement freeze by 1

This gets the movement freeze count by one.

Parameters:
objThe tooltip's anchor object
Returns:
The movement freeze count
See also:
elm_object_tooltip_move_freeze_push()
Since (EFL) :
1.9
Since :
3.0
void elm_object_tooltip_move_freeze_pop ( Evas_Object *  obj)

This decrements the tooltip freeze count by one.

Parameters:
objThe tooltip's anchor object
See also:
elm_object_tooltip_move_freeze_push()
Since (EFL) :
1.9
Since :
3.0
void elm_object_tooltip_move_freeze_push ( Evas_Object *  obj)

This increments the tooltip movement freeze count by one. If the count is more than 0, the tooltip position will be fixed.

Parameters:
objThe tooltip's anchor object
See also:
elm_object_tooltip_move_freeze_pop()
elm_object_tooltip_move_freeze_get()
Since (EFL) :
1.9
Since :
3.0
Elm_Tooltip_Orient elm_object_tooltip_orient_get ( const Evas_Object *  obj)

Returns the orientation of Tooltip.

Parameters:
objThe owner object
Returns:
The orientation of the tooltip
See also:
elm_object_tooltip_orient_set() Elm_Tooltip_Orient for possible values.
Since :
3.0
void elm_object_tooltip_orient_set ( Evas_Object *  obj,
Elm_Tooltip_Orient  orient 
)

Sets the orientation of the tooltip around the owner region.

Sets the position in which tooltip will appear around its owner. By default, ELM_TOOLTIP_ORIENT_NONE is set.

Parameters:
objThe owner widget.
orientThe orientation of the tooltip.
See also:
Elm_Tooltip_Orient for possible values.
Since (EFL) :
1.9
Since :
3.0