summaryrefslogtreecommitdiff
path: root/doc/elementary/bubble.rst
blob: d66826ae375307d3477d036e95b05270ed0cbd17 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
.. currentmodule:: efl.elementary

Bubble
######

.. image:: /images/bubble-preview.png


Widget description
==================

The Bubble is a widget to show text similar to how speech is
represented in comics.

The bubble widget contains 5 important visual elements:

- The frame is a rectangle with rounded edjes and an "arrow".
- The ``icon`` is an image to which the frame's arrow points to.
- The ``label`` is a text which appears to the right of the icon if the
    corner is **top_left** or **bottom_left** and is right aligned to
    the frame otherwise.
- The ``info`` is a text which appears to the right of the label. Info's
    font is of a lighter color than label.
- The ``content`` is an evas object that is shown inside the frame.

The position of the arrow, icon, label and info depends on which corner is
selected. The four available corners are:

- ``top_left`` - Default
- ``top_right``
- ``bottom_left``
- ``bottom_right``


Layout content parts
====================

- ``default`` - A content of the bubble
- ``icon`` - An icon of the bubble


Layout text parts
=================

- ``default`` - Label of the bubble
- ``info`` - info of the bubble


Emitted signals
===============

- ``clicked`` - This is called when a user has clicked the bubble.
- ``focused`` - When the bubble has received focus. (since 1.8)
- ``unfocused`` - When the bubble has lost focus. (since 1.8)


Enumerations
============

.. _Elm_Bubble_Pos:

Bubble arrow positions
----------------------

.. data:: ELM_BUBBLE_POS_TOP_LEFT

    Top left position

.. data:: ELM_BUBBLE_POS_TOP_RIGHT

    Top right position

.. data:: ELM_BUBBLE_POS_BOTTOM_LEFT

    Bottom left position

.. data:: ELM_BUBBLE_POS_BOTTOM_RIGHT

    Bottom right position


Inheritance diagram
===================

.. inheritance-diagram:: Bubble
    :parts: 2

.. autoclass:: Bubble