[Migration] Conflict Fix: ctxpopup, diskselector, flipselector, spinner, tooltip...
[framework/uifw/elementary.git] / src / lib / elm_tooltip.h
1 /**
2  * @defgroup Tooltips Tooltips
3  *
4  * The Tooltip is an (internal, for now) smart object used to show a
5  * content in a frame on mouse hover of objects(or widgets), with
6  * tips/information about them.
7  *
8  * @{
9  */
10
11 /**
12  * Called back when a widget's tooltip is activated and needs content.
13  * @param data user-data given to elm_object_tooltip_content_cb_set()
14  * @param obj owner widget.
15  * @param tooltip The tooltip object (affix content to this!)
16  */
17 typedef Evas_Object *(*Elm_Tooltip_Content_Cb)(void *data, Evas_Object *obj, Evas_Object *tooltip);
18
19 /**
20  * Called back when a widget's item tooltip is activated and needs content.
21  * @param data user-data given to elm_object_tooltip_content_cb_set()
22  * @param obj owner widget.
23  * @param tooltip The tooltip object (affix content to this!)
24  * @param item context dependent item. As an example, if tooltip was
25  *        set on elm_list item, then it is of this type.
26  */
27 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb)(void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
28
29 EINA_DEPRECATED EAPI double      elm_tooltip_delay_get(void);
30 EINA_DEPRECATED EAPI Eina_Bool   elm_tooltip_delay_set(double delay);
31
32 EAPI void        elm_object_tooltip_show(Evas_Object *obj);
33 EAPI void        elm_object_tooltip_hide(Evas_Object *obj);
34
35 /** 
36  * Set the text to be displayed inside the tooltip.
37  *
38  * @param obj The tooltip object.
39  * @param text The text to be displayed.
40  */
41 EAPI void        elm_object_tooltip_text_set(Evas_Object *obj, const char *text);
42 EAPI void        elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text);
43 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
44 EAPI void        elm_object_tooltip_content_cb_set(Evas_Object *obj, Elm_Tooltip_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
45 EAPI void        elm_object_tooltip_unset(Evas_Object *obj);
46
47 /**
48  * Sets a different style for this object tooltip.
49  *
50  * @note before you set a style you should define a tooltip with
51  *       elm_object_tooltip_content_cb_set() or
52  *       elm_object_tooltip_text_set().
53  *
54  * @param obj an object with tooltip already set.
55  * @param style the theme style to use (default, transparent, ...)
56  */
57 EAPI void        elm_object_tooltip_style_set(Evas_Object *obj, const char *style);
58
59 /**
60  * Get the style for this object tooltip.
61  *
62  * @param obj an object with tooltip already set.
63  * @return style the theme style in use, defaults to "default". If the
64  *         object does not have a tooltip set, then NULL is returned.
65  */
66 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj);
67
68 /**
69  * @brief Disable size restrictions on an object's tooltip
70  * @param obj The tooltip's anchor object
71  * @param disable If EINA_TRUE, size restrictions are disabled
72  * @return EINA_FALSE on failure, EINA_TRUE on success
73  *
74  * This function allows a tooltip to expand beyond its parent window's canvas.
75  * It will instead be limited only by the size of the display.
76  */
77 EAPI Eina_Bool   elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable);
78
79 /**
80  * @brief Retrieve size restriction state of an object's tooltip
81  * @param obj The tooltip's anchor object
82  * @return If EINA_TRUE, size restrictions are disabled
83  *
84  * This function returns whether a tooltip is allowed to expand beyond
85  * its parent window's canvas.
86  * It will instead be limited only by the size of the display.
87  */
88 EAPI Eina_Bool   elm_object_tooltip_window_mode_get(const Evas_Object *obj);
89
90 /**
91  * @}
92  */