2 * @defgroup Bubble Bubble
4 * @image html img/widget/bubble/preview-00.png
5 * @image latex img/widget/bubble/preview-00.eps
6 * @image html img/widget/bubble/preview-01.png
7 * @image latex img/widget/bubble/preview-01.eps
8 * @image html img/widget/bubble/preview-02.png
9 * @image latex img/widget/bubble/preview-02.eps
11 * @brief The Bubble is a widget to show text similar to how speech is
12 * represented in comics.
14 * The bubble widget contains 5 important visual elements:
15 * @li The frame is a rectangle with rounded edjes and an "arrow".
16 * @li The @p icon is an image to which the frame's arrow points to.
17 * @li The @p label is a text which appears to the right of the icon if the
18 * corner is "top_left" or "bottom_left" and is right aligned to the frame
20 * @li The @p info is a text which appears to the right of the label. Info's
21 * font is of a ligther color than label.
22 * @li The @p content is an evas object that is shown inside the frame.
24 * The position of the arrow, icon, label and info depends on which corner is
25 * selected. The four available corners are:
26 * @li "top_left" - Default
31 * Signals that you can add callbacks for are:
32 * @li "clicked" - This is called when a user has clicked the bubble.
34 * Default contents parts of the bubble that you can use for are:
35 * @li "default" - A content of the bubble
36 * @li "icon" - An icon of the bubble
38 * Default text parts of the button widget that you can use for are:
39 * @li NULL - Label of the bubble
41 * For an example of using a buble see @ref bubble_01_example_page "this".
47 * Add a new bubble to the parent
49 * @param parent The parent object
50 * @return The new object or NULL if it cannot be created
52 * This function adds a text bubble to the given parent evas object.
54 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
57 * Set the corner of the bubble
59 * @param obj The bubble object.
60 * @param corner The given corner for the bubble.
62 * This function sets the corner of the bubble. The corner will be used to
63 * determine where the arrow in the frame points to and where label, icon and
66 * Possible values for corner are:
67 * @li "top_left" - Default
72 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
75 * Get the corner of the bubble
77 * @param obj The bubble object.
78 * @return The given corner for the bubble.
80 * This function gets the selected corner of the bubble.
82 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);