summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKai Huuhko <kai.huuhko@gmail.com>2015-04-18 04:45:11 +0300
committerKai Huuhko <kai.huuhko@gmail.com>2015-04-18 04:45:11 +0300
commitd3569bf1f188aed6c0610035370d8f0f09663bf3 (patch)
treec44c7884860175929385c4a5bf5ea5b7630d9080
parentd9fa1e89e2429abe5db65070ebc5fc96420b16fc (diff)
Elm: Unify modules into a monolithic module
-rw-r--r--doc/elementary/actionslider.rst83
-rw-r--r--doc/elementary/background.rst56
-rw-r--r--doc/elementary/box.rst116
-rw-r--r--doc/elementary/bubble.rst84
-rw-r--r--doc/elementary/button.rst62
-rw-r--r--doc/elementary/calendar.rst160
-rw-r--r--doc/elementary/check.rst47
-rw-r--r--doc/elementary/clock.rst92
-rw-r--r--doc/elementary/colorselector.rst62
-rw-r--r--doc/elementary/configuration.rst161
-rw-r--r--doc/elementary/conformant.rst41
-rw-r--r--doc/elementary/ctxpopup.rst82
-rw-r--r--doc/elementary/datetime.rst218
-rw-r--r--doc/elementary/dayselector.rst97
-rw-r--r--doc/elementary/diskselector.rst68
-rw-r--r--doc/elementary/elementary.rst34
-rw-r--r--doc/elementary/entry.rst590
-rw-r--r--doc/elementary/fileselector.rst135
-rw-r--r--doc/elementary/fileselector_button.rst73
-rw-r--r--doc/elementary/fileselector_entry.rst88
-rw-r--r--doc/elementary/flip.rst162
-rw-r--r--doc/elementary/flipselector.rst48
-rw-r--r--doc/elementary/frame.rst52
-rw-r--r--doc/elementary/general.rst2
-rw-r--r--doc/elementary/gengrid.rst324
-rw-r--r--doc/elementary/genlist.rst512
-rw-r--r--doc/elementary/gesture_layer.rst150
-rw-r--r--doc/elementary/grid.rst29
-rw-r--r--doc/elementary/hover.rst109
-rw-r--r--doc/elementary/hoversel.rst73
-rw-r--r--doc/elementary/icon.rst181
-rw-r--r--doc/elementary/image.rst93
-rw-r--r--doc/elementary/index.rst59
-rw-r--r--doc/elementary/innerwindow.rst40
-rw-r--r--doc/elementary/label.rst98
-rw-r--r--doc/elementary/layout.rst163
-rw-r--r--doc/elementary/layout_class.rst2
-rw-r--r--doc/elementary/list.rst160
-rw-r--r--doc/elementary/map.rst200
-rw-r--r--doc/elementary/mapbuf.rst31
-rw-r--r--doc/elementary/menu.rst44
-rw-r--r--doc/elementary/multibuttonentry.rst58
-rw-r--r--doc/elementary/naviframe.rst92
-rw-r--r--doc/elementary/need.rst18
-rw-r--r--doc/elementary/notify.rst52
-rw-r--r--doc/elementary/object.rst254
-rw-r--r--doc/elementary/object_item.rst11
-rw-r--r--doc/elementary/panel.rst60
-rw-r--r--doc/elementary/panes.rst44
-rw-r--r--doc/elementary/photo.rst37
-rw-r--r--doc/elementary/photocam.rst93
-rw-r--r--doc/elementary/plug.rst36
-rw-r--r--doc/elementary/popup.rst170
-rw-r--r--doc/elementary/progressbar.rst66
-rw-r--r--doc/elementary/radio.rst61
-rw-r--r--doc/elementary/scroller.rst134
-rw-r--r--doc/elementary/segment_control.rst48
-rw-r--r--doc/elementary/separator.rst22
-rw-r--r--doc/elementary/slider.rst68
-rw-r--r--doc/elementary/slideshow.rst72
-rw-r--r--doc/elementary/spinner.rst51
-rw-r--r--doc/elementary/systray.rst52
-rw-r--r--doc/elementary/table.rst34
-rw-r--r--doc/elementary/theme.rst79
-rw-r--r--doc/elementary/thumb.rst170
-rw-r--r--doc/elementary/toolbar.rst167
-rw-r--r--doc/elementary/transit.rst164
-rw-r--r--doc/elementary/video.rst28
-rw-r--r--doc/elementary/web.rst139
-rw-r--r--doc/elementary/window.rst354
-rw-r--r--efl/elementary/__init__.py4
-rw-r--r--efl/elementary/__init__.pyx (renamed from efl/elementary/general.pyx)114
-rw-r--r--efl/elementary/actionslider.pxi (renamed from efl/elementary/actionslider.pyx)98
-rw-r--r--efl/elementary/actionslider.py7
-rw-r--r--efl/elementary/actionslider_cdef.pxi (renamed from efl/elementary/actionslider.pxd)3
-rw-r--r--efl/elementary/background.pxi (renamed from efl/elementary/background.pyx)64
-rw-r--r--efl/elementary/background.py6
-rw-r--r--efl/elementary/background_cdef.pxi (renamed from efl/elementary/background.pxd)3
-rw-r--r--efl/elementary/box.pxi (renamed from efl/elementary/box.pyx)126
-rw-r--r--efl/elementary/box.py11
-rw-r--r--efl/elementary/box_cdef.pxi (renamed from efl/elementary/box.pxd)2
-rw-r--r--efl/elementary/bubble.pxi (renamed from efl/elementary/bubble.pyx)94
-rw-r--r--efl/elementary/bubble.py6
-rw-r--r--efl/elementary/bubble_cdef.pxi (renamed from efl/elementary/bubble.pxd)3
-rw-r--r--efl/elementary/button.pxi (renamed from efl/elementary/button.pyx)69
-rw-r--r--efl/elementary/button.py1
-rw-r--r--efl/elementary/button_cdef.pxi (renamed from efl/elementary/button.pxd)7
-rw-r--r--efl/elementary/calendar.pxi (renamed from efl/elementary/calendar_elm.pyx)173
-rw-r--r--efl/elementary/calendar_cdef.pxi (renamed from efl/elementary/calendar_elm.pxd)9
-rw-r--r--efl/elementary/calendar_elm.py27
-rw-r--r--efl/elementary/check.pxi (renamed from efl/elementary/check.pyx)54
-rw-r--r--efl/elementary/check.py1
-rw-r--r--efl/elementary/check_cdef.pxi (renamed from efl/elementary/check.pxd)2
-rw-r--r--efl/elementary/clock.pxi (renamed from efl/elementary/clock.pyx)99
-rw-r--r--efl/elementary/clock.py10
-rw-r--r--efl/elementary/clock_cdef.pxi (renamed from efl/elementary/clock.pxd)3
-rw-r--r--efl/elementary/cnp_callbacks.pxi2
-rw-r--r--efl/elementary/colorselector.pxi (renamed from efl/elementary/colorselector.pyx)77
-rw-r--r--efl/elementary/colorselector.py5
-rw-r--r--efl/elementary/colorselector_cdef.pxi (renamed from efl/elementary/colorselector.pxd)4
-rw-r--r--efl/elementary/configuration.pxi (renamed from efl/elementary/configuration.pyx)170
-rw-r--r--efl/elementary/configuration.py55
-rw-r--r--efl/elementary/configuration_cdef.pxi (renamed from efl/elementary/configuration.pxd)7
-rw-r--r--efl/elementary/conformant.pxi (renamed from efl/elementary/conformant.pyx)47
-rw-r--r--efl/elementary/conformant.py1
-rw-r--r--efl/elementary/conformant_cdef.pxi (renamed from efl/elementary/conformant.pxd)3
-rw-r--r--efl/elementary/ctxpopup.pxi (renamed from efl/elementary/ctxpopup.pyx)93
-rw-r--r--efl/elementary/ctxpopup.py7
-rw-r--r--efl/elementary/ctxpopup_cdef.pxi (renamed from efl/elementary/ctxpopup.pxd)5
-rw-r--r--efl/elementary/datetime.pxi (renamed from efl/elementary/datetime_elm.pyx)232
-rw-r--r--efl/elementary/datetime_cdef.pxi (renamed from efl/elementary/datetime_elm.pxd)4
-rw-r--r--efl/elementary/datetime_elm.py8
-rw-r--r--efl/elementary/dayselector.pxi (renamed from efl/elementary/dayselector.pyx)107
-rw-r--r--efl/elementary/dayselector.py10
-rw-r--r--efl/elementary/dayselector_cdef.pxi (renamed from efl/elementary/dayselector.pxd)5
-rw-r--r--efl/elementary/diskselector.pxi (renamed from efl/elementary/diskselector.pyx)90
-rw-r--r--efl/elementary/diskselector.py1
-rw-r--r--efl/elementary/diskselector_cdef.pxi (renamed from efl/elementary/diskselector.pxd)4
-rw-r--r--efl/elementary/elementary_cdef.pxi (renamed from efl/elementary/general.pxd)34
-rw-r--r--efl/elementary/entry.pxi (renamed from efl/elementary/entry.pyx)609
-rw-r--r--efl/elementary/entry.py71
-rw-r--r--efl/elementary/entry_cdef.pxi (renamed from efl/elementary/entry.pxd)7
-rw-r--r--efl/elementary/fileselector.pxi (renamed from efl/elementary/fileselector.pyx)153
-rw-r--r--efl/elementary/fileselector.py14
-rw-r--r--efl/elementary/fileselector_button.pxi (renamed from efl/elementary/fileselector_button.pyx)97
-rw-r--r--efl/elementary/fileselector_button.py1
-rw-r--r--efl/elementary/fileselector_button_cdef.pxi (renamed from efl/elementary/fileselector_button.pxd)2
-rw-r--r--efl/elementary/fileselector_cdef.pxi (renamed from efl/elementary/fileselector.pxd)4
-rw-r--r--efl/elementary/fileselector_entry.pxi (renamed from efl/elementary/fileselector_entry.pyx)111
-rw-r--r--efl/elementary/fileselector_entry.py1
-rw-r--r--efl/elementary/fileselector_entry_cdef.pxi (renamed from efl/elementary/fileselector_entry.pxd)2
-rw-r--r--efl/elementary/flip.pxi (renamed from efl/elementary/flip.pyx)170
-rw-r--r--efl/elementary/flip.py24
-rw-r--r--efl/elementary/flip_cdef.pxi (renamed from efl/elementary/flip.pxd)3
-rw-r--r--efl/elementary/flipselector.pxi (renamed from efl/elementary/flipselector.pyx)62
-rw-r--r--efl/elementary/flipselector.py1
-rw-r--r--efl/elementary/flipselector_cdef.pxi (renamed from efl/elementary/flipselector.pxd)4
-rw-r--r--efl/elementary/frame.pxi (renamed from efl/elementary/frame.pyx)59
-rw-r--r--efl/elementary/frame.py1
-rw-r--r--efl/elementary/frame_cdef.pxi (renamed from efl/elementary/frame.pxd)2
-rw-r--r--efl/elementary/general.py56
-rw-r--r--efl/elementary/gengrid.pxi142
-rw-r--r--efl/elementary/gengrid.py19
-rw-r--r--efl/elementary/gengrid.pyx488
-rw-r--r--efl/elementary/gengrid_cdef.pxi (renamed from efl/elementary/gengrid.pxd)27
-rw-r--r--efl/elementary/genlist.pxi167
-rw-r--r--efl/elementary/genlist.py40
-rw-r--r--efl/elementary/genlist.pyx707
-rw-r--r--efl/elementary/genlist_cdef.pxi (renamed from efl/elementary/genlist.pxd)17
-rw-r--r--efl/elementary/genlist_item_class.pxi14
-rw-r--r--efl/elementary/gesture_layer.pxi (renamed from efl/elementary/gesture_layer.pyx)173
-rw-r--r--efl/elementary/gesture_layer.py19
-rw-r--r--efl/elementary/gesture_layer_cdef.pxi (renamed from efl/elementary/gesture_layer.pxd)3
-rw-r--r--efl/elementary/grid.pxi (renamed from efl/elementary/grid.pyx)37
-rw-r--r--efl/elementary/grid.py1
-rw-r--r--efl/elementary/grid_cdef.pxi (renamed from efl/elementary/grid.pxd)3
-rw-r--r--efl/elementary/hover.pxi (renamed from efl/elementary/hover.pyx)116
-rw-r--r--efl/elementary/hover.py6
-rw-r--r--efl/elementary/hover_cdef.pxi (renamed from efl/elementary/hover.pxd)7
-rw-r--r--efl/elementary/hoversel.pxi (renamed from efl/elementary/hoversel.pyx)89
-rw-r--r--efl/elementary/hoversel.py5
-rw-r--r--efl/elementary/hoversel_cdef.pxi (renamed from efl/elementary/hoversel.pxd)4
-rw-r--r--efl/elementary/icon.pxi (renamed from efl/elementary/icon.pyx)191
-rw-r--r--efl/elementary/icon.py10
-rw-r--r--efl/elementary/icon_cdef.pxi (renamed from efl/elementary/icon.pxd)3
-rw-r--r--efl/elementary/image.pxi (renamed from efl/elementary/image.pyx)110
-rw-r--r--efl/elementary/image.py11
-rw-r--r--efl/elementary/image_cdef.pxi (renamed from efl/elementary/image.pxd)11
-rw-r--r--efl/elementary/index.pxi (renamed from efl/elementary/index.pyx)80
-rw-r--r--efl/elementary/index.py1
-rw-r--r--efl/elementary/index_cdef.pxi (renamed from efl/elementary/index.pxd)3
-rw-r--r--efl/elementary/innerwindow.pxi (renamed from efl/elementary/innerwindow.pyx)47
-rw-r--r--efl/elementary/innerwindow.py1
-rw-r--r--efl/elementary/innerwindow_cdef.pxi (renamed from efl/elementary/innerwindow.pxd)2
-rw-r--r--efl/elementary/label.pxi (renamed from efl/elementary/label.pyx)106
-rw-r--r--efl/elementary/label.py10
-rw-r--r--efl/elementary/label_cdef.pxi (renamed from efl/elementary/label.pxd)3
-rw-r--r--efl/elementary/layout.pxd4
-rw-r--r--efl/elementary/layout.pxi (renamed from efl/elementary/layout_class.pyx)78
-rw-r--r--efl/elementary/layout.py1
-rw-r--r--efl/elementary/layout.pyx178
-rw-r--r--efl/elementary/layout_cdef.pxi (renamed from efl/elementary/layout_class.pxd)23
-rw-r--r--efl/elementary/list.pxi (renamed from efl/elementary/list.pyx)179
-rw-r--r--efl/elementary/list.py16
-rw-r--r--efl/elementary/list_cdef.pxi (renamed from efl/elementary/list.pxd)5
-rw-r--r--efl/elementary/map.pxi (renamed from efl/elementary/map.pyx)218
-rw-r--r--efl/elementary/map.py29
-rw-r--r--efl/elementary/map_cdef.pxi (renamed from efl/elementary/map.pxd)3
-rw-r--r--efl/elementary/mapbuf.pxi (renamed from efl/elementary/mapbuf.pyx)39
-rw-r--r--efl/elementary/mapbuf.py1
-rw-r--r--efl/elementary/mapbuf_cdef.pxi (renamed from efl/elementary/mapbuf.pxd)2
-rw-r--r--efl/elementary/menu.pxi (renamed from efl/elementary/menu.pyx)54
-rw-r--r--efl/elementary/menu.py1
-rw-r--r--efl/elementary/menu_cdef.pxi (renamed from efl/elementary/menu.pxd)8
-rw-r--r--efl/elementary/multibuttonentry.pxi (renamed from efl/elementary/multibuttonentry.pyx)79
-rw-r--r--efl/elementary/multibuttonentry.py1
-rw-r--r--efl/elementary/multibuttonentry_cdef.pxi (renamed from efl/elementary/multibuttonentry.pxd)3
-rw-r--r--efl/elementary/naviframe.pxi (renamed from efl/elementary/naviframe.pyx)111
-rw-r--r--efl/elementary/naviframe.py1
-rw-r--r--efl/elementary/naviframe_cdef.pxi (renamed from efl/elementary/naviframe.pxd)3
-rw-r--r--efl/elementary/need.pxi (renamed from efl/elementary/need.pyx)16
-rw-r--r--efl/elementary/need.py7
-rw-r--r--efl/elementary/need_cdef.pxi (renamed from efl/elementary/need.pxd)2
-rw-r--r--efl/elementary/notify.pxi (renamed from efl/elementary/notify.pyx)61
-rw-r--r--efl/elementary/notify.py14
-rw-r--r--efl/elementary/notify_cdef.pxi (renamed from efl/elementary/notify.pxd)2
-rw-r--r--efl/elementary/object.pxi (renamed from efl/elementary/object.pyx)295
-rw-r--r--efl/elementary/object.py35
-rw-r--r--efl/elementary/object_cdef.pxi (renamed from efl/elementary/object.pxd)11
-rw-r--r--efl/elementary/object_item.pxi (renamed from efl/elementary/object_item.pyx)53
-rw-r--r--efl/elementary/object_item_cdef.pxi (renamed from efl/elementary/object_item.pxd)22
-rw-r--r--efl/elementary/panel.pxi (renamed from efl/elementary/panel.pyx)67
-rw-r--r--efl/elementary/panel.py6
-rw-r--r--efl/elementary/panel_cdef.pxi (renamed from efl/elementary/panel.pxd)3
-rw-r--r--efl/elementary/panes.pxi (renamed from efl/elementary/panes.pyx)50
-rw-r--r--efl/elementary/panes.py1
-rw-r--r--efl/elementary/panes_cdef.pxi (renamed from efl/elementary/panes.pxd)2
-rw-r--r--efl/elementary/photo.pxi (renamed from efl/elementary/photo.pyx)45
-rw-r--r--efl/elementary/photo.py1
-rw-r--r--efl/elementary/photo_cdef.pxi (renamed from efl/elementary/photo.pxd)2
-rw-r--r--efl/elementary/photocam.pxi (renamed from efl/elementary/photocam.pyx)109
-rw-r--r--efl/elementary/photocam.py7
-rw-r--r--efl/elementary/photocam_cdef.pxi (renamed from efl/elementary/photocam.pxd)3
-rw-r--r--efl/elementary/plug.pxi (renamed from efl/elementary/plug.pyx)44
-rw-r--r--efl/elementary/plug.py1
-rw-r--r--efl/elementary/plug_cdef.pxi (renamed from efl/elementary/plug.pxd)2
-rw-r--r--efl/elementary/popup.pxi (renamed from efl/elementary/popup.pyx)186
-rw-r--r--efl/elementary/popup.py17
-rw-r--r--efl/elementary/popup_cdef.pxi (renamed from efl/elementary/popup.pxd)4
-rw-r--r--efl/elementary/progressbar.pxi (renamed from efl/elementary/progressbar.pyx)75
-rw-r--r--efl/elementary/progressbar.py1
-rw-r--r--efl/elementary/progressbar_cdef.pxi (renamed from efl/elementary/progressbar.pxd)2
-rw-r--r--efl/elementary/radio.pxi (renamed from efl/elementary/radio.pyx)68
-rw-r--r--efl/elementary/radio.py1
-rw-r--r--efl/elementary/radio_cdef.pxi (renamed from efl/elementary/radio.pxd)3
-rw-r--r--efl/elementary/scroller.pxi (renamed from efl/elementary/scroller.pyx)146
-rw-r--r--efl/elementary/scroller.py14
-rw-r--r--efl/elementary/scroller_cdef.pxi (renamed from efl/elementary/scroller.pxd)7
-rw-r--r--efl/elementary/segment_control.pxi (renamed from efl/elementary/segment_control.pyx)65
-rw-r--r--efl/elementary/segment_control.py1
-rw-r--r--efl/elementary/segment_control_cdef.pxi (renamed from efl/elementary/segment_control.pxd)3
-rw-r--r--efl/elementary/separator.pxi (renamed from efl/elementary/separator.pyx)28
-rw-r--r--efl/elementary/separator.py1
-rw-r--r--efl/elementary/separator_cdef.pxi (renamed from efl/elementary/separator.pxd)2
-rw-r--r--efl/elementary/slider.pxi (renamed from efl/elementary/slider.pyx)77
-rw-r--r--efl/elementary/slider.py6
-rw-r--r--efl/elementary/slider_cdef.pxi (renamed from efl/elementary/slider.pxd)2
-rw-r--r--efl/elementary/slideshow.pxi (renamed from efl/elementary/slideshow.pyx)93
-rw-r--r--efl/elementary/slideshow.py1
-rw-r--r--efl/elementary/slideshow_cdef.pxi (renamed from efl/elementary/slideshow.pxd)3
-rw-r--r--efl/elementary/spinner.pxi (renamed from efl/elementary/spinner.pyx)60
-rw-r--r--efl/elementary/spinner.py1
-rw-r--r--efl/elementary/spinner_cdef.pxi (renamed from efl/elementary/spinner.pxd)2
-rw-r--r--efl/elementary/systray.pxi (renamed from efl/elementary/systray.pyx)69
-rw-r--r--efl/elementary/systray.py13
-rw-r--r--efl/elementary/systray_cdef.pxi (renamed from efl/elementary/systray.pxd)10
-rw-r--r--efl/elementary/table.pxi (renamed from efl/elementary/table.pyx)40
-rw-r--r--efl/elementary/table.py1
-rw-r--r--efl/elementary/table_cdef.pxi (renamed from efl/elementary/table.pxd)2
-rw-r--r--efl/elementary/theme.pxi (renamed from efl/elementary/theme.pyx)90
-rw-r--r--efl/elementary/theme.py2
-rw-r--r--efl/elementary/theme_cdef.pxi (renamed from efl/elementary/theme.pxd)23
-rw-r--r--efl/elementary/thumb.pxi (renamed from efl/elementary/thumb.pyx)180
-rw-r--r--efl/elementary/thumb.py26
-rw-r--r--efl/elementary/thumb_cdef.pxi (renamed from efl/elementary/thumb.pxd)3
-rw-r--r--efl/elementary/toolbar.pxi (renamed from efl/elementary/toolbar.pyx)190
-rw-r--r--efl/elementary/toolbar.py25
-rw-r--r--efl/elementary/toolbar_cdef.pxi (renamed from efl/elementary/toolbar.pxd)4
-rw-r--r--efl/elementary/tooltips.pxi52
-rw-r--r--efl/elementary/transit.pxi (renamed from efl/elementary/transit.pyx)178
-rw-r--r--efl/elementary/transit.py21
-rw-r--r--efl/elementary/transit_cdef.pxi (renamed from efl/elementary/transit.pxd)3
-rw-r--r--efl/elementary/video.pxi (renamed from efl/elementary/video.pyx)37
-rw-r--r--efl/elementary/video.py1
-rw-r--r--efl/elementary/video_cdef.pxi (renamed from efl/elementary/video.pxd)3
-rw-r--r--efl/elementary/web.pxi (renamed from efl/elementary/web.pyx)165
-rw-r--r--efl/elementary/web.py12
-rw-r--r--efl/elementary/web_cdef.pxi (renamed from efl/elementary/web.pxd)5
-rw-r--r--efl/elementary/window.pxi (renamed from efl/elementary/window.pyx)372
-rw-r--r--efl/elementary/window.py50
-rw-r--r--efl/elementary/window_cdef.pxi (renamed from efl/elementary/window.pxd)3
-rw-r--r--include/efl.elementary.pxd20
-rwxr-xr-xsetup.py96
283 files changed, 8835 insertions, 9237 deletions
diff --git a/doc/elementary/actionslider.rst b/doc/elementary/actionslider.rst
index df745d4..4619a9e 100644
--- a/doc/elementary/actionslider.rst
+++ b/doc/elementary/actionslider.rst
@@ -1,2 +1,83 @@
1Actionslider
2############
1 3
2.. automodule:: efl.elementary.actionslider 4.. image:: /images/actionslider-preview.png
5
6
7Widget description
8==================
9
10An actionslider is a switcher for two or three labels with
11customizable magnet properties.
12
13The user drags and releases the indicator, to choose a label.
14
15Labels can occupy the following positions.
16
17- Left
18- Right
19- Center
20
21Positions can be enabled or disabled.
22
23Magnets can be set on the above positions.
24
25When the indicator is released, it will move to its nearest "enabled and
26magnetized" position.
27
28
29Emitted signals
30===============
31
32- ``selected`` - when user selects an enabled position (the label is
33 passed as event info)".
34- ``pos_changed`` - when the indicator reaches any of the
35 positions("left", "right" or "center").
36
37
38Layout text parts
39=================
40
41- ``indicator`` - An indicator label of the actionslider
42- ``left`` - A left label of the actionslider
43- ``right`` - A right label of the actionslider
44- ``center`` - A center label of the actionslider
45
46
47Enumerations
48============
49
50.. _Elm_Actionslider_Pos:
51
52Actionslider positions
53----------------------
54
55.. data:: ELM_ACTIONSLIDER_NONE
56
57 No position
58
59.. data:: ELM_ACTIONSLIDER_LEFT
60
61 Left position
62
63.. data:: ELM_ACTIONSLIDER_CENTER
64
65 Center position
66
67.. data:: ELM_ACTIONSLIDER_RIGHT
68
69 Right position
70
71.. data:: ELM_ACTIONSLIDER_ALL
72
73 All positions
74
75
76Inheritance diagram
77===================
78
79.. inheritance-diagram:: efl.elementary.Actionslider
80 :parts: 2
81
82
83.. autoclass:: efl.elementary.Actionslider
diff --git a/doc/elementary/background.rst b/doc/elementary/background.rst
index ddac36a..a6b1803 100644
--- a/doc/elementary/background.rst
+++ b/doc/elementary/background.rst
@@ -1,2 +1,56 @@
1Background
2##########
1 3
2.. automodule:: efl.elementary.background 4.. image:: /images/background-preview.png
5
6
7Widget description
8==================
9
10The background widget is used for setting a solid color, image or Edje group
11as a background to a window (unless it has transparency enabled) or any
12container object.
13
14It works just like an image, but has some properties useful to a
15background, like setting it to tiled, centered, scaled or stretched.
16
17
18Layout content parts
19====================
20
21- ``overlay`` - overlay of the bg
22
23
24Enumerations
25============
26
27.. _Elm_Bg_Option:
28
29Background display modes
30------------------------
31
32.. data:: ELM_BG_OPTION_CENTER
33
34 Center
35
36.. data:: ELM_BG_OPTION_SCALE
37
38 Scale
39
40.. data:: ELM_BG_OPTION_STRETCH
41
42 Stretch
43
44.. data:: ELM_BG_OPTION_TILE
45
46 Tile
47
48
49Inheritance diagram
50===================
51
52.. inheritance-diagram:: efl.elementary.Background
53 :parts: 2
54
55
56.. autoclass:: efl.elementary.Background
diff --git a/doc/elementary/box.rst b/doc/elementary/box.rst
index 0661cf1..dd58ad3 100644
--- a/doc/elementary/box.rst
+++ b/doc/elementary/box.rst
@@ -1,2 +1,116 @@
1Box
2###
1 3
2.. automodule:: efl.elementary.box 4.. image:: /images/box-preview.png
5
6
7Widget description
8==================
9
10A box arranges objects in a linear fashion, governed by a layout function
11that defines the details of this arrangement.
12
13By default, the box will use an internal function to set the layout to
14a single row, either vertical or horizontal. This layout is affected
15by a number of parameters, such as the homogeneous flag set by
16:py:attr:`~Box.homogeneous`, the values given by :py:attr:`~Box.padding` and
17:py:attr:`~Box.align` and the hints set to each object in the box.
18
19For this default layout, it's possible to change the orientation with
20:py:attr:`~Box.horizontal`. The box will start in the vertical orientation,
21placing its elements ordered from top to bottom. When horizontal is set,
22the order will go from left to right. If the box is set to be
23homogeneous, every object in it will be assigned the same space, that
24of the largest object. Padding can be used to set some spacing between
25the cell given to each object. The alignment of the box, set with
26:py:attr:`~Box.align`, determines how the bounding box of all the elements
27will be placed within the space given to the box widget itself.
28
29The size hints of each object also affect how they are placed and sized
30within the box. :py:attr:`~efl.evas.Object.size_hint_min` will give the minimum
31size the object can have, and the box will use it as the basis for all
32latter calculations. Elementary widgets set their own minimum size as
33needed, so there's rarely any need to use it manually.
34
35:py:attr:`~efl.evas.Object.size_hint_weight`, when not in homogeneous mode, is
36used to tell whether the object will be allocated the minimum size it
37needs or if the space given to it should be expanded. It's important
38to realize that expanding the size given to the object is not the same
39thing as resizing the object. It could very well end being a small
40widget floating in a much larger empty space. If not set, the weight
41for objects will normally be 0.0 for both axis, meaning the widget will
42not be expanded. To take as much space possible, set the weight to
43``EVAS_HINT_EXPAND`` (defined to 1.0) for the desired axis to expand.
44
45Besides how much space each object is allocated, it's possible to control
46how the widget will be placed within that space using
47:py:attr:`~efl.evas.Object.size_hint_align`. By default, this value will be 0.5
48for both axis, meaning the object will be centered, but any value from
490.0 (left or top, for the ``x`` and ``y`` axis, respectively) to 1.0
50(right or bottom) can be used. The special value *EVAS_HINT_FILL*, which
51is -1.0, means the object will be resized to fill the entire space it
52was allocated.
53
54In addition, customized functions to define the layout can be set, which
55allow the application developer to organize the objects within the box
56in any number of ways.
57
58The special :py:meth:`Box.layout_transition` function can be used
59to switch from one layout to another, animating the motion of the
60children of the box.
61
62.. note:: Objects should not be added to box objects using _add() calls.
63
64
65Enumerations
66============
67
68.. _Evas_Object_Box_Layout:
69
70Box layout modes
71----------------
72
73.. data:: ELM_BOX_LAYOUT_HORIZONTAL
74
75 Horizontal layout
76
77.. data:: ELM_BOX_LAYOUT_VERTICAL
78
79 Vertical layout
80
81.. data:: ELM_BOX_LAYOUT_HOMOGENEOUS_VERTICAL
82
83 Homogeneous vertical layout
84
85.. data:: ELM_BOX_LAYOUT_HOMOGENEOUS_HORIZONTAL
86
87 Homogeneous horizontal layout
88
89.. data:: ELM_BOX_LAYOUT_HOMOGENEOUS_MAX_SIZE_HORIZONTAL
90
91 Homogeneous layout, maximum size on the horizontal axis
92
93.. data:: ELM_BOX_LAYOUT_HOMOGENEOUS_MAX_SIZE_VERTICAL
94
95 Homogeneous layout, maximum size on the horizontal axis
96
97.. data:: ELM_BOX_LAYOUT_FLOW_HORIZONTAL
98
99 Horizontally flowing layout
100
101.. data:: ELM_BOX_LAYOUT_FLOW_VERTICAL
102
103 Vertically flowing layout
104
105.. data:: ELM_BOX_LAYOUT_STACK
106
107 Stacking layout
108
109
110Inheritance diagram
111===================
112
113.. inheritance-diagram:: efl.elementary.Box
114 :parts: 2
115
116.. autoclass:: efl.elementary.Box
diff --git a/doc/elementary/bubble.rst b/doc/elementary/bubble.rst
index 3f0c1a9..62c4cc0 100644
--- a/doc/elementary/bubble.rst
+++ b/doc/elementary/bubble.rst
@@ -1,2 +1,86 @@
1Bubble
2######
3
4.. image:: /images/bubble-preview.png
5
6
7Widget description
8==================
9
10The Bubble is a widget to show text similar to how speech is
11represented in comics.
12
13The bubble widget contains 5 important visual elements:
14
15- The frame is a rectangle with rounded edjes and an "arrow".
16- The ``icon`` is an image to which the frame's arrow points to.
17- The ``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
19 the frame otherwise.
20- The ``info`` is a text which appears to the right of the label. Info's
21 font is of a lighter color than label.
22- The ``content`` is an evas object that is shown inside the frame.
23
24The position of the arrow, icon, label and info depends on which corner is
25selected. The four available corners are:
26
27- ``top_left`` - Default
28- ``top_right``
29- ``bottom_left``
30- ``bottom_right``
31
32
33Layout content parts
34====================
35
36- ``default`` - A content of the bubble
37- ``icon`` - An icon of the bubble
38
39
40Layout text parts
41=================
42
43- ``default`` - Label of the bubble
44- ``info`` - info of the bubble
45
46
47Emitted signals
48===============
49
50- ``clicked`` - This is called when a user has clicked the bubble.
51- ``focused`` - When the bubble has received focus. (since 1.8)
52- ``unfocused`` - When the bubble has lost focus. (since 1.8)
53
54
55Enumerations
56============
57
58.. _Elm_Bubble_Pos:
59
60Bubble arrow positions
61----------------------
62
63.. data:: ELM_BUBBLE_POS_TOP_LEFT
64
65 Top left position
66
67.. data:: ELM_BUBBLE_POS_TOP_RIGHT
68
69 Top right position
70
71.. data:: ELM_BUBBLE_POS_BOTTOM_LEFT
72
73 Bottom left position
74
75.. data:: ELM_BUBBLE_POS_BOTTOM_RIGHT
76
77 Bottom right position
78
79
80Inheritance diagram
81===================
82
83.. inheritance-diagram:: efl.elementary.bubble
84 :parts: 2
1 85
2.. automodule:: efl.elementary.bubble 86.. automodule:: efl.elementary.bubble
diff --git a/doc/elementary/button.rst b/doc/elementary/button.rst
index d138ba2..680266f 100644
--- a/doc/elementary/button.rst
+++ b/doc/elementary/button.rst
@@ -1,3 +1,63 @@
1Button
2######
1 3
2.. automodule:: efl.elementary.button 4.. image:: /images/button-preview.png
5
6
7Widget description
8==================
9
10This is a push-button. Press it and run some function. It can contain
11a simple label and icon object and it also has an autorepeat feature.
12
13
14Available styles
15================
16
17- ``default`` a normal button.
18- ``anchor`` Like default, but the button fades away when the mouse is not
19 over it, leaving only the text or icon.
20- ``hoversel_vertical`` Internally used by
21 :py:class:`~efl.elementary.hoversel.Hoversel` to give a continuous look
22 across its options.
23- ``hoversel_vertical_entry`` Another internal for
24 :py:class:`~efl.elementary.hoversel.Hoversel`.
25- ``naviframe`` Internally used by
26 :py:class:`~efl.elementary.naviframe.Naviframe` for its back button.
27- ``colorselector`` Internally used by
28 :py:class:`~efl.elementary.colorselector.Colorselector` for its left and
29 right buttons.
30
31
32Layout content parts
33====================
34
35- ``icon`` - An icon of the button
36
37
38Layout text parts
39=================
40
41- ``default`` - Label of the button
42
43
44Emitted signals
45===============
46
47- ``clicked``: the user clicked the button (press/release).
48- ``repeated``: the user pressed the button without releasing it.
49- ``pressed``: button was pressed.
50- ``unpressed``: button was released after being pressed.
51- ``focused`` : When the button has received focus. (since 1.8)
52- ``unfocused`` : When the button has lost focus. (since 1.8)
53
54
55Inheritance diagram
56===================
57
58.. inheritance-diagram:: efl.elementary.Button
59 :parts: 2
60
61
62.. autoclass:: efl.elementary.Button
3 63
diff --git a/doc/elementary/calendar.rst b/doc/elementary/calendar.rst
index c3fd57a..10026b7 100644
--- a/doc/elementary/calendar.rst
+++ b/doc/elementary/calendar.rst
@@ -1,2 +1,160 @@
1Calendar
2########
1 3
2.. automodule:: efl.elementary.calendar_elm 4.. image:: /images/calendar-preview.png
5
6
7Widget description
8==================
9
10This is a calendar widget.
11
12It helps applications to flexibly display a calender with day of the week,
13date, year and month. Applications are able to set specific dates to be
14reported back, when selected, in the smart callbacks of the calendar widget.
15The API of this widget lets the applications perform other functions, like:
16
17- placing marks on specific dates
18- setting the bounds for the calendar (minimum and maximum years)
19- setting the day names of the week (e.g. "Thu" or "Thursday")
20- setting the year and month format.
21
22
23Emitted signals
24===============
25
26- ``changed`` - emitted when the date in the calendar is changed.
27- ``display,changed`` - emitted when the current month displayed in the
28 calendar is changed.
29- ``focused`` - When the calendar has received focus. (since 1.8)
30- ``unfocused`` - When the calendar has lost focus. (since 1.8)
31
32
33Enumerations
34============
35
36.. _Elm_Calendar_Mark_Repeat_Type:
37
38Calendar mark repeat types
39--------------------------
40
41.. data:: ELM_CALENDAR_UNIQUE
42
43 Default value.
44
45 Marks will be displayed only on event day.
46
47.. data:: ELM_CALENDAR_DAILY
48
49 Marks will be displayed every day after event day (inclusive).
50
51.. data:: ELM_CALENDAR_WEEKLY
52
53 Marks will be displayed every week after event day (inclusive) - i.e.
54 each seven days.
55
56.. data:: ELM_CALENDAR_MONTHLY
57
58 Marks will be displayed every month day that coincides to event day.
59
60 E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb,
61 but will be displayed on 30th Mar
62
63.. data:: ELM_CALENDAR_ANNUALLY
64
65 Marks will be displayed every year that coincides to event day (and month).
66
67 E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013.
68
69.. data:: ELM_CALENDAR_LAST_DAY_OF_MONTH
70
71 Marks will be displayed every last day of month after event day
72 (inclusive).
73
74
75.. _Elm_Calendar_Select_Mode:
76
77Calendar selection modes
78------------------------
79
80.. data:: ELM_CALENDAR_SELECT_MODE_DEFAULT
81
82 Default mode
83
84.. data:: ELM_CALENDAR_SELECT_MODE_ALWAYS
85
86 Select always
87
88.. data:: ELM_CALENDAR_SELECT_MODE_NONE
89
90 Don't select
91
92.. data:: ELM_CALENDAR_SELECT_MODE_ONDEMAND
93
94 Select on demand
95
96
97.. _Elm_Calendar_Selectable:
98
99Selectable
100----------
101
102.. data:: ELM_CALENDAR_SELECTABLE_NONE
103
104 None selectable
105
106.. data:: ELM_CALENDAR_SELECTABLE_YEAR
107
108 Year is selectable
109
110.. data:: ELM_CALENDAR_SELECTABLE_MONTH
111
112 Month is selectable
113
114.. data:: ELM_CALENDAR_SELECTABLE_DAY
115
116 Day is selectable
117
118
119.. _Elm_Calendar_Weekday:
120
121Days
122----
123
124.. data:: ELM_DAY_SUNDAY
125
126 Sunday
127
128.. data:: ELM_DAY_MONDAY
129
130 Monday
131
132.. data:: ELM_DAY_TUESDAY
133
134 Tuesday
135
136.. data:: ELM_DAY_WEDNESDAY
137
138 Wednesday
139
140.. data:: ELM_DAY_THURSDAY
141
142 Thursday
143
144.. data:: ELM_DAY_FRIDAY
145
146 Friday
147
148.. data:: ELM_DAY_SATURDAY
149
150 Saturday
151
152
153Inheritance diagram
154===================
155
156.. inheritance-diagram:: efl.elementary.Calendar
157 :parts: 2
158
159
160.. autoclass:: efl.elementary.Calendar
diff --git a/doc/elementary/check.rst b/doc/elementary/check.rst
index 7da1ef8..5b37007 100644
--- a/doc/elementary/check.rst
+++ b/doc/elementary/check.rst
@@ -1,2 +1,47 @@
1Check
2#####
1 3
2.. automodule:: efl.elementary.check 4.. image:: /images/check-preview.png
5
6
7Widget description
8==================
9
10The check widget allows for toggling a value between true and false.
11
12Check objects are a lot like radio objects in layout and functionality,
13except they do not work as a group, but independently, and only toggle
14the value of a boolean :py:attr:`~Check.state` between false and true.
15
16
17Emitted signals
18===============
19
20- ``changed`` - This is called whenever the user changes the state of
21 the check objects.
22- ``focused`` - When the check has received focus. (since 1.8)
23- ``unfocused`` - When the check has lost focus. (since 1.8)
24
25
26Layout content parts
27====================
28
29- ``icon`` - An icon of the check
30
31
32Layout text parts
33=================
34
35- ``default`` - A label of the check
36- ``on`` - On state label of the check
37- ``off`` - Off state label of the check
38
39
40Inheritance diagram
41===================
42
43.. inheritance-diagram:: efl.elementary.Check
44 :parts: 2
45
46
47.. autoclass:: efl.elementary.Check
diff --git a/doc/elementary/clock.rst b/doc/elementary/clock.rst
index 519a6e2..010fa61 100644
--- a/doc/elementary/clock.rst
+++ b/doc/elementary/clock.rst
@@ -1,2 +1,92 @@
1Clock
2#####
1 3
2.. automodule:: efl.elementary.clock 4.. image:: /images/clock-preview.png
5
6
7Widget description
8==================
9
10This is a digital clock widget.
11
12In its default theme, it has a vintage "flipping numbers clock" appearance,
13which will animate sheets of individual algarisms individually as time goes
14by.
15
16A newly created clock will fetch system's time (already considering
17local time adjustments) to start with, and will tick accordingly. It may
18or may not show seconds.
19
20Clocks have an **edition** mode. When in it, the sheets will display
21extra arrow indications on the top and bottom and the user may click on
22them to raise or lower the time values. After it's told to exit edition
23mode, it will keep ticking with that new time set (it keeps the
24difference from local time).
25
26Also, when under edition mode, user clicks on the cited arrows which are
27**held** for some time will make the clock to flip the sheet, thus
28editing the time, continuously and automatically for the user. The
29interval between sheet flips will keep growing in time, so that it helps
30the user to reach a time which is distant from the one set.
31
32The time display is, by default, in military mode (24h), but an am/pm
33indicator may be optionally shown, too, when it will switch to 12h.
34
35
36Emitted signals
37===============
38
39- ``changed`` - the clock's user changed the time
40- ``focused`` - When the clock has received focus. (since 1.8)
41- ``unfocused`` - When the clock has lost focus. (since 1.8)
42
43
44Enumerations
45============
46
47.. _Elm_Clock_Edit_Mode:
48
49Clock edit modes
50----------------
51
52.. data:: ELM_CLOCK_EDIT_DEFAULT
53
54 Default edit
55
56.. data:: ELM_CLOCK_EDIT_HOUR_DECIMAL
57
58 Edit hours' decimal
59
60.. data:: ELM_CLOCK_EDIT_HOUR_UNIT
61
62 Edit hours' unit
63
64.. data:: ELM_CLOCK_EDIT_MIN_DECIMAL
65
66 Edit minutes' decimal
67
68.. data:: ELM_CLOCK_EDIT_MIN_UNIT
69
70 Edit minutes' unit
71
72.. data:: ELM_CLOCK_EDIT_SEC_DECIMAL
73
74 Edit seconds' decimal
75
76.. data:: ELM_CLOCK_EDIT_SEC_UNIT
77
78 Edit seconds' unit
79
80.. data:: ELM_CLOCK_EDIT_ALL
81
82 Edit all
83
84
85Inheritance diagram
86===================
87
88.. inheritance-diagram:: efl.elementary.Clock
89 :parts: 2
90
91
92.. autoclass:: efl.elementary.Clock
diff --git a/doc/elementary/colorselector.rst b/doc/elementary/colorselector.rst
index 21b8103..ab27f70 100644
--- a/doc/elementary/colorselector.rst
+++ b/doc/elementary/colorselector.rst
@@ -1,2 +1,62 @@
1Colorselector
2#############
1 3
2.. automodule:: efl.elementary.colorselector 4.. image:: /images/colorselector-preview.png
5
6
7Widget description
8==================
9
10A Colorselector is a color selection widget.
11
12It allows application to set a series of colors. It also allows to
13load/save colors from/to config with a unique identifier, by default,
14the colors are loaded/saved from/to config using "default" identifier.
15The colors can be picked by user from the color set by clicking on
16individual color item on the palette or by selecting it from selector.
17
18
19Emitted signals
20===============
21
22- ``"changed"`` - When the color value changes on selector
23- ``"color,item,selected"`` - When user clicks on color item.
24 The event_info parameter of the callback will be the selected
25 color item.
26- ``"color,item,longpressed"`` - When user long presses on color item.
27 The event_info parameter of the callback will be the selected
28 color item.
29- ``focused`` - When the colorselector has received focus. (since 1.8)
30- ``unfocused`` - When the colorselector has lost focus. (since 1.8)
31
32
33Enumerations
34============
35
36.. _Elm_Colorselector_Mode:
37
38Colorselector modes
39-------------------
40
41.. data:: ELM_COLORSELECTOR_PALETTE
42
43 Show palette
44
45.. data:: ELM_COLORSELECTOR_COMPONENTS
46
47 Show components
48
49.. data:: ELM_COLORSELECTOR_BOTH
50
51 Show palette and components
52
53
54Inheritance diagram
55===================
56
57.. inheritance-diagram:: efl.elementary.colorselector
58 :parts: 2
59
60
61.. autoclass:: efl.elementary.Colorselector
62.. autoclass:: efl.elementary.ColorselectorPaletteItem
diff --git a/doc/elementary/configuration.rst b/doc/elementary/configuration.rst
index 3c992da..d5fa4b7 100644
--- a/doc/elementary/configuration.rst
+++ b/doc/elementary/configuration.rst
@@ -1,2 +1,161 @@
1Configuration
2#############
1 3
2.. automodule:: efl.elementary.configuration 4Description
5===========
6
7Elementary configuration is formed by a set options bounded to a
8given profile, like theme, "finger size", etc.
9
10These are functions with which one synchronizes changes made to those
11values to the configuration storing files, de facto. You most probably
12don't want to use the functions in this group unless you're writing an
13elementary configuration manager.
14
15Profiles
16========
17
18Profiles are pre-set options that affect the whole look-and-feel of
19Elementary-based applications. There are, for example, profiles
20aimed at desktop computer applications and others aimed at mobile,
21touchscreen-based ones. You most probably don't want to use the
22functions in this group unless you're writing an elementary
23configuration manager.
24
25Elementary Scrolling
26====================
27
28These set how scrollable views in Elementary widgets should behave on
29user interaction.
30
31Password show last
32==================
33
34Show last feature of password mode enables user to view the last input
35entered for few seconds before masking it. These functions allow to set
36this feature in password mode of entry widget and also allow to
37manipulate the duration for which the input has to be visible.
38
39Elementary Engine
40=================
41
42These are functions setting and querying which rendering engine
43Elementary will use for drawing its windows' pixels.
44
45The following are the available engines:
46
47- "software_x11"
48- "fb"
49- "directfb"
50- "software_16_x11"
51- "software_8_x11"
52- "xrender_x11"
53- "opengl_x11"
54- "software_gdi"
55- "software_16_wince_gdi"
56- "sdl"
57- "software_16_sdl"
58- "opengl_sdl"
59- "buffer"
60- "ews"
61- "opengl_cocoa"
62- "psl1ght"
63
64
65ATSPI AT-SPI2 Accessibility
66===========================
67
68Elementary widgets support Linux Accessibility standard. For more
69information please visit:
70http://www.linuxfoundation.org/collaborate/workgroups/accessibility/atk/at-spi/at-spi_on_d-bus
71
72
73Enumerations
74============
75
76.. _Elm_Softcursor_Mode:
77
78Elm_Softcursor_Mode
79-------------------
80
81.. data:: ELM_SOFTCURSOR_MODE_AUTO
82
83 Auto-detect if a software cursor should be used (default)
84
85.. data:: ELM_SOFTCURSOR_MODE_ON
86
87 Always use a softcursor
88
89.. data:: ELM_SOFTCURSOR_MODE_OFF
90
91 Never use a softcursor
92
93
94.. _Elm_Slider_Indicator_Visible_Mode:
95
96Elm_Slider_Indicator_Visible_Mode
97---------------------------------
98
99.. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_DEFAULT
100
101 show indicator on mouse down or change in slider value
102
103.. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_ALWAYS
104
105 Always show the indicator
106
107.. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_ON_FOCUS
108
109 Show the indicator on focus
110
111.. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_NONE
112
113 Never show the indicator
114
115
116.. _Edje_Channel:
117
118Audio Channels
119--------------
120
121.. data:: EDJE_CHANNEL_EFFECT
122
123 Standard audio effects
124
125.. data:: EDJE_CHANNEL_BACKGROUND
126
127 Background audio sounds
128
129.. data:: EDJE_CHANNEL_MUSIC
130
131 Music audio
132
133.. data:: EDJE_CHANNEL_FOREGROUND
134
135 Foreground audio sounds
136
137.. data:: EDJE_CHANNEL_INTERFACE
138
139 Sounds related to the interface
140
141.. data:: EDJE_CHANNEL_INPUT
142
143 Sounds related to regular input
144
145.. data:: EDJE_CHANNEL_ALERT
146
147 Sounds for major alerts
148
149.. data:: EDJE_CHANNEL_ALL
150
151 All audio channels (convenience)
152
153
154Inheritance diagram
155===================
156
157.. inheritance-diagram:: efl.elementary.Configuration
158 :parts: 2
159
160
161.. autoclass:: efl.elementary.Configuration
diff --git a/doc/elementary/conformant.rst b/doc/elementary/conformant.rst
index b13449c..a428e8c 100644
--- a/doc/elementary/conformant.rst
+++ b/doc/elementary/conformant.rst
@@ -1,2 +1,41 @@
1Conformant
2##########
1 3
2.. automodule:: efl.elementary.conformant 4.. image:: /images/conformant-preview.png
5
6
7Widget description
8==================
9
10The aim is to provide a widget that can be used in elementary apps to
11account for space taken up by the indicator, virtual keypad & softkey
12windows when running the illume2 module of E17.
13
14So conformant content will be sized and positioned considering the
15space required for such stuff, and when they popup, as a keyboard
16shows when an entry is selected, conformant content won't change.
17
18
19Emitted signals
20===============
21
22- ``virtualkeypad,state,on``: if virtualkeypad state is switched to ``on``.
23- ``virtualkeypad,state,off``: if virtualkeypad state is switched to ``off``.
24- ``clipboard,state,on``: if clipboard state is switched to ``on``.
25- ``clipboard,state,off``: if clipboard state is switched to ``off``.
26
27
28Layout content parts
29====================
30
31- ``default`` - A content of the conformant
32
33
34Inheritance diagram
35===================
36
37.. inheritance-diagram:: efl.elementary.Conformant
38 :parts: 2
39
40
41.. autoclass:: efl.elementary.Conformant
diff --git a/doc/elementary/ctxpopup.rst b/doc/elementary/ctxpopup.rst
index 95151ac..bfad5bc 100644
--- a/doc/elementary/ctxpopup.rst
+++ b/doc/elementary/ctxpopup.rst
@@ -1,2 +1,82 @@
1Ctxpopup
2########
1 3
2.. automodule:: efl.elementary.ctxpopup 4.. image:: /images/ctxpopup-preview.png
5
6
7Widget description
8==================
9
10A ctxpopup is a widget that, when shown, pops up a list of items. It
11automatically chooses an area inside its parent object's view to
12optimally fit into it. In the default theme, it will also point an arrow
13to it's top left position at the time one shows it. Ctxpopup items have
14a label and/or an icon. It is intended for a small number of items
15(hence the use of list, not genlist).
16
17.. note::
18
19 Ctxpopup is a specialization of :py:class:`~efl.elementary.hover.Hover`.
20
21Emitted signals
22===============
23
24- ``dismissed`` - This is called when 1. the outside of ctxpopup was clicked
25 or 2. its parent area is changed or 3. the language is changed and also when
26 4. the parent object is resized due to the window rotation. Then ctxpopup is
27 dismissed.
28- ``language,changed`` - This is called when the program's language is
29 changed.
30- ``focused`` - When the ctxpopup has received focus. (since 1.8)
31- ``unfocused`` - When the ctxpopup has lost focus. (since 1.8)
32
33Layout content parts
34====================
35
36- ``default`` - A content of the ctxpopup
37- ``icon`` - An icon in the title area
38
39Layout text parts
40=================
41
42- ``default`` - Title label in the title area
43
44
45Enumerations
46============
47
48.. _Elm_Ctxpopup_Direction:
49
50Ctxpopup arrow directions
51-------------------------
52
53.. data:: ELM_CTXPOPUP_DIRECTION_DOWN
54
55 Arrow is pointing down
56
57.. data:: ELM_CTXPOPUP_DIRECTION_RIGHT
58
59 Arrow is pointing right
60
61.. data:: ELM_CTXPOPUP_DIRECTION_LEFT
62
63 Arrow is pointing left
64
65.. data:: ELM_CTXPOPUP_DIRECTION_UP
66
67 Arrow is pointing up
68
69.. data:: ELM_CTXPOPUP_DIRECTION_UNKNOWN
70
71 Arrow direction is unknown
72
73
74Inheritance diagram
75===================
76
77.. inheritance-diagram:: efl.elementary.Ctxpopup
78 :parts: 2
79
80
81.. autoclass:: efl.elementary.Ctxpopup
82.. autoclass:: efl.elementary.CtxpopupItem
diff --git a/doc/elementary/datetime.rst b/doc/elementary/datetime.rst
index cf98d10..145d704 100644
--- a/doc/elementary/datetime.rst
+++ b/doc/elementary/datetime.rst
@@ -1,2 +1,218 @@
1Datetime
2########
1 3
2.. automodule:: efl.elementary.datetime_elm 4Widget description
5==================
6
7Datetime widget is used to display and input date & time values.
8
9This widget displays date and time as per the **system's locale** settings
10(Date includes Day, Month & Year along with the defined separators and Time
11includes Hour, Minute & AM/PM fields). Separator for AM/PM field is ignored.
12
13The corresponding Month, AM/PM strings are displayed according to the
14system’s language settings.
15
16Datetime format is a combination of LIBC standard characters like "%%d %%b
17%%Y %%I : %%M %%p" which, as a whole represents both Date as well as Time
18format.
19
20Elm_datetime supports only the following sub set of libc date format specifiers:
21
22**%%Y** The year as a decimal number including the century (example: 2011).
23
24**%%y** The year as a decimal number without a century (range 00 to 99)
25
26**%%m** The month as a decimal number (range 01 to 12).
27
28**%%b** The abbreviated month name according to the current locale.
29
30**%%B** The full month name according to the current locale.
31
32**%%h** The abbreviated month name according to the current locale(same as %%b).
33
34**%%d** The day of the month as a decimal number (range 01 to 31).
35
36**%%e** The day of the month as a decimal number (range 1 to 31). single
37 digits are preceded by a blank.
38
39**%%I** The hour as a decimal number using a 12-hour clock (range 01 to 12).
40
41**%%H** The hour as a decimal number using a 24-hour clock (range 00 to 23).
42
43**%%k** The hour (24-hour clock) as a decimal number (range 0 to 23). single
44 digits are preceded by a blank.
45
46**%%l** The hour (12-hour clock) as a decimal number (range 1 to 12); single
47 digits are preceded by a blank.
48
49**%%M** The minute as a decimal number (range 00 to 59).
50
51**%%p** Either 'AM' or 'PM' according to the given time value, or the
52 corresponding strings for the current locale. Noon is treated as 'PM'
53 and midnight as 'AM'
54
55**%%P** Like %p but in lower case: 'am' or 'pm' or a corresponding string for
56 the current locale.
57
58**%%c** The preferred date and time representation for the current locale.
59
60**%%x** The preferred date representation for the current locale without the time.
61
62**%%X** The preferred time representation for the current locale without the date.
63
64**%%r** The complete calendar time using the AM/PM format of the current locale.
65
66**%%R** The hour and minute in decimal numbers using the format %H:%M.
67
68**%%T** The time of day in decimal numbers using the format %H:%M:%S.
69
70**%%D** The date using the format %%m/%%d/%%y.
71
72**%%F** The date using the format %%Y-%%m-%%d.
73
74
75(For more reference on the available **LIBC date format specifiers**,
76please visit the link:
77http://www.gnu.org/s/hello/manual/libc.html#Formatting-Calendar-Time )
78
79Datetime widget can provide Unicode **separators** in between its fields
80except for AM/PM field. A separator can be any **Unicode character**
81other than the LIBC standard date format specifiers.
82
83Example: In the format::
84
85 %%b %%d **,** %%y %%H **:** %%M
86
87comma(,) is separator for date field %%d and colon(:) is separator for
88hour field %%H.
89
90The default format is a predefined one, based on the system Locale.
91
92Hour format 12hr(1-12) or 24hr(0-23) display can be selected by setting
93the corresponding user format.
94
95Datetime supports six fields: Year, Month, Date, Hour, Minute, AM/PM.
96Depending on the Datetime module that is loaded, the user can see
97different UI to select the individual field values.
98
99The individual fields of Datetime can be arranged in any order according
100to the format set by application.
101
102There is a provision to set the visibility of a particular field as TRUE/
103FALSE so that **only time/ only date / only required fields** will be
104displayed.
105
106Each field is having a default minimum and maximum values just like the
107daily calendar information. These min/max values can be modified as per
108the application usage.
109
110User can enter the values only in between the range of maximum and
111minimum. Apart from these APIs, there is a provision to display only a
112limited set of values out of the possible values. APIs to select the
113individual field limits are intended for this purpose.
114
115The whole widget is left aligned and its size grows horizontally
116depending on the current format and each field's visible/disabled state.
117
118Datetime individual field selection is implemented in a modular style.
119Module can be implemented as a Ctxpopup based selection or an ISE based
120selection or even a spinner like selection etc.
121
122Datetime Module design
123======================
124
125The following functions are expected to be implemented in a Datetime module:
126
127**Field creation**::
128
129 __________ __________
130 | |----- obj_hook() ---------------------->>>| |
131 | |<<<----------------returns Mod_data ------| |
132 | Datetime |_______ | |
133 | widget | |Assign module call backs | Module |
134 | base |<<<____| | |
135 | | | |
136 | |----- field_create() ------------------>>>| |
137 |__________|<<<----------------returns field_obj -----|__________|
138
139**Field value setting**::
140
141 __________ __________
142 | | | |
143 | Datetime |<<<----------elm_datetime_value_set()---| |
144 | widget | | Module |
145 | base |----display_field_value()------------>>>| |
146 |__________| |__________|
147
148**del_hook**::
149
150 __________ __________
151 | | | |
152 | Datetime |----obj_unhook()-------------------->>>>| |
153 | widget | | Module |
154 | base | <<<-----frees mod_data---------| |
155 |__________| |__________|
156
157Any module can use the following shared functions that are implemented in
158elm_datetime.c:
159
160**field_format_get()** - gives the field format.
161
162**field_limit_get()** - gives the field minimum, maximum limits.
163
164To enable a module, set the ELM_MODULES environment variable as shown:
165
166**export ELM_MODULES="datetime_input_ctxpopup>datetime/api"**
167
168
169Emitted signals
170===============
171
172- ``changed`` - whenever Datetime field value is changed, this signal is sent.
173- ``language,changed`` - whenever system locale changes, this signal is sent.
174- ``focused`` - When the datetime has received focus. (since 1.8)
175- ``unfocused`` - When the datetime has lost focus. (since 1.8)
176
177
178Enumerations
179============
180
181.. _Elm_Datetime_Field_Type:
182
183Datetime fields
184---------------
185
186.. data:: ELM_DATETIME_YEAR
187
188 Year
189
190.. data:: ELM_DATETIME_MONTH
191
192 Month
193
194.. data:: ELM_DATETIME_DATE
195
196 Date
197
198.. data:: ELM_DATETIME_HOUR
199
200 Hour
201
202.. data:: ELM_DATETIME_MINUTE
203
204 Minute
205
206.. data:: ELM_DATETIME_AMPM
207
208 Am/Pm
209
210
211Inheritance diagram
212===================
213
214.. inheritance-diagram:: efl.elementary.Datetime
215 :parts: 2
216
217
218.. autoclass:: efl.elementary.Datetime
diff --git a/doc/elementary/dayselector.rst b/doc/elementary/dayselector.rst
index 4540b10..4a2d523 100644
--- a/doc/elementary/dayselector.rst
+++ b/doc/elementary/dayselector.rst
@@ -1,2 +1,97 @@
1Dayselector
2###########
1 3
2.. automodule:: efl.elementary.dayselector 4.. image:: /images/dayselector-preview.png
5
6
7Widget description
8==================
9
10Dayselector displays all seven days of the week and allows the user to
11select multiple days.
12
13The selection can be toggle by just clicking on the day.
14
15Dayselector also provides the functionality to check whether a day is
16selected or not.
17
18First day of the week is taken from config settings by default. It can be
19altered by using the API :py:attr:`~Dayselector.week_start` API.
20
21APIs are provided for setting the duration of weekend
22:py:attr:`~Dayselector.weekend_start` and :py:attr:`~Dayselector.weekend_length`
23does this job.
24
25Two styles of weekdays and weekends are supported in Dayselector.
26Application can emit signals on individual check objects for setting the
27weekday, weekend styles.
28
29Once the weekend start day or weekend length changes, all the weekday &
30weekend styles will be reset to default style. It's the application's
31responsibility to set the styles again by sending corresponding signals.
32
33"day0" indicates Sunday, "day1" indicates Monday etc. continues and so,
34"day6" indicates the Saturday part name.
35
36Application can change individual day display string by using the API
37:py:meth:`~efl.elementary.object.Object.part_text_set`.
38
39:py:meth:`~efl.elementary.object.Object.part_content_set` API sets the
40individual day object only if the passed one is a Check widget.
41
42Check object representing a day can be set/get by the application by using
43the elm_object_part_content_set/get APIs thus providing a way to handle
44the different check styles for individual days.
45
46
47Emitted signals
48===============
49
50- ``dayselector,changed`` - when the user changes the state of a day.
51- ``language,changed`` - the program's language changed
52
53
54Enumerations
55============
56
57.. _Elm_Dayselector_Day:
58
59Dayselector days
60----------------
61
62.. data:: ELM_DAYSELECTOR_SUN
63
64 Sunday
65
66.. data:: ELM_DAYSELECTOR_MON
67
68 Monday
69
70.. data:: ELM_DAYSELECTOR_TUE
71
72 Tuesday
73
74.. data:: ELM_DAYSELECTOR_WED
75
76 Wednesday
77
78.. data:: ELM_DAYSELECTOR_THU
79
80 Thursday
81
82.. data:: ELM_DAYSELECTOR_FRI
83
84 Friday
85
86.. data:: ELM_DAYSELECTOR_SAT
87
88 Saturday
89
90
91Inheritance diagram
92===================
93
94.. inheritance-diagram:: efl.elementary.Dayselector
95 :parts: 2
96
97.. autoclass:: efl.elementary.Dayselector
diff --git a/doc/elementary/diskselector.rst b/doc/elementary/diskselector.rst
index 10879bd..2b4581d 100644
--- a/doc/elementary/diskselector.rst
+++ b/doc/elementary/diskselector.rst
@@ -1,2 +1,68 @@
1Diskselector
2############
1 3
2.. automodule:: efl.elementary.diskselector 4.. image:: /images/diskselector-preview.png
5
6
7Widget description
8==================
9
10A diskselector is a kind of list widget. It scrolls horizontally,
11and can contain label and icon objects. Three items are displayed
12with the selected one in the middle.
13
14It can act like a circular list with round mode and labels can be
15reduced for a defined length for side items.
16
17
18Emitted signals
19===============
20
21- ``selected`` - when item is selected, i.e. scroller stops.
22- ``clicked`` - This is called when a user clicks an item
23- ``scroll,anim,start`` - scrolling animation has started
24- ``scroll,anim,stop`` - scrolling animation has stopped
25- ``scroll,drag,start`` - dragging the diskselector has started
26- ``scroll,drag,stop`` - dragging the diskselector has stopped
27- ``focused`` - When the diskselector has received focus. (since 1.8)
28- ``unfocused`` - When the diskselector has lost focus. (since 1.8)
29
30.. note:: The ``scroll,anim,*`` and ``scroll,drag,*`` signals are only emitted
31 by user intervention.
32
33Layout content parts
34====================
35
36- ``icon`` - An icon in the diskselector item
37
38
39Layout text parts
40=================
41
42- ``default`` - Label of the diskselector item
43
44
45Scrollable Interface
46====================
47
48This widget supports the scrollable interface.
49
50If you wish to control the scrolling behaviour using these functions,
51inherit both the widget class and the
52:py:class:`~efl.elementary.scroller.Scrollable` class
53using multiple inheritance, for example::
54
55 class ScrollableGenlist(Genlist, Scrollable):
56 def __init__(self, canvas, *args, **kwargs):
57 Genlist.__init__(self, canvas)
58
59
60Inheritance diagram
61===================
62
63.. inheritance-diagram:: efl.elementary.Diskselector
64 :parts: 2
65
66
67.. autoclass:: efl.elementary.Diskselector
68.. autoclass:: efl.elementary.DiskselectorItem
diff --git a/doc/elementary/elementary.rst b/doc/elementary/elementary.rst
index 657598f..c4030ac 100644
--- a/doc/elementary/elementary.rst
+++ b/doc/elementary/elementary.rst
@@ -1,3 +1,4 @@
1.. module:: efl.elementary
1 2
2Elementary 3Elementary
3########## 4##########
@@ -51,11 +52,44 @@ A sample Python Elementary program
51API Reference 52API Reference
52============= 53=============
53 54
55.. autofunction:: init
56.. autofunction:: shutdown
57.. autofunction:: run
58.. autofunction:: exit
59
60.. autofunction:: on_ethumb_connect
61.. autofunction:: on_config_all_changed
62.. autofunction:: on_policy_changed
63
64.. autofunction:: on_process_background
65.. autofunction:: on_process_background
66
67.. autofunction:: on_sys_notify_notification_closed
68.. autofunction:: on_sys_notify_action_invoked
69
70.. autofunction:: policy_set
71.. autofunction:: policy_get
72.. autofunction:: process_state_get
73.. autofunction:: coords_finger_size_adjust
74
75.. autofunction:: language_set
76.. autofunction:: cache_all_flush
77.. autofunction:: font_properties_get
78.. autofunction:: font_properties_free
79
80.. autofunction:: font_fontconfig_name_get
81.. autofunction:: object_tree_dump
82.. autofunction:: object_tree_dot_dump
83
84.. autofunction:: sys_notify_close
85.. autofunction:: sys_notify_send
86
54.. toctree:: * 87.. toctree:: *
55 :glob: 88 :glob:
56 :maxdepth: 1 89 :maxdepth: 1
57 90
58 91
92
59Inheritance diagram 93Inheritance diagram
60=================== 94===================
61 95
diff --git a/doc/elementary/entry.rst b/doc/elementary/entry.rst
index bd5ba13..b279d00 100644
--- a/doc/elementary/entry.rst
+++ b/doc/elementary/entry.rst
@@ -1,2 +1,590 @@
1Entry
2#####
1 3
2.. automodule:: efl.elementary.entry 4.. image:: /images/entry-preview.png
5
6
7Widget description
8==================
9
10An entry is a convenience widget which shows a box that the user can
11enter text into.
12
13Entries by default don't scroll, so they grow to accommodate the entire text,
14resizing the parent window as needed. This can be changed with the property
15:py:attr:`~efl.elementary.entry.Entry.scrollable`.
16
17They can also be single line or multi line (the default) and when set
18to multi line mode they support text wrapping in any of the modes
19indicated by :ref:`Elm_Entry_Wrap_Type`.
20
21Other features include password mode, filtering of inserted text with
22:py:meth:`~efl.elementary.entry.Entry.markup_filter_append` and related
23functions, inline "items" and formatted markup text.
24
25
26Scrollable Interface
27====================
28
29This widget supports the scrollable interface.
30
31If you wish to control the scolling behaviour using these functions,
32inherit both the widget class and the
33:py:class:`~efl.elementary.scroller.Scrollable` class
34using multiple inheritance, for example::
35
36 class ScrollableGenlist(Genlist, Scrollable):
37 def __init__(self, canvas, *args, **kwargs):
38 Genlist.__init__(self, canvas)
39
40
41Formatted text
42==============
43
44The markup tags supported by the Entry are defined by the theme, but
45even when writing new themes or extensions it's a good idea to stick to
46a sane default, to maintain coherency and avoid application breakages.
47Currently defined by the default theme are the following tags:
48
49``<br>``
50 Inserts a line break.
51``<ps>``
52 Inserts a paragraph separator. This is preferred over line
53 breaks.
54``<tab>``
55 Inserts a tab.
56``<em>...</em>``
57 Emphasis. Sets the *oblique* style for the
58 enclosed text.
59``<b>...</b>``
60 Sets the **bold** style for the enclosed text.
61``<link>...</link>``
62 Underlines the enclosed text.
63``<hilight>...</hilight>``
64 Highlights the enclosed text.
65
66
67Special markups
68===============
69
70Besides those used to format text, entries support two special markup
71tags used to insert click-able portions of text or items inlined within
72the text.
73
74
75Anchors
76-------
77
78Anchors are similar to HTML anchors. Text can be surrounded by <a> and
79</a> tags and an event will be generated when this text is clicked,
80like this::
81
82 This text is outside <a href=anc-01>but this one is an anchor</a>
83
84The ``href`` attribute in the opening tag gives the name that will be
85used to identify the anchor and it can be any valid utf8 string.
86
87When an anchor is clicked, an ``"anchor,clicked"`` signal is emitted with
88an :py:class:`EntryAnchorInfo` in the ``event_info`` parameter for the
89callback function. The same applies for ``anchor,in`` (mouse in),
90``anchor,out`` (mouse out), ``anchor,down`` (mouse down), and ``anchor,up``
91(mouse up) events on an anchor.
92
93
94Items
95-----
96
97Inlined in the text, any other :py:class:`~efl.elementary.object.Object` can
98be inserted by using ``<item>`` tags this way::
99
100 <item size=16x16 vsize=full href=emoticon/haha></item>
101
102Just like with anchors, the ``href`` identifies each item, but these need,
103in addition, to indicate their size, which is done using any one of
104``size``, ``absize`` or ``relsize`` attributes. These attributes take their
105value in the WxH format, where W is the width and H the height of the
106item.
107
108- absize: Absolute pixel size for the item. Whatever value is set will
109 be the item's size regardless of any scale value the object may have
110 been set to. The final line height will be adjusted to fit larger items.
111- size: Similar to *absize*, but it's adjusted to the scale value set
112 for the object.
113- relsize: Size is adjusted for the item to fit within the current
114 line height.
115
116Besides their size, items are specified a ``vsize`` value that affects
117how their final size and position are calculated. The possible values
118are:
119
120- ``ascent``: Item will be placed within the line's baseline and its
121 ascent. That is, the height between the line where all characters are
122 positioned and the highest point in the line. For ``size`` and
123 ``absize`` items, the descent value will be added to the total line
124 height to make them fit. ``relsize`` items will be adjusted to fit
125 within this space.
126- ``full``: Items will be placed between the descent and ascent, or the
127 lowest point in the line and its highest.
128
129After the size for an item is calculated, the entry will request an object to
130place in its space. For this, the functions set with
131:py:meth:`~efl.elementary.entry.Entry.item_provider_append` and related
132functions will be called in order until one of them returns a non-*None* value.
133If no providers are available, or all of them return *None*, then the entry
134falls back to one of the internal defaults, provided the name matches with one
135of them.
136
137All of the following are currently supported:
138
139- emoticon/angry
140- emoticon/angry-shout
141- emoticon/crazy-laugh
142- emoticon/evil-laugh
143- emoticon/evil
144- emoticon/goggle-smile
145- emoticon/grumpy
146- emoticon/grumpy-smile
147- emoticon/guilty
148- emoticon/guilty-smile
149- emoticon/haha
150- emoticon/half-smile
151- emoticon/happy-panting
152- emoticon/happy
153- emoticon/indifferent
154- emoticon/kiss
155- emoticon/knowing-grin
156- emoticon/laugh
157- emoticon/little-bit-sorry
158- emoticon/love-lots
159- emoticon/love
160- emoticon/minimal-smile
161- emoticon/not-happy
162- emoticon/not-impressed
163- emoticon/omg
164- emoticon/opensmile
165- emoticon/smile
166- emoticon/sorry
167- emoticon/squint-laugh
168- emoticon/surprised
169- emoticon/suspicious
170- emoticon/tongue-dangling
171- emoticon/tongue-poke
172- emoticon/uh
173- emoticon/unhappy
174- emoticon/very-sorry
175- emoticon/what
176- emoticon/wink
177- emoticon/worried
178- emoticon/wtf
179
180Alternatively, an item may reference an image by its path, using
181the URI form ``file:///path/to/an/image.png`` and the entry will then
182use that image for the item.
183
184
185Setting entry's style
186=====================
187
188There are 2 major ways to change the entry's style:
189
190- Theme - set the "base" field to the desired style.
191- User style - Pushing overrides to the theme style to the textblock object
192 by using :py:meth:`~efl.elementary.entry.Entry.text_style_user_push`.
193
194You should modify the theme when you would like to change the style for
195aesthetic reasons. While the user style should be changed when you would
196like to change the style to something specific defined at run-time, e.g,
197setting font or font size in a text editor.
198
199
200Loading and saving files
201========================
202
203Entries have convenience functions to load text from a file and save changes
204back to it after a short delay. The automatic saving is enabled by default, but
205can be disabled with :py:attr:`~efl.elementary.entry.Entry.autosave` and files
206can be loaded directly as plain text or have any markup in them recognized. See
207:py:attr:`~efl.elementary.entry.Entry.file` for more details.
208
209
210Emitted signals
211===============
212
213- ``changed``: The text within the entry was changed.
214- ``changed,user``: The text within the entry was changed because of user
215 interaction.
216- ``activated``: The enter key was pressed on a single line entry.
217- ``aborted``: The escape key was pressed on a single line entry. (since 1.7)
218- ``press``: A mouse button has been pressed on the entry.
219- ``longpressed``: A mouse button has been pressed and held for a couple
220 seconds.
221- ``clicked``: The entry has been clicked (mouse press and release).
222- ``clicked,double``: The entry has been double clicked.
223- ``clicked,triple``: The entry has been triple clicked.
224- ``focused``: The entry has received focus.
225- ``unfocused``: The entry has lost focus.
226- ``selection,paste``: A paste of the clipboard contents was requested.
227- ``selection,copy``: A copy of the selected text into the clipboard was
228 requested.
229- ``selection,cut``: A cut of the selected text into the clipboard was
230 requested.
231- ``selection,start``: A selection has begun and no previous selection
232 existed.
233- ``selection,changed``: The current selection has changed.
234- ``selection,cleared``: The current selection has been cleared.
235- ``cursor,changed``: The cursor has changed position.
236- ``anchor,clicked``: An anchor has been clicked. The event_info
237 parameter for the callback will be an :py:class:`EntryAnchorInfo`.
238- ``anchor,in``: Mouse cursor has moved into an anchor. The event_info
239 parameter for the callback will be an :py:class:`EntryAnchorInfo`.
240- ``anchor,out``: Mouse cursor has moved out of an anchor. The event_info
241 parameter for the callback will be an :py:class:`EntryAnchorInfo`.
242- ``anchor,up``: Mouse button has been unpressed on an anchor. The event_info
243 parameter for the callback will be an :py:class:`EntryAnchorInfo`.
244- ``anchor,down``: Mouse button has been pressed on an anchor. The event_info
245 parameter for the callback will be an :py:class:`EntryAnchorInfo`.
246- ``preedit,changed``: The preedit string has changed.
247- ``language,changed``: Program language changed.
248- ``text,set,done``: Whole text has been set to the entry.
249- ``rejected``: .Called when some of inputs are rejected by the filter. (since 1.9)
250
251
252Layout content parts
253====================
254
255- ``icon`` - An icon in the entry
256- ``end`` - A content in the end of the entry
257
258
259Layout text parts
260=================
261
262- ``default`` - text of the entry
263- ``guide`` - placeholder of the entry
264
265
266Enumerations
267============
268
269.. _Elm_Entry_Autocapital_Type:
270
271Autocapitalization types
272------------------------
273
274.. data:: ELM_AUTOCAPITAL_TYPE_NONE
275
276 No auto-capitalization when typing
277
278.. data:: ELM_AUTOCAPITAL_TYPE_WORD
279
280 Autocapitalize each word typed
281
282.. data:: ELM_AUTOCAPITAL_TYPE_SENTENCE
283
284 Autocapitalize the start of each sentence
285
286.. data:: ELM_AUTOCAPITAL_TYPE_ALLCHARACTER
287
288 Autocapitalize all letters
289
290
291.. _Elm_Entry_Cnp_Mode:
292
293Copy & paste modes
294------------------
295
296.. data:: ELM_CNP_MODE_MARKUP
297
298 Copy & paste text with markup tags
299
300.. data:: ELM_CNP_MODE_NO_IMAGE
301
302 Copy & paste text without item (image) tags
303
304.. data:: ELM_CNP_MODE_PLAINTEXT
305
306 Copy & paste text without markup tags
307
308
309.. _Elm_Input_Hints:
310
311Input Hints
312-----------
313
314.. data:: ELM_INPUT_HINT_NONE
315
316 No active hints
317
318 .. versionadded:: 1.12
319
320.. data:: ELM_INPUT_HINT_AUTO_COMPLETE
321
322 Suggest word auto completion
323
324 .. versionadded:: 1.12
325
326.. data:: ELM_INPUT_HINT_SENSITIVE_DATA
327
328 typed text should not be stored
329
330 .. versionadded:: 1.12
331
332
333.. _Elm_Entry_Input_Panel_Lang:
334
335Input panel language sort order
336-------------------------------
337
338.. data:: ELM_INPUT_PANEL_LANG_AUTOMATIC
339
340 Automatic
341
342.. data:: ELM_INPUT_PANEL_LANG_ALPHABET
343
344 Alphabetic
345
346
347.. _Elm_Entry_Input_Panel_Layout:
348
349Input panel layouts
350-------------------
351
352.. data:: ELM_INPUT_PANEL_LAYOUT_NORMAL
353
354 Default layout
355
356.. data:: ELM_INPUT_PANEL_LAYOUT_NUMBER
357
358 Number layout
359
360.. data:: ELM_INPUT_PANEL_LAYOUT_EMAIL
361
362 Email layout
363
364.. data:: ELM_INPUT_PANEL_LAYOUT_URL
365
366 URL layout
367
368.. data:: ELM_INPUT_PANEL_LAYOUT_PHONENUMBER
369
370 Phone number layout
371
372.. data:: ELM_INPUT_PANEL_LAYOUT_IP
373
374 IP layout
375
376.. data:: ELM_INPUT_PANEL_LAYOUT_MONTH
377
378 Month layout
379
380.. data:: ELM_INPUT_PANEL_LAYOUT_NUMBERONLY
381
382 Number only layout
383
384.. data:: ELM_INPUT_PANEL_LAYOUT_INVALID
385
386 Never use this
387
388.. data:: ELM_INPUT_PANEL_LAYOUT_HEX
389
390 Hexadecimal layout
391
392.. data:: ELM_INPUT_PANEL_LAYOUT_TERMINAL
393
394 Command-line terminal layout
395
396.. data:: ELM_INPUT_PANEL_LAYOUT_PASSWORD
397
398 Like normal, but no auto-correct, no auto-capitalization etc.
399
400.. data:: ELM_INPUT_PANEL_LAYOUT_DATETIME
401
402 Date and time layout
403
404 .. versionadded:: 1.10
405
406.. data:: ELM_INPUT_PANEL_LAYOUT_EMOTICON
407
408 Emoticon layout
409
410 .. versionadded:: 1.10
411
412
413.. _Elm_Input_Panel_Layout_Normal_Variation:
414
415Input panel normal layout variation
416-----------------------------------
417
418.. data:: ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_NORMAL
419
420 The plain normal layout
421
422 .. versionadded:: 1.12
423
424.. data:: ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_FILENAME
425
426 Filename layout. Symbols such as '/' should be disabled
427
428 .. versionadded:: 1.12
429
430.. data:: ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_PERSON_NAME
431
432 The name of a person
433
434 .. versionadded:: 1.12
435
436
437.. _Elm_Input_Panel_Layout_Numberonly_Variation:
438
439Input panel numberonly layout variation
440---------------------------------------
441
442.. data:: ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_NORMAL
443
444 The numberonly normal layout
445
446 .. versionadded:: 1.12
447
448.. data:: ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED
449
450 The signed number layout
451
452 .. versionadded:: 1.12
453
454.. data:: ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_DECIMAL
455
456 The decimal number layout
457
458 .. versionadded:: 1.12
459
460.. data:: ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED_AND_DECIMAL
461
462 The signed and decimal number layout
463
464 .. versionadded:: 1.12
465
466
467.. _Elm_Input_Panel_Layout_Password_Variation:
468
469Input panel password layout variation
470-------------------------------------
471
472.. data:: ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NORMAL
473
474 The normal password layout
475
476 .. versionadded:: 1.12
477
478.. data:: ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NUMBERONLY
479
480 The password layout to allow only number
481
482 .. versionadded:: 1.12
483
484
485.. _Elm_Entry_Input_Panel_Return_Key_Type:
486
487Input panel return key modes
488----------------------------
489
490.. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT
491
492 Default
493
494.. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_DONE
495
496 Done
497
498.. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_GO
499
500 Go
501
502.. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_JOIN
503
504 Join
505
506.. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN
507
508 Login
509
510.. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_NEXT
511
512 Next
513
514.. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH
515
516 Search
517
518.. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEND
519
520 Send
521
522.. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_SIGNIN
523
524 Sign-in
525
526 .. versionadded:: 1.10
527
528
529.. _Elm_Entry_Text_Format:
530
531Text format
532-----------
533
534.. data:: ELM_TEXT_FORMAT_PLAIN_UTF8
535
536 Plain UTF-8 type
537
538.. data:: ELM_TEXT_FORMAT_MARKUP_UTF8
539
540 UTF-8 with markup
541
542
543.. _Elm_Entry_Wrap_Type:
544
545Wrap mode
546---------
547
548.. data:: ELM_WRAP_NONE
549
550 No wrap
551
552.. data:: ELM_WRAP_CHAR
553
554 Wrap between characters
555
556.. data:: ELM_WRAP_WORD
557
558 Wrap in allowed wrapping points (as defined in the unicode standard)
559
560.. data:: ELM_WRAP_MIXED
561
562 Word wrap, and if that fails, char wrap
563
564
565.. _Elm_Entry_Icon_Type:
566
567Icon types
568----------
569
570.. data:: ELM_ICON_NONE
571
572 No icon
573
574.. data:: ELM_ICON_FILE
575
576 Icon is a file
577
578.. data:: ELM_ICON_STANDARD
579
580 Icon is set with standards names
581
582
583Inheritance diagram
584===================
585
586.. inheritance-diagram:: efl.elementary.Entry
587 :parts: 2
588
589
590.. autoclass:: efl.elementary.Entry
diff --git a/doc/elementary/fileselector.rst b/doc/elementary/fileselector.rst
index 00ddcf4..bf3d2e9 100644
--- a/doc/elementary/fileselector.rst
+++ b/doc/elementary/fileselector.rst
@@ -1,2 +1,135 @@
1Fileselector
2############
1 3
2.. automodule:: efl.elementary.fileselector 4.. image:: /images/fileselector-preview.png
5
6
7Widget description
8==================
9
10A file selector is a widget that allows a user to navigate through a
11file system, reporting file selections back via its API.
12
13It contains shortcut buttons for home directory (*~*) and to jump one
14directory upwards (..), as well as cancel/ok buttons to confirm/cancel a
15given selection. After either one of those two former actions, the file
16selector will issue its ``"done"`` smart callback.
17
18There's a text entry on it, too, showing the name of the current
19selection. There's the possibility of making it editable, so it is
20useful on file saving dialogs on applications, where one gives a file
21name to save contents to, in a given directory in the system. This
22custom file name will be reported on the ``"done"`` smart callback
23(explained in sequence).
24
25Finally, it has a view to display file system items into in two possible
26forms:
27
28- list
29- grid
30
31If Elementary is built with support of the Ethumb thumbnailing library,
32the second form of view will display preview thumbnails of files which
33it supports.
34
35
36Emitted signals
37===============
38
39- ``activated`` - the user activated a file. This can happen by
40 double-clicking or pressing Enter key. (**event_info** is a string with the
41 activated file path)
42- ``selected`` - the user has clicked on a file (when not in folders-only
43 mode) or directory (when in folders-only mode)
44- ``directory,open`` - the list has been populated with new content
45 (*event_info* is the directory's path)
46- ``done`` - the user has clicked on the "ok" or "cancel"
47 buttons (*event_info* is the selection's path)
48
49
50Layout text parts
51=================
52
53- ``ok`` - OK button label if the ok button is set. (since 1.8)
54- ``cancel`` - Cancel button label if the cancel button is set. (since 1.8)
55
56
57Enumerations
58============
59
60.. _Elm_Fileselector_Mode:
61
62Fileselector modes
63------------------
64
65.. data:: ELM_FILESELECTOR_LIST
66
67 Layout as a list
68
69.. data:: ELM_FILESELECTOR_GRID
70
71 Layout as a grid
72
73
74.. _Elm_Fileselector_Sort:
75
76Fileselector sort method
77------------------------
78
79.. data:: ELM_FILESELECTOR_SORT_BY_FILENAME_ASC
80
81 Sort by filename in ascending order
82
83 .. versionadded:: 1.9
84
85.. data:: ELM_FILESELECTOR_SORT_BY_FILENAME_DESC
86
87 Sort by filename in descending order
88
89 .. versionadded:: 1.9
90
91.. data:: ELM_FILESELECTOR_SORT_BY_TYPE_ASC
92
93 Sort by file type in ascending order
94
95 .. versionadded:: 1.9
96
97.. data:: ELM_FILESELECTOR_SORT_BY_TYPE_DESC
98
99 Sort by file type in descending order
100
101 .. versionadded:: 1.9
102
103.. data:: ELM_FILESELECTOR_SORT_BY_SIZE_ASC
104
105 Sort by file size in ascending order
106
107 .. versionadded:: 1.9
108
109.. data:: ELM_FILESELECTOR_SORT_BY_SIZE_DESC
110
111 Sort by file size in descending order
112
113 .. versionadded:: 1.9
114
115.. data:: ELM_FILESELECTOR_SORT_BY_MODIFIED_ASC
116
117 Sort by file modification date in ascending order
118
119 .. versionadded:: 1.9
120
121.. data:: ELM_FILESELECTOR_SORT_BY_MODIFIED_DESC
122
123 Sort by file modification date in descending order
124
125 .. versionadded:: 1.9
126
127
128Inheritance diagram
129===================
130
131.. inheritance-diagram:: efl.elementary.Fileselector
132 :parts: 2
133
134
135.. autoclass:: efl.elementary.Fileselector
diff --git a/doc/elementary/fileselector_button.rst b/doc/elementary/fileselector_button.rst
index b2566b7..179ee66 100644
--- a/doc/elementary/fileselector_button.rst
+++ b/doc/elementary/fileselector_button.rst
@@ -1,2 +1,73 @@
1Fileselector Button
2###################
1 3
2.. automodule:: efl.elementary.fileselector_button 4.. image:: /images/fileselector-button-preview.png
5
6
7Widget description
8==================
9
10This is a button that, when clicked, creates an Elementary window (or
11inner window) with a :py:class:`~efl.elementary.fileselector.Fileselector`
12within.
13
14When a file is chosen, the (inner) window is closed and the button emits
15a signal having the selected file as it's ``event_info``.
16
17This widget encapsulates operations on its internal file selector on its
18own API. There is less control over its file selector than that one
19would have instantiating one directly.
20
21
22Available styles
23================
24
25- ``default``
26- ``anchor``
27- ``hoversel_vertical``
28- ``hoversel_vertical_entry``
29
30
31Emitted signals
32===============
33
34- ``file,chosen`` - the user has selected a path which comes as the
35 ``event_info`` data
36- ``language,changed`` - the program's language changed
37
38
39Layout text parts
40=================
41
42- ``default`` - Label of the fileselector_button
43
44
45Layout content parts
46====================
47
48- ``icon`` - Icon of the fileselector_button
49
50
51Fileselector Interface
52======================
53
54This widget supports the fileselector interface.
55
56If you wish to control the fileselector part using these functions,
57inherit both the widget class and the
58:py:class:`~efl.elementary.fileselector.Fileselector` class
59using multiple inheritance, for example::
60
61 class CustomFileselectorButton(Fileselector, FileselectorButton):
62 def __init__(self, canvas, *args, **kwargs):
63 FileselectorButton.__init__(self, canvas)
64
65
66Inheritance diagram
67===================
68
69.. inheritance-diagram:: efl.elementary.FileselectorButton
70 :parts: 2
71
72
73.. autoclass:: efl.elementary.FileselectorButton
diff --git a/doc/elementary/fileselector_entry.rst b/doc/elementary/fileselector_entry.rst
index 8479474..14344b1 100644
--- a/doc/elementary/fileselector_entry.rst
+++ b/doc/elementary/fileselector_entry.rst
@@ -1,2 +1,88 @@
1Fileselector Entry
2##################
1 3
2.. automodule:: efl.elementary.fileselector_entry 4.. image:: /images/fileselector-entry-preview.png
5
6
7Widget description
8==================
9
10This is an entry made to be filled with or display a file
11system path string.
12
13Besides the entry itself, the widget has a
14:py:class:`~efl.elementary.fileselector_button.FileselectorButton` on its side,
15which will raise an internal
16:py:class:`~efl.elementary.fileselector.Fileselector`, when clicked, for path
17selection aided by file system navigation.
18
19This file selector may appear in an Elementary window or in an
20inner window. When a file is chosen from it, the (inner) window
21is closed and the selected file's path string is exposed both as
22a smart event and as the new text on the entry.
23
24This widget encapsulates operations on its internal file
25selector on its own API. There is less control over its file
26selector than that one would have instantiating one directly.
27
28
29Emitted signals
30===============
31
32- ``changed`` - The text within the entry was changed
33- ``activated`` - The entry has had editing finished and
34 changes are to be "committed"
35- ``press`` - The entry has been clicked
36- ``longpressed`` - The entry has been clicked (and held) for a
37 couple seconds
38- ``clicked`` - The entry has been clicked
39- ``clicked,double`` - The entry has been double clicked
40- ``focused`` - The entry has received focus
41- ``unfocused`` - The entry has lost focus
42- ``selection,paste`` - A paste action has occurred on the
43 entry
44- ``selection,copy`` - A copy action has occurred on the entry
45- ``selection,cut`` - A cut action has occurred on the entry
46- ``unpressed`` - The file selector entry's button was released
47 after being pressed.
48- ``file,chosen`` - The user has selected a path via the file
49 selector entry's internal file selector, whose string
50 comes as the ``event_info`` data.
51- ``language,changed`` - the program's language changed
52
53
54Layout text parts
55=================
56
57- ``default`` - Label of the fileselector_button
58
59
60Layout content parts
61====================
62
63- ``button icon`` - Button icon of the fileselector_entry
64
65
66Fileselector Interface
67======================
68
69This widget supports the fileselector interface.
70
71If you wish to control the fileselector part using these functions,
72inherit both the widget class and the
73:py:class:`~efl.elementary.fileselector.Fileselector` class
74using multiple inheritance, for example::
75
76 class CustomFileselectorButton(Fileselector, FileselectorButton):
77 def __init__(self, canvas, *args, **kwargs):
78 FileselectorButton.__init__(self, canvas)
79
80
81Inheritance diagram
82===================
83
84.. inheritance-diagram:: efl.elementary.FileselectorEntry
85 :parts: 2
86
87
88.. autoclass:: efl.elementary.FileselectorEntry
diff --git a/doc/elementary/flip.rst b/doc/elementary/flip.rst
index 0644602..08c87a4 100644
--- a/doc/elementary/flip.rst
+++ b/doc/elementary/flip.rst
@@ -1,2 +1,162 @@
1Flip
2####
1 3
2.. automodule:: efl.elementary.flip 4.. image:: /images/flip-preview.png
5
6
7Widget description
8==================
9
10This widget holds two content :py:class:`efl.evas.Object`: one on
11the front and one on the back. It allows you to flip from front to back
12and vice-versa using various animations.
13
14If either the front or back contents are not set the flip will treat that
15as transparent. So if you were to set the front content but not the back,
16and then call :py:meth:`Flip.go` you would see whatever is below the flip.
17
18For a list of supported animations see :py:meth:`Flip.go`.
19
20
21Emitted signals
22===============
23
24- ``animate,begin`` - when a flip animation was started
25- ``animate,done`` - when a flip animation is finished
26
27
28Layout content parts
29====================
30
31- ``front`` - A front content of the flip
32- ``back`` - A back content of the flip
33
34
35Enumerations
36============
37
38.. _Elm_Flip_Direction:
39
40Flip directions
41---------------
42
43.. data:: ELM_FLIP_DIRECTION_UP
44
45 Allows interaction with the top of the widget.
46
47.. data:: ELM_FLIP_DIRECTION_DOWN
48
49 Allows interaction with the bottom of the widget.
50
51.. data:: ELM_FLIP_DIRECTION_LEFT
52
53 Allows interaction with the left portion of
54
55 the widget.
56.. data:: ELM_FLIP_DIRECTION_RIGHT
57
58 Allows interaction with the right portion of
59
60 the widget.
61
62
63.. _Elm_Flip_Interaction:
64
65Flip interaction modes
66----------------------
67
68.. data:: ELM_FLIP_INTERACTION_NONE
69
70 No interaction is allowed
71
72.. data:: ELM_FLIP_INTERACTION_ROTATE
73
74 Interaction will cause rotate animation
75
76.. data:: ELM_FLIP_INTERACTION_CUBE
77
78 Interaction will cause cube animation
79
80.. data:: ELM_FLIP_INTERACTION_PAGE
81
82 Interaction will cause page animation
83
84
85.. _Elm_Flip_Mode:
86
87Flip types
88----------
89
90.. data:: ELM_FLIP_ROTATE_Y_CENTER_AXIS
91
92 Rotate the currently visible content around a vertical axis in the
93 middle of its width, the other content is shown as the other side of the
94 flip.
95
96.. data:: ELM_FLIP_ROTATE_X_CENTER_AXIS
97
98 Rotate the currently visible content around a horizontal axis in the
99 middle of its height, the other content is shown as the other side of
100 the flip.
101
102.. data:: ELM_FLIP_ROTATE_XZ_CENTER_AXIS
103
104 Rotate the currently visible content around a diagonal axis in the
105 middle of its width, the other content is shown as the other side of the
106 flip.
107
108.. data:: ELM_FLIP_ROTATE_YZ_CENTER_AXIS
109
110 Rotate the currently visible content around a diagonal axis in the
111 middle of its height, the other content is shown as the other side of
112 the flip.
113
114.. data:: ELM_FLIP_CUBE_LEFT
115
116 Rotate the currently visible content to the left as if the flip was a
117 cube, the other content is show as the right face of the cube.
118
119.. data:: ELM_FLIP_CUBE_RIGHT
120
121 Rotate the currently visible content to the right as if the flip was a
122 cube, the other content is show as the left face of the cube.
123
124.. data:: ELM_FLIP_CUBE_UP
125
126 Rotate the currently visible content up as if the flip was a cube, the
127 other content is show as the bottom face of the cube.
128
129.. data:: ELM_FLIP_CUBE_DOWN
130
131 Rotate the currently visible content down as if the flip was a cube, the
132 other content is show as the upper face of the cube.
133
134.. data:: ELM_FLIP_PAGE_LEFT
135
136 Move the currently visible content to the left as if the flip was a
137 book, the other content is shown as the page below that.
138
139.. data:: ELM_FLIP_PAGE_RIGHT
140
141 Move the currently visible content to the right as if the flip was a
142 book, the other content is shown as the page below that.
143
144.. data:: ELM_FLIP_PAGE_UP
145
146 Move the currently visible content up as if the flip was a book, the
147 other content is shown as the page below that.
148
149.. data:: ELM_FLIP_PAGE_DOWN
150
151 Move the currently visible content down as if the flip was a book, the
152 other content is shown as the page below that.
153
154
155Inheritance diagram
156===================
157
158.. inheritance-diagram:: efl.elementary.Flip
159 :parts: 2
160
161
162.. autoclass:: efl.elementary.Flip
diff --git a/doc/elementary/flipselector.rst b/doc/elementary/flipselector.rst
index 0bf5cf1..1288595 100644
--- a/doc/elementary/flipselector.rst
+++ b/doc/elementary/flipselector.rst
@@ -1,2 +1,48 @@
1Flipselector
2############
1 3
2.. automodule:: efl.elementary.flipselector 4.. image:: /images/flipselector-preview.png
5
6
7Widget description
8==================
9
10A flip selector is a widget to show a set of *text* items, one at a time, with
11the same sheet switching style as the :py:class:`~efl.elementary.clock.Clock`
12widget, when one changes the current displaying sheet (thus, the "flip" in the
13name).
14
15User clicks to flip sheets which are *held* for some time will
16make the flip selector to flip continuously and automatically for
17the user. The interval between flips will keep growing in time,
18so that it helps the user to reach an item which is distant from
19the current selection.
20
21
22Emitted signals
23===============
24
25- ``selected`` - when the widget's selected text item is changed
26- ``overflowed`` - when the widget's current selection is changed
27 from the first item in its list to the last
28- ``underflowed`` - when the widget's current selection is changed
29 from the last item in its list to the first
30- ``focused`` - When the flipselector has received focus. (since 1.8)
31- ``unfocused`` - When the flipselector has lost focus. (since 1.8)
32
33
34Layout text parts
35=================
36
37- ``default`` - label of the flipselector item
38
39
40Inheritance diagram
41===================
42
43.. inheritance-diagram:: efl.elementary.Flipselector
44 :parts: 2
45
46
47.. autoclass:: efl.elementary.FlipSelector
48.. autoclass:: efl.elementary.FlipSelectorItem
diff --git a/doc/elementary/frame.rst b/doc/elementary/frame.rst
index c87a2d2..72ae8e2 100644
--- a/doc/elementary/frame.rst
+++ b/doc/elementary/frame.rst
@@ -1,2 +1,52 @@
1Frame
2#####
1 3
2.. automodule:: efl.elementary.frame 4.. image:: /images/frame-preview.png
5
6
7Widget description
8==================
9
10Frame is a widget that holds some content and has a title.
11
12
13Available styles
14================
15
16- default
17- pad_small
18- pad_medium
19- pad_large
20- pad_huge
21- outdent_top
22- outdent_bottom
23
24Out of all these styles only default shows the title.
25
26
27Emitted signals
28===============
29
30- ``clicked`` - The user has clicked the frame's label
31
32
33Layout content parts
34====================
35
36- ``default`` - A content of the frame
37
38
39Layout text parts
40=================
41
42- ``default`` - Label of the frame
43
44
45Inheritance diagram
46===================
47
48.. inheritance-diagram:: efl.elementary.Frame
49 :parts: 2
50
51
52.. autoclass:: efl.elementary.Frame
diff --git a/doc/elementary/general.rst b/doc/elementary/general.rst
deleted file mode 100644
index 949970f..0000000
--- a/doc/elementary/general.rst
+++ /dev/null
@@ -1,2 +0,0 @@
1
2.. automodule:: efl.elementary.general
diff --git a/doc/elementary/gengrid.rst b/doc/elementary/gengrid.rst
index d2e5c2e..b14bdce 100644
--- a/doc/elementary/gengrid.rst
+++ b/doc/elementary/gengrid.rst
@@ -1,2 +1,324 @@
1Gengrid
2#######
1 3
2.. automodule:: efl.elementary.gengrid 4.. image:: /images/gengrid-preview.png
5
6
7Widget description
8==================
9
10This widget aims to position objects in a grid layout while actually
11creating and rendering only the visible ones, using the same idea as the
12:py:class:`~efl.elementary.genlist.Genlist`: the user defines a **class** for
13each item, specifying functions that will be called at object creation,
14deletion, etc. When those items are selected by the user, a callback
15function is issued. Users may interact with a gengrid via the mouse (by
16clicking on items to select them and clicking on the grid's viewport and
17swiping to pan the whole view) or via the keyboard, navigating through
18item with the arrow keys.
19
20
21Scrollable Interface
22====================
23
24This widget supports the scrollable interface.
25
26If you wish to control the scolling behaviour using these functions,
27inherit both the widget class and the
28:py:class:`~efl.elementary.scroller.Scrollable` class
29using multiple inheritance, for example::
30
31 class ScrollableGenlist(Genlist, Scrollable):
32 def __init__(self, canvas, *args, **kwargs):
33 Genlist.__init__(self, canvas)
34
35
36Gengrid layouts
37===============
38
39Gengrid may layout its items in one of two possible layouts:
40
41- horizontal or
42- vertical.
43
44When in "horizontal mode", items will be placed in **columns**, from top
45to bottom and, when the space for a column is filled, another one is
46started on the right, thus expanding the grid horizontally, making for
47horizontal scrolling. When in "vertical mode" , though, items will be
48placed in **rows**, from left to right and, when the space for a row is
49filled, another one is started below, thus expanding the grid vertically
50(and making for vertical scrolling).
51
52
53Gengrid items
54=============
55
56An item in a gengrid can have 0 or more texts (they can be regular text
57or textblock Evas objects - that's up to the style to determine), 0 or
58more contents (which are simply objects swallowed into the gengrid
59item's theming Edje object) and 0 or more **boolean states**, which
60have the behavior left to the user to define. The Edje part names for
61each of these properties will be looked up, in the theme file for the
62gengrid, under the Edje (string) data items named ``"texts"``,
63``"contents"`` and ``"states"``, respectively. For each of those
64properties, if more than one part is provided, they must have names
65listed separated by spaces in the data fields. For the default gengrid
66item theme, we have **one** text part (``"elm.text"``), **two** content
67parts (``"elm.swalllow.icon"`` and ``"elm.swallow.end"``) and **no**
68state parts.
69
70A gengrid item may be at one of several styles. Elementary provides one
71by default - "default", but this can be extended by system or
72application custom themes/overlays/extensions (see
73:py:class:`~efl.elementary.theme.Theme` for more details).
74
75
76Gengrid item classes
77====================
78
79In order to have the ability to add and delete items on the fly, gengrid
80implements a class (callback) system where the application provides a
81structure with information about that type of item (gengrid may contain
82multiple different items with different classes, states and styles).
83Gengrid will call the functions in this struct (methods) when an item is
84"realized" (i.e., created dynamically, while the user is scrolling the
85grid). All objects will simply be deleted when no longer needed with
86:meth:`~efl.eo.Eo.delete`. The :class:`GengridItemClass` class contains the
87following attributes and methods:
88
89- ``item_style`` - This is a constant string and simply defines the name
90 of the item style. It **must** be specified and the default should be
91 ``default``.
92- ``func.text_get`` - This function is called when an item object is
93 actually created. The ``data`` parameter will point to the same data
94 passed to :meth:`~Gengrid.item_append` and related item creation
95 functions. The ``obj`` parameter is the gengrid object itself, while
96 the ``part`` one is the name string of one of the existing text parts
97 in the Edje group implementing the item's theme.
98 See :py:meth:`GengridItemClass.text_get`.
99- ``func.content_get`` - This function is called when an item object is
100 actually created. The ``data`` parameter will point to the same data
101 passed to :py:meth:`GengridItem.append_to` and related item creation
102 functions. The ``obj`` parameter is the gengrid object itself, while
103 the ``part`` one is the name string of one of the existing (content)
104 swallow parts in the Edje group implementing the item's theme. It must
105 return ``None,`` when no content is desired, or a valid object handle,
106 otherwise. The object will be deleted by the gengrid on its deletion
107 or when the item is "unrealized". See :py:meth:`GengridItemClass.content_get`.
108- ``func.state_get`` - This function is called when an item object is
109 actually created. The ``data`` parameter will point to the same data
110 passed to :py:meth:`GengridItem.append_to` and related item creation
111 functions. The ``obj`` parameter is the gengrid object itself, while
112 the ``part`` one is the name string of one of the state parts in the
113 Edje group implementing the item's theme. Return ``False`` for
114 false/off or ``True`` for true/on. Gengrids will emit a signal to
115 its theming Edje object with ``"elm,state,xxx,active"`` and ``"elm"``
116 as "emission" and "source" arguments, respectively, when the state is
117 true (the default is false), where ``xxx`` is the name of the (state)
118 part. See :py:meth:`GengridItemClass.state_get`.
119- ``func.del`` - This is called when
120 :meth:`efl.elementary.object_item.ObjectItem.delete` is called on
121 an item or :meth:`~Gengrid.clear` is called on the gengrid. This is
122 intended for use when gengrid items are deleted, so any data attached
123 to the item (e.g. its data parameter on creation) can be deleted. See
124 :py:meth:`GengridItemClass.delete`.
125
126
127Usage hints
128===========
129
130If the user wants to have multiple items selected at the same time,
131:attr:`~Gengrid.multi_select` will permit it. If the gengrid is
132single-selection only (the default), then :attr:`~Gengrid.selected_item`
133will return the selected item or ``None``, if none is selected. If the
134gengrid is under multi-selection, then :attr:`~Gengrid.selected_items`
135will return a list (that is only valid as long as no items are modified
136(added, deleted, selected or unselected) of child items on a gengrid.
137
138If an item changes (internal (boolean) state, text or content changes),
139then use :meth:`~GengridItem.update` to have gengrid update the item with
140the new state. A gengrid will re-"realize" the item, thus calling the
141functions in the :class:`GengridItemClass` set for that item.
142
143To programmatically (un)select an item or get the selected state, use
144:attr:`GengridItem.selected`. To make an item disabled (unable to be
145selected and appear differently) or get the disabled state
146use :attr:`GengridItem.disabled`.
147
148Grid cells will only have their selection smart callbacks called when
149firstly getting selected. Any further clicks will do nothing, unless you
150enable the "always select mode", with :attr:`~Gengrid.select_mode` as
151:attr:`ELM_OBJECT_SELECT_MODE_ALWAYS`, thus making every click to issue
152selection callbacks. :attr:`~Gengrid.select_mode` as
153:attr:`ELM_OBJECT_SELECT_MODE_NONE` will turn off the ability to select items
154entirely in the widget and they will neither appear selected nor call
155the selection smart callbacks.
156
157Remember that you can create new styles and add your own theme
158augmentation per application with
159:meth:`Theme.extension_add<efl.elementary.theme.Theme.extension_add>`. If you
160absolutely must have a specific style that overrides any theme the user
161or system sets up you can use
162:meth:`Theme.extension_add<efl.elementary.theme.Theme.overlay_add>` to add such
163a file.
164
165
166Emitted signals
167===============
168
169- ``activated`` - The user has double-clicked or pressed
170 (enter|return|spacebar) on an item. The ``event_info`` parameter
171 is the gengrid item that was activated.
172- ``clicked,double`` - The user has double-clicked an item.
173 The ``event_info`` parameter is the gengrid item that was double-clicked.
174- ``clicked,right`` - The user has right-clicked an item. The
175 ``event_info`` parameter is the item that was right-clicked. (since: 1.13)
176- ``longpressed`` - This is called when the item is pressed for a certain
177 amount of time. By default it's 1 second.
178- ``selected`` - The user has made an item selected. The
179 ``event_info`` parameter is the gengrid item that was selected.
180- ``unselected`` - The user has made an item unselected. The
181 ``event_info`` parameter is the gengrid item that was unselected.
182- ``realized`` - This is called when the item in the gengrid
183 has its implementing Evas object instantiated, de facto.
184 ``event_info`` is the gengrid item that was created.
185- ``unrealized`` - This is called when the implementing Evas
186 object for this item is deleted. ``event_info`` is the gengrid
187 item that was deleted.
188- ``changed`` - Called when an item is added, removed, resized
189 or moved and when the gengrid is resized or gets "horizontal"
190 property changes.
191- ``scroll,anim,start`` - This is called when scrolling animation has
192 started.
193- ``scroll,anim,stop`` - This is called when scrolling animation has
194 stopped.
195- ``drag,start,up`` - Called when the item in the gengrid has
196 been dragged (not scrolled) up.
197- ``drag,start,down`` - Called when the item in the gengrid has
198 been dragged (not scrolled) down.
199- ``drag,start,left`` - Called when the item in the gengrid has
200 been dragged (not scrolled) left.
201- ``drag,start,right`` - Called when the item in the gengrid has
202 been dragged (not scrolled) right.
203- ``drag,stop`` - Called when the item in the gengrid has
204 stopped being dragged.
205- ``drag`` - Called when the item in the gengrid is being
206 dragged.
207- ``scroll`` - called when the content has been scrolled
208 (moved).
209- ``scroll,drag,start`` - called when dragging the content has
210 started.
211- ``scroll,drag,stop`` - called when dragging the content has
212 stopped.
213- ``edge,top`` - This is called when the gengrid is scrolled until
214 the top edge.
215- ``edge,bottom`` - This is called when the gengrid is scrolled
216 until the bottom edge.
217- ``edge,left`` - This is called when the gengrid is scrolled
218 until the left edge.
219- ``edge,right`` - This is called when the gengrid is scrolled
220 until the right edge.
221- ``moved`` - This is called when a gengrid item is moved by a user
222 interaction in a reorder mode. The ``event_info`` parameter is the item that
223 was moved.
224- ``index,update`` - This is called when a gengrid item index is changed.
225 Note that this callback is called while each item is being realized.
226- ``highlighted`` - an item in the list is highlighted. This is called when
227 the user presses an item or keyboard selection is done so the item is
228 physically highlighted. The ``event_info`` parameter is the item that was
229 highlighted.
230- ``unhighlighted`` - an item in the list is unhighlighted. This is called
231 when the user releases an item or keyboard selection is moved so the item
232 is physically unhighlighted. The ``event_info`` parameter is the item that
233 was unhighlighted.
234- ``language,changed`` - This is called when the program's language is
235 changed. Call :meth:`~Gengrid.realized_items_update` if items text should
236 be translated.
237- ``focused`` - When the gengrid has received focus. (since 1.8)
238- ``unfocused`` - When the gengrid has lost focus. (since 1.8)
239- ``item,focused`` - When the gengrid item has received focus. (since 1.10)
240- ``item,unfocused`` - When the gengrid item has lost focus. (since 1.10)
241- ``item,reorder,anim,start`` - This is called when a gengrid item movement
242 has just started by keys in reorder mode. The parameter is the item that
243 is going to move. (since 1.10)
244- ``item,reorder,anim,stop`` - This is called when a gengrid item movement just
245 stopped in reorder mode. The parameter is the item that was moved. (since 1.10)
246
247
248Enumerations
249============
250
251.. _Elm_Gengrid_Item_Scrollto_Type:
252
253Items' scroll to types
254----------------------
255
256.. data:: ELM_GENLIST_ITEM_SCROLLTO_NONE
257
258 No scroll to
259
260.. data:: ELM_GENLIST_ITEM_SCROLLTO_IN
261
262 Scroll to the nearest viewport
263
264.. data:: ELM_GENLIST_ITEM_SCROLLTO_TOP
265
266 Scroll to the top of viewport
267
268.. data:: ELM_GENLIST_ITEM_SCROLLTO_MIDDLE
269
270 Scroll to the middle of viewport
271
272
273.. _Elm_Gengrid_Object_Multi_Select_Mode:
274
275Multi-select mode
276-----------------
277
278.. data:: ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT
279
280 Default multiple select mode
281
282 .. versionadded:: 1.10
283
284.. data:: ELM_OBJECT_MULTI_SELECT_MODE_WITH_CONTROL
285
286 Disallow mutiple selection when clicked without control key pressed
287
288 .. versionadded:: 1.10
289
290.. data:: ELM_OBJECT_MULTI_SELECT_MODE_MAX
291
292 Value unknown
293
294 .. versionadded:: 1.10
295
296
297.. _Elm_Gengrid_Reorder_Type:
298
299Reorder type
300------------
301
302.. data:: ELM_GENGRID_REORDER_TYPE_NORMAL
303
304 Normal reorder mode
305
306 .. versionadded:: 1.11
307
308.. data:: ELM_GENGRID_REORDER_TYPE_SWAP
309
310 Swap reorder mode
311
312 .. versionadded:: 1.11
313
314
315Inheritance diagram
316===================
317
318.. inheritance-diagram:: efl.elementary.Gengrid
319 :parts: 2
320
321
322.. autoclass:: efl.elementary.Gengrid
323.. autoclass:: efl.elementary.GengridItem
324.. autoclass:: efl.elementary.GengridItemClass
diff --git a/doc/elementary/genlist.rst b/doc/elementary/genlist.rst
index a2a583c..1034009 100644
--- a/doc/elementary/genlist.rst
+++ b/doc/elementary/genlist.rst
@@ -1,2 +1,512 @@
1Genlist
2#######
1 3
2.. automodule:: efl.elementary.genlist 4.. image:: /images/genlist-preview.png
5
6
7Widget description
8==================
9
10This widget aims to have more expansive list than the simple list in
11Elementary that could have more flexible items and allow many more
12entries while still being fast and low on memory usage. At the same time
13it was also made to be able to do tree structures. But the price to pay
14is more complexity when it comes to usage. If all you want is a simple
15list with icons and a single text, use the normal
16:py:class:`~efl.elementary.list.List` object.
17
18Genlist has a fairly large API, mostly because it's relatively complex,
19trying to be both expansive, powerful and efficient. First we will begin
20an overview on the theory behind genlist.
21
22
23Genlist item classes - creating items
24=====================================
25
26In order to have the ability to add and delete items on the fly, genlist
27implements a class (callback) system where the application provides a
28structure with information about that type of item (genlist may contain
29multiple different items with different classes, states and styles).
30Genlist will call the functions in this struct (methods) when an item is
31"realized" (i.e., created dynamically, while the user is scrolling the
32grid). All objects will simply be deleted when no longer needed with
33:py:meth:`~efl.evas.Object.delete`. :py:class:`GenlistItemClass` contains the
34following members:
35
36- ``item_style`` - This is a constant string and simply defines the name
37 of the item style. It **must** be specified and the default should be
38 ``"default".``
39- ``decorate_item_style`` - This is a constant string and simply defines
40 the name of the decorate mode item style. It is used to specify
41 decorate mode item style. It can be used when you call
42 :py:attr:`GenlistItem.decorate_mode`.
43- ``decorate_all_item_style`` - This is a constant string and simply
44 defines the name of the decorate all item style. It is used to specify
45 decorate all item style. It can be used to set selection, checking and
46 deletion mode. This is used when you call
47 :py:attr:`Genlist.decorate_mode`.
48- ``func`` - A struct with pointers to functions that will be called when
49 an item is going to be actually created. All of them receive a ``data``
50 parameter that will point to the same data passed to
51 :py:meth:`GenlistItem.append_to` and related item creation functions, and an
52 ``obj`` parameter that points to the genlist object itself.
53
54The function pointers inside ``func`` are ``text_get``, ``content_get``,
55``state_get`` and ``del``. The 3 first functions also receive a ``part``
56parameter described below. A brief description of these functions follows:
57
58- ``text_get`` - The ``part`` parameter is the name string of one of the
59 existing text parts in the Edje group implementing the item's theme.
60 See :py:meth:`GenlistItemClass.text_get`.
61- ``content_get`` - The ``part`` parameter is the name string of one of the
62 existing (content) swallow parts in the Edje group implementing the
63 item's theme. It must return ``None``, when no content is desired, or
64 a valid object handle, otherwise. The object will be deleted by the
65 genlist on its deletion or when the item is "unrealized". See
66 :py:meth:`GenlistItemClass.content_get`.
67- ``func.state_get`` - The ``part`` parameter is the name string of one of
68 the state parts in the Edje group implementing the item's theme. Return
69 ``False`` for false/off or ``True`` for true/on. Genlists will
70 emit a signal to its theming Edje object with ``"elm,state,xxx,active"``
71 and ``"elm"`` as "emission" and "source" arguments, respectively, when
72 the state is true (the default is false), where ``xxx`` is the name of
73 the (state) part. See :py:meth:`GenlistItemClass.state_get`.
74- ``func.del`` - This is intended for use when genlist items are deleted,
75 so any data attached to the item (e.g. its data parameter on creation)
76 can be deleted. See :py:meth:`GenlistItemClass.delete`.
77
78
79Available item styles
80=====================
81
82- ``default``
83- ``default_style`` The text part is a textblock
84- ``double_label`` Two different text parts
85- ``icon_top_text_bottom``
86- ``group_index``
87- ``one_icon`` Only 1 icon (left) (since: 1.1)
88- ``end_icon`` Only 1 icon (at end/right) (since: 1.1)
89- ``no_icon`` No icon (since: 1.1)
90- ``full`` Only one object, elm.swallow.content, which consumes whole area of
91 the genlist item (since: 1.7)
92
93
94Structure of items
95==================
96
97An item in a genlist can have 0 or more texts (they can be regular text
98or textblock Evas objects - that's up to the style to determine), 0 or
99more contents (which are simply objects swallowed into the genlist item's
100theming Edje object) and 0 or more **boolean states**, which have the
101behavior left to the user to define. The Edje part names for each of
102these properties will be looked up, in the theme file for the genlist,
103under the Edje (string) data items named ``labels``, ``contents``
104and ``states``, respectively. For each of those properties, if more
105than one part is provided, they must have names listed separated by
106spaces in the data fields. For the default genlist item theme, we have
107**one** text part (``elm.text``), **two** content parts
108(``elm.swallow.icon`` and ``elm.swallow.end``) and **no** state parts.
109
110A genlist item may be at one of several styles. Elementary provides one
111by default - "default", but this can be extended by system or application
112custom themes/overlays/extensions (see :py:mod:`themes<efl.elementary.theme>`)
113for more details).
114
115
116Editing and Navigating
117======================
118
119Items can be added by several calls. All of them return a
120:py:class:`GenlistItem` handle that is an internal member inside the genlist.
121They all take a data parameter that is meant to be used for a handle to the
122applications internal data (eg. the struct with the original item data). The
123parent parameter is the parent genlist item this belongs to if it is a tree or
124an indexed group, and None if there is no parent. The flags can be a bitmask of
125:attr:`ELM_GENLIST_ITEM_NONE`, :attr:`ELM_GENLIST_ITEM_TREE` and
126:attr:`ELM_GENLIST_ITEM_GROUP`. If :attr:`ELM_GENLIST_ITEM_TREE` is set then
127this item is displayed as an item that is able to expand and have child items.
128If :attr:`ELM_GENLIST_ITEM_GROUP` is set then this item is group index item
129that is displayed at the top until the next group comes. The func parameter is
130a convenience callback that is called when the item is selected and the data
131parameter will be the func_data parameter, ``obj`` be the genlist object and
132event_info will be the genlist item.
133
134:py:meth:`GenlistItem.append_to` adds an item to the end of the list, or if
135there is a parent, to the end of all the child items of the parent.
136:py:meth:`GenlistItem.prepend_to` is the same but adds to the beginning of
137the list or children list. :py:meth:`GenlistItem.insert_before` inserts at
138item before another item and :py:meth:`GenlistItem.insert_after` inserts after
139the indicated item.
140
141The application can clear the list with :py:meth:`Genlist.clear` which deletes
142all the items in the list and
143:py:meth:`~efl.elementary.object_item.ObjectItem.delete` will delete a specific
144item. :py:meth:`GenlistItem.subitems_clear` will clear all items that are
145children of the indicated parent item.
146
147To help inspect list items you can jump to the item at the top of the list
148with :py:attr:`Genlist.first_item` which will return the item pointer, and
149similarly :py:attr:`Genlist.last_item` gets the item at the end of the list.
150:py:attr:`GenlistItem.next` and :py:attr:`GenlistItem.prev` get the next
151and previous items respectively relative to the indicated item. Using
152these calls you can walk the entire item list/tree. Note that as a tree
153the items are flattened in the list, so :py:attr:`GenlistItem.parent` will
154let you know which item is the parent (and thus know how to skip them if
155wanted).
156
157
158Multi-selection
159===============
160
161If the application wants multiple items to be able to be selected,
162:py:attr:`Genlist.multi_select` can enable this. If the list is
163single-selection only (the default), then :py:attr:`Genlist.selected_item`
164will return the selected item, if any, or None if none is selected. If the
165list is multi-select then :py:attr:`Genlist.selected_items` will return a
166list (that is only valid as long as no items are modified (added, deleted,
167selected or unselected)).
168
169
170Usage hints
171===========
172
173There are also convenience functions.
174:py:attr:`efl.elementary.object_item.ObjectItem.widget` will return the genlist
175object the item belongs to. :py:meth:`GenlistItem.show` will make the scroller
176scroll to show that specific item so its visible.
177:py:attr:`efl.elementary.object_item.ObjectItem.data` returns the data pointer
178set by the item creation functions.
179
180If an item changes (state of boolean changes, text or contents change),
181then use :py:meth:`GenlistItem.update` to have genlist update the item with
182