summaryrefslogtreecommitdiff
path: root/doc/elementary/button.rst
blob: becdc6b84da375453ec8caea816aa1f6f42c9385 (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
.. currentmodule:: efl.elementary

Button
######

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


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

This is a push-button. Press it and run some function. It can contain
a simple label and icon object and it also has an autorepeat feature.


Available styles
================

- ``default`` a normal button.
- ``anchor`` Like default, but the button fades away when the mouse is not
  over it, leaving only the text or icon.
- ``hoversel_vertical`` Internally used by
  :py:class:`~efl.elementary.hoversel.Hoversel` to give a continuous look
  across its options.
- ``hoversel_vertical_entry`` Another internal for
  :py:class:`~efl.elementary.hoversel.Hoversel`.
- ``naviframe`` Internally used by
  :py:class:`~efl.elementary.naviframe.Naviframe` for its back button.
- ``colorselector`` Internally used by
  :py:class:`~efl.elementary.colorselector.Colorselector` for its left and
  right buttons.


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

- ``icon`` - An icon of the button


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

- ``default`` - Label of the button


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

- ``clicked``: the user clicked the button (press/release).
- ``repeated``: the user pressed the button without releasing it.
- ``pressed``: button was pressed.
- ``unpressed``: button was released after being pressed.
- ``focused`` : When the button has received focus. (since 1.8)
- ``unfocused`` : When the button has lost focus. (since 1.8)


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

.. inheritance-diagram:: Button
    :parts: 2


.. autoclass:: Button