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

Actionslider
############

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


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

An actionslider is a switcher for two or three labels with
customizable magnet properties.

The user drags and releases the indicator, to choose a label.

Labels can occupy the following positions.

- Left
- Right
- Center

Positions can be enabled or disabled.

Magnets can be set on the above positions.

When the indicator is released, it will move to its nearest "enabled and
magnetized" position.


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

- ``selected`` - when user selects an enabled position (the label is
  passed as event info)".
- ``pos_changed`` - when the indicator reaches any of the
  positions("left", "right" or "center").


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

- ``indicator`` - An indicator label of the actionslider
- ``left`` - A left label of the actionslider
- ``right`` - A right label of the actionslider
- ``center`` - A center label of the actionslider


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

.. _Elm_Actionslider_Pos:

Actionslider positions
----------------------

.. data:: ELM_ACTIONSLIDER_NONE

    No position

.. data:: ELM_ACTIONSLIDER_LEFT

    Left position

.. data:: ELM_ACTIONSLIDER_CENTER

    Center position

.. data:: ELM_ACTIONSLIDER_RIGHT

    Right position

.. data:: ELM_ACTIONSLIDER_ALL

    All positions


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

.. inheritance-diagram:: Actionslider
    :parts: 2


.. autoclass:: Actionslider