diff options
-rw-r--r-- | doc/elementary/actionslider.rst | 85 | ||||
-rw-r--r-- | doc/elementary/background.rst | 58 | ||||
-rw-r--r-- | doc/elementary/box.rst | 118 | ||||
-rw-r--r-- | doc/elementary/bubble.rst | 88 | ||||
-rw-r--r-- | doc/elementary/button.rst | 64 | ||||
-rw-r--r-- | doc/elementary/calendar.rst | 165 | ||||
-rw-r--r-- | doc/elementary/check.rst | 49 | ||||
-rw-r--r-- | doc/elementary/clock.rst | 94 | ||||
-rw-r--r-- | doc/elementary/colorselector.rst | 66 | ||||
-rw-r--r-- | doc/elementary/configuration.rst | 162 | ||||
-rw-r--r-- | doc/elementary/conformant.rst | 43 | ||||
-rw-r--r-- | doc/elementary/ctxpopup.rst | 86 | ||||
-rw-r--r-- | doc/elementary/datetime.rst | 219 | ||||
-rw-r--r-- | doc/elementary/dayselector.rst | 99 | ||||
-rw-r--r-- | doc/elementary/diskselector.rst | 72 | ||||
-rw-r--r-- | doc/elementary/elementary.rst | 484 | ||||
-rw-r--r-- | doc/elementary/entry.rst | 581 | ||||
-rw-r--r-- | doc/elementary/fileselector.rst | 137 | ||||
-rw-r--r-- | doc/elementary/fileselector_button.rst | 75 | ||||
-rw-r--r-- | doc/elementary/fileselector_entry.rst | 90 | ||||
-rw-r--r-- | doc/elementary/flip.rst | 164 | ||||
-rw-r--r-- | doc/elementary/flipselector.rst | 52 | ||||
-rw-r--r-- | doc/elementary/frame.rst | 54 | ||||
-rw-r--r-- | doc/elementary/general.rst | 2 | ||||
-rw-r--r-- | doc/elementary/gengrid.rst | 329 | ||||
-rw-r--r-- | doc/elementary/genlist.rst | 453 | ||||
-rw-r--r-- | doc/elementary/gesture_layer.rst | 152 | ||||
-rw-r--r-- | doc/elementary/grid.rst | 33 | ||||
-rw-r--r-- | doc/elementary/hover.rst | 111 | ||||
-rw-r--r-- | doc/elementary/hoversel.rst | 56 | ||||
-rw-r--r-- | doc/elementary/icon.rst | 183 | ||||
-rw-r--r-- | doc/elementary/image.rst | 95 | ||||
-rw-r--r-- | doc/elementary/index.rst | 64 | ||||
-rw-r--r-- | doc/elementary/innerwindow.rst | 42 | ||||
-rw-r--r-- | doc/elementary/label.rst | 78 | ||||
-rw-r--r-- | doc/elementary/layout.rst | 165 | ||||
-rw-r--r-- | doc/elementary/layout_class.rst | 2 | ||||
-rw-r--r-- | doc/elementary/list.rst | 137 | ||||
-rw-r--r-- | doc/elementary/map.rst | 202 | ||||
-rw-r--r-- | doc/elementary/mapbuf.rst | 33 | ||||
-rw-r--r-- | doc/elementary/menu.rst | 48 | ||||
-rw-r--r-- | doc/elementary/multibuttonentry.rst | 60 | ||||
-rw-r--r-- | doc/elementary/naviframe.rst | 97 | ||||
-rw-r--r-- | doc/elementary/need.rst | 20 | ||||
-rw-r--r-- | doc/elementary/notify.rst | 54 | ||||
-rw-r--r-- | doc/elementary/object.rst | 282 | ||||
-rw-r--r-- | doc/elementary/object_item.rst | 13 | ||||
-rw-r--r-- | doc/elementary/panel.rst | 62 | ||||
-rw-r--r-- | doc/elementary/panes.rst | 46 | ||||
-rw-r--r-- | doc/elementary/photo.rst | 39 | ||||
-rw-r--r-- | doc/elementary/photocam.rst | 95 | ||||
-rw-r--r-- | doc/elementary/plug.rst | 38 | ||||
-rw-r--r-- | doc/elementary/popup.rst | 153 | ||||
-rw-r--r-- | doc/elementary/progressbar.rst | 68 | ||||
-rw-r--r-- | doc/elementary/radio.rst | 63 | ||||
-rw-r--r-- | doc/elementary/scroller.rst | 136 | ||||
-rw-r--r-- | doc/elementary/segment_control.rst | 50 | ||||
-rw-r--r-- | doc/elementary/separator.rst | 24 | ||||
-rw-r--r-- | doc/elementary/slider.rst | 70 | ||||
-rw-r--r-- | doc/elementary/slideshow.rst | 74 | ||||
-rw-r--r-- | doc/elementary/spinner.rst | 53 | ||||
-rw-r--r-- | doc/elementary/systray.rst | 57 | ||||
-rw-r--r-- | doc/elementary/table.rst | 38 | ||||
-rw-r--r-- | doc/elementary/theme.rst | 81 | ||||
-rw-r--r-- | doc/elementary/thumb.rst | 172 | ||||
-rw-r--r-- | doc/elementary/toolbar.rst | 130 | ||||
-rw-r--r-- | doc/elementary/transit.rst | 166 | ||||
-rw-r--r-- | doc/elementary/video.rst | 33 | ||||
-rw-r--r-- | doc/elementary/web.rst | 141 | ||||
-rw-r--r-- | doc/elementary/window.rst | 361 | ||||
-rw-r--r-- | efl/elementary/__init__.py | 6 | ||||
-rw-r--r-- | efl/elementary/__init__.pyx (renamed from efl/elementary/general.pyx) | 363 | ||||
-rw-r--r-- | efl/elementary/actionslider.pxi (renamed from efl/elementary/actionslider.pyx) | 98 | ||||
-rw-r--r-- | efl/elementary/actionslider.py | 7 | ||||
-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.py | 6 | ||||
-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.py | 11 | ||||
-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.py | 6 | ||||
-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.py | 1 | ||||
-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.py | 27 | ||||
-rw-r--r-- | efl/elementary/check.pxi (renamed from efl/elementary/check.pyx) | 54 | ||||
-rw-r--r-- | efl/elementary/check.py | 1 | ||||
-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.py | 10 | ||||
-rw-r--r-- | efl/elementary/clock_cdef.pxi (renamed from efl/elementary/clock.pxd) | 3 | ||||
-rw-r--r-- | efl/elementary/cnp_callbacks.pxi | 2 | ||||
-rw-r--r-- | efl/elementary/colorselector.pxi (renamed from efl/elementary/colorselector.pyx) | 78 | ||||
-rw-r--r-- | efl/elementary/colorselector.py | 5 | ||||
-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.py | 55 | ||||
-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.py | 1 | ||||
-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.py | 7 | ||||
-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.py | 8 | ||||
-rw-r--r-- | efl/elementary/dayselector.pxi (renamed from efl/elementary/dayselector.pyx) | 107 | ||||
-rw-r--r-- | efl/elementary/dayselector.py | 10 | ||||
-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.py | 1 | ||||
-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) | 611 | ||||
-rw-r--r-- | efl/elementary/entry.py | 71 | ||||
-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.py | 14 | ||||
-rw-r--r-- | efl/elementary/fileselector_button.pxi (renamed from efl/elementary/fileselector_button.pyx) | 97 | ||||
-rw-r--r-- | efl/elementary/fileselector_button.py | 1 | ||||
-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.py | 1 | ||||
-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.py | 24 | ||||
-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.py | 1 | ||||
-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.py | 1 | ||||
-rw-r--r-- | efl/elementary/frame_cdef.pxi (renamed from efl/elementary/frame.pxd) | 2 | ||||
-rw-r--r-- | efl/elementary/general.py | 56 | ||||
-rw-r--r-- | efl/elementary/gengrid.pxi | 142 | ||||
-rw-r--r-- | efl/elementary/gengrid.py | 19 | ||||
-rw-r--r-- | efl/elementary/gengrid.pyx | 488 | ||||
-rw-r--r-- | efl/elementary/gengrid_cdef.pxi (renamed from efl/elementary/gengrid.pxd) | 27 | ||||
-rw-r--r-- | efl/elementary/genlist.pxi | 167 | ||||
-rw-r--r-- | efl/elementary/genlist.py | 40 | ||||
-rw-r--r-- | efl/elementary/genlist.pyx | 707 | ||||
-rw-r--r-- | efl/elementary/genlist_cdef.pxi (renamed from efl/elementary/genlist.pxd) | 17 | ||||
-rw-r--r-- | efl/elementary/genlist_item.pxi | 2 | ||||
-rw-r--r-- | efl/elementary/genlist_item_class.pxi | 14 | ||||
-rw-r--r-- | efl/elementary/genlist_widget.pxi | 2 | ||||
-rw-r--r-- | efl/elementary/gesture_layer.pxi (renamed from efl/elementary/gesture_layer.pyx) | 173 | ||||
-rw-r--r-- | efl/elementary/gesture_layer.py | 19 | ||||
-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.py | 1 | ||||
-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.py | 6 | ||||
-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) | 91 | ||||
-rw-r--r-- | efl/elementary/hoversel.py | 5 | ||||
-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.py | 10 | ||||
-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.py | 11 | ||||
-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.py | 1 | ||||
-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.py | 1 | ||||
-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) | 108 | ||||
-rw-r--r-- | efl/elementary/label.py | 10 | ||||
-rw-r--r-- | efl/elementary/label_cdef.pxi (renamed from efl/elementary/label.pxd) | 3 | ||||
-rw-r--r-- | efl/elementary/layout.pxd | 4 | ||||
-rw-r--r-- | efl/elementary/layout.pxi (renamed from efl/elementary/layout_class.pyx) | 78 | ||||
-rw-r--r-- | efl/elementary/layout.py | 1 | ||||
-rw-r--r-- | efl/elementary/layout.pyx | 178 | ||||
-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) | 181 | ||||
-rw-r--r-- | efl/elementary/list.py | 16 | ||||
-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.py | 29 | ||||
-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.py | 1 | ||||
-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.py | 1 | ||||
-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) | 80 | ||||
-rw-r--r-- | efl/elementary/multibuttonentry.py | 1 | ||||
-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.py | 1 | ||||
-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) | 17 | ||||
-rw-r--r-- | efl/elementary/need.py | 7 | ||||
-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.py | 14 | ||||
-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.py | 35 | ||||
-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.py | 6 | ||||
-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.py | 1 | ||||
-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.py | 1 | ||||
-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.py | 7 | ||||
-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.py | 1 | ||||
-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) | 188 | ||||
-rw-r--r-- | efl/elementary/popup.py | 17 | ||||
-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.py | 1 | ||||
-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.py | 1 | ||||
-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.py | 14 | ||||
-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.py | 1 | ||||
-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.py | 1 | ||||
-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.py | 6 | ||||
-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.py | 1 | ||||
-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.py | 1 | ||||
-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.py | 13 | ||||
-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.py | 1 | ||||
-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.py | 2 | ||||
-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.py | 26 | ||||
-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) | 194 | ||||
-rw-r--r-- | efl/elementary/toolbar.py | 25 | ||||
-rw-r--r-- | efl/elementary/toolbar_cdef.pxi (renamed from efl/elementary/toolbar.pxd) | 4 | ||||
-rw-r--r-- | efl/elementary/tooltips.pxi | 52 | ||||
-rw-r--r-- | efl/elementary/transit.pxi (renamed from efl/elementary/transit.pyx) | 178 | ||||
-rw-r--r-- | efl/elementary/transit.py | 21 | ||||
-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.py | 1 | ||||
-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.py | 12 | ||||
-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.py | 50 | ||||
-rw-r--r-- | efl/elementary/window_cdef.pxi (renamed from efl/elementary/window.pxd) | 3 | ||||
-rw-r--r-- | efl/evas/efl.evas_object_image.pxi | 7 | ||||
-rw-r--r-- | efl/evas/efl.evas_object_table.pxi | 4 | ||||
-rw-r--r-- | examples/elementary/test_import_all_modules.py | 77 | ||||
-rw-r--r-- | include/efl.elementary.pxd | 20 | ||||
-rwxr-xr-x | setup.py | 96 |
288 files changed, 9295 insertions, 9588 deletions
diff --git a/doc/elementary/actionslider.rst b/doc/elementary/actionslider.rst index df745d4..d701f8a 100644 --- a/doc/elementary/actionslider.rst +++ b/doc/elementary/actionslider.rst | |||
@@ -1,2 +1,85 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.actionslider | 3 | Actionslider |
4 | ############ | ||
5 | |||
6 | .. image:: /images/actionslider-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | An actionslider is a switcher for two or three labels with | ||
13 | customizable magnet properties. | ||
14 | |||
15 | The user drags and releases the indicator, to choose a label. | ||
16 | |||
17 | Labels can occupy the following positions. | ||
18 | |||
19 | - Left | ||
20 | - Right | ||
21 | - Center | ||
22 | |||
23 | Positions can be enabled or disabled. | ||
24 | |||
25 | Magnets can be set on the above positions. | ||
26 | |||
27 | When the indicator is released, it will move to its nearest "enabled and | ||
28 | magnetized" position. | ||
29 | |||
30 | |||
31 | Emitted signals | ||
32 | =============== | ||
33 | |||
34 | - ``selected`` - when user selects an enabled position (the label is | ||
35 | passed as event info)". | ||
36 | - ``pos_changed`` - when the indicator reaches any of the | ||
37 | positions("left", "right" or "center"). | ||
38 | |||
39 | |||
40 | Layout text parts | ||
41 | ================= | ||
42 | |||
43 | - ``indicator`` - An indicator label of the actionslider | ||
44 | - ``left`` - A left label of the actionslider | ||
45 | - ``right`` - A right label of the actionslider | ||
46 | - ``center`` - A center label of the actionslider | ||
47 | |||
48 | |||
49 | Enumerations | ||
50 | ============ | ||
51 | |||
52 | .. _Elm_Actionslider_Pos: | ||
53 | |||
54 | Actionslider positions | ||
55 | ---------------------- | ||
56 | |||
57 | .. data:: ELM_ACTIONSLIDER_NONE | ||
58 | |||
59 | No position | ||
60 | |||
61 | .. data:: ELM_ACTIONSLIDER_LEFT | ||
62 | |||
63 | Left position | ||
64 | |||
65 | .. data:: ELM_ACTIONSLIDER_CENTER | ||
66 | |||
67 | Center position | ||
68 | |||
69 | .. data:: ELM_ACTIONSLIDER_RIGHT | ||
70 | |||
71 | Right position | ||
72 | |||
73 | .. data:: ELM_ACTIONSLIDER_ALL | ||
74 | |||
75 | All positions | ||
76 | |||
77 | |||
78 | Inheritance diagram | ||
79 | =================== | ||
80 | |||
81 | .. inheritance-diagram:: Actionslider | ||
82 | :parts: 2 | ||
83 | |||
84 | |||
85 | .. autoclass:: Actionslider | ||
diff --git a/doc/elementary/background.rst b/doc/elementary/background.rst index ddac36a..e02534a 100644 --- a/doc/elementary/background.rst +++ b/doc/elementary/background.rst | |||
@@ -1,2 +1,58 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.background | 3 | Background |
4 | ########## | ||
5 | |||
6 | .. image:: /images/background-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | The background widget is used for setting a solid color, image or Edje group | ||
13 | as a background to a window (unless it has transparency enabled) or any | ||
14 | container object. | ||
15 | |||
16 | It works just like an image, but has some properties useful to a | ||
17 | background, like setting it to tiled, centered, scaled or stretched. | ||
18 | |||
19 | |||
20 | Layout content parts | ||
21 | ==================== | ||
22 | |||
23 | - ``overlay`` - overlay of the bg | ||
24 | |||
25 | |||
26 | Enumerations | ||
27 | ============ | ||
28 | |||
29 | .. _Elm_Bg_Option: | ||
30 | |||
31 | Background display modes | ||
32 | ------------------------ | ||
33 | |||
34 | .. data:: ELM_BG_OPTION_CENTER | ||
35 | |||
36 | Center | ||
37 | |||
38 | .. data:: ELM_BG_OPTION_SCALE | ||
39 | |||
40 | Scale | ||
41 | |||
42 | .. data:: ELM_BG_OPTION_STRETCH | ||
43 | |||
44 | Stretch | ||
45 | |||
46 | .. data:: ELM_BG_OPTION_TILE | ||
47 | |||
48 | Tile | ||
49 | |||
50 | |||
51 | Inheritance diagram | ||
52 | =================== | ||
53 | |||
54 | .. inheritance-diagram:: Background | ||
55 | :parts: 2 | ||
56 | |||
57 | |||
58 | .. autoclass:: Background | ||
diff --git a/doc/elementary/box.rst b/doc/elementary/box.rst index 0661cf1..a02358e 100644 --- a/doc/elementary/box.rst +++ b/doc/elementary/box.rst | |||
@@ -1,2 +1,118 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.box | 3 | Box |
4 | ### | ||
5 | |||
6 | .. image:: /images/box-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | A box arranges objects in a linear fashion, governed by a layout function | ||
13 | that defines the details of this arrangement. | ||
14 | |||
15 | By default, the box will use an internal function to set the layout to | ||
16 | a single row, either vertical or horizontal. This layout is affected | ||
17 | by a number of parameters, such as the homogeneous flag set by | ||
18 | :py:attr:`~Box.homogeneous`, the values given by :py:attr:`~Box.padding` and | ||
19 | :py:attr:`~Box.align` and the hints set to each object in the box. | ||
20 | |||
21 | For this default layout, it's possible to change the orientation with | ||
22 | :py:attr:`~Box.horizontal`. The box will start in the vertical orientation, | ||
23 | placing its elements ordered from top to bottom. When horizontal is set, | ||
24 | the order will go from left to right. If the box is set to be | ||
25 | homogeneous, every object in it will be assigned the same space, that | ||
26 | of the largest object. Padding can be used to set some spacing between | ||
27 | the cell given to each object. The alignment of the box, set with | ||
28 | :py:attr:`~Box.align`, determines how the bounding box of all the elements | ||
29 | will be placed within the space given to the box widget itself. | ||
30 | |||
31 | The size hints of each object also affect how they are placed and sized | ||
32 | within the box. :py:attr:`~efl.evas.Object.size_hint_min` will give the minimum | ||
33 | size the object can have, and the box will use it as the basis for all | ||
34 | latter calculations. Elementary widgets set their own minimum size as | ||
35 | needed, so there's rarely any need to use it manually. | ||
36 | |||
37 | :py:attr:`~efl.evas.Object.size_hint_weight`, when not in homogeneous mode, is | ||
38 | used to tell whether the object will be allocated the minimum size it | ||
39 | needs or if the space given to it should be expanded. It's important | ||
40 | to realize that expanding the size given to the object is not the same | ||
41 | thing as resizing the object. It could very well end being a small | ||
42 | widget floating in a much larger empty space. If not set, the weight | ||
43 | for objects will normally be 0.0 for both axis, meaning the widget will | ||
44 | not be expanded. To take as much space possible, set the weight to | ||
45 | ``EVAS_HINT_EXPAND`` (defined to 1.0) for the desired axis to expand. | ||
46 | |||
47 | Besides how much space each object is allocated, it's possible to control | ||
48 | how the widget will be placed within that space using | ||
49 | :py:attr:`~efl.evas.Object.size_hint_align`. By default, this value will be 0.5 | ||
50 | for both axis, meaning the object will be centered, but any value from | ||
51 | 0.0 (left or top, for the ``x`` and ``y`` axis, respectively) to 1.0 | ||
52 | (right or bottom) can be used. The special value *EVAS_HINT_FILL*, which | ||
53 | is -1.0, means the object will be resized to fill the entire space it | ||
54 | was allocated. | ||
55 | |||
56 | In addition, customized functions to define the layout can be set, which | ||
57 | allow the application developer to organize the objects within the box | ||
58 | in any number of ways. | ||
59 | |||
60 | The special :py:meth:`Box.layout_transition` function can be used | ||
61 | to switch from one layout to another, animating the motion of the | ||
62 | children of the box. | ||
63 | |||
64 | .. note:: Objects should not be added to box objects using _add() calls. | ||
65 | |||
66 | |||
67 | Enumerations | ||
68 | ============ | ||
69 | |||
70 | .. _Evas_Object_Box_Layout: | ||
71 | |||
72 | Box layout modes | ||
73 | ---------------- | ||
74 | |||
75 | .. data:: ELM_BOX_LAYOUT_HORIZONTAL | ||
76 | |||
77 | Horizontal layout | ||
78 | |||
79 | .. data:: ELM_BOX_LAYOUT_VERTICAL | ||
80 | |||
81 | Vertical layout | ||
82 | |||
83 | .. data:: ELM_BOX_LAYOUT_HOMOGENEOUS_VERTICAL | ||
84 | |||
85 | Homogeneous vertical layout | ||
86 | |||
87 | .. data:: ELM_BOX_LAYOUT_HOMOGENEOUS_HORIZONTAL | ||
88 | |||
89 | Homogeneous horizontal layout | ||
90 | |||
91 | .. data:: ELM_BOX_LAYOUT_HOMOGENEOUS_MAX_SIZE_HORIZONTAL | ||
92 | |||
93 | Homogeneous layout, maximum size on the horizontal axis | ||
94 | |||
95 | .. data:: ELM_BOX_LAYOUT_HOMOGENEOUS_MAX_SIZE_VERTICAL | ||
96 | |||
97 | Homogeneous layout, maximum size on the horizontal axis | ||
98 | |||
99 | .. data:: ELM_BOX_LAYOUT_FLOW_HORIZONTAL | ||
100 | |||
101 | Horizontally flowing layout | ||
102 | |||
103 | .. data:: ELM_BOX_LAYOUT_FLOW_VERTICAL | ||
104 | |||
105 | Vertically flowing layout | ||
106 | |||
107 | .. data:: ELM_BOX_LAYOUT_STACK | ||
108 | |||
109 | Stacking layout | ||
110 | |||
111 | |||
112 | Inheritance diagram | ||
113 | =================== | ||
114 | |||
115 | .. inheritance-diagram:: Box | ||
116 | :parts: 2 | ||
117 | |||
118 | .. autoclass:: Box | ||
diff --git a/doc/elementary/bubble.rst b/doc/elementary/bubble.rst index 3f0c1a9..d66826a 100644 --- a/doc/elementary/bubble.rst +++ b/doc/elementary/bubble.rst | |||
@@ -1,2 +1,88 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.bubble | 3 | Bubble |
4 | ###### | ||
5 | |||
6 | .. image:: /images/bubble-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | The Bubble is a widget to show text similar to how speech is | ||
13 | represented in comics. | ||
14 | |||
15 | The bubble widget contains 5 important visual elements: | ||
16 | |||
17 | - The frame is a rectangle with rounded edjes and an "arrow". | ||
18 | - The ``icon`` is an image to which the frame's arrow points to. | ||
19 | - The ``label`` is a text which appears to the right of the icon if the | ||
20 | corner is **top_left** or **bottom_left** and is right aligned to | ||
21 | the frame otherwise. | ||
22 | - The ``info`` is a text which appears to the right of the label. Info's | ||
23 | font is of a lighter color than label. | ||
24 | - The ``content`` is an evas object that is shown inside the frame. | ||
25 | |||
26 | The position of the arrow, icon, label and info depends on which corner is | ||
27 | selected. The four available corners are: | ||
28 | |||
29 | - ``top_left`` - Default | ||
30 | - ``top_right`` | ||
31 | - ``bottom_left`` | ||
32 | - ``bottom_right`` | ||
33 | |||
34 | |||
35 | Layout content parts | ||
36 | ==================== | ||
37 | |||
38 | - ``default`` - A content of the bubble | ||
39 | - ``icon`` - An icon of the bubble | ||
40 | |||
41 | |||
42 | Layout text parts | ||
43 | ================= | ||
44 | |||
45 | - ``default`` - Label of the bubble | ||
46 | - ``info`` - info of the bubble | ||
47 | |||
48 | |||
49 | Emitted signals | ||
50 | =============== | ||
51 | |||
52 | - ``clicked`` - This is called when a user has clicked the bubble. | ||
53 | - ``focused`` - When the bubble has received focus. (since 1.8) | ||
54 | - ``unfocused`` - When the bubble has lost focus. (since 1.8) | ||
55 | |||
56 | |||
57 | Enumerations | ||
58 | ============ | ||
59 | |||
60 | .. _Elm_Bubble_Pos: | ||
61 | |||
62 | Bubble arrow positions | ||
63 | ---------------------- | ||
64 | |||
65 | .. data:: ELM_BUBBLE_POS_TOP_LEFT | ||
66 | |||
67 | Top left position | ||
68 | |||
69 | .. data:: ELM_BUBBLE_POS_TOP_RIGHT | ||
70 | |||
71 | Top right position | ||
72 | |||
73 | .. data:: ELM_BUBBLE_POS_BOTTOM_LEFT | ||
74 | |||
75 | Bottom left position | ||
76 | |||
77 | .. data:: ELM_BUBBLE_POS_BOTTOM_RIGHT | ||
78 | |||
79 | Bottom right position | ||
80 | |||
81 | |||
82 | Inheritance diagram | ||
83 | =================== | ||
84 | |||
85 | .. inheritance-diagram:: Bubble | ||
86 | :parts: 2 | ||
87 | |||
88 | .. autoclass:: Bubble | ||
diff --git a/doc/elementary/button.rst b/doc/elementary/button.rst index d138ba2..becdc6b 100644 --- a/doc/elementary/button.rst +++ b/doc/elementary/button.rst | |||
@@ -1,3 +1,65 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.button | 3 | Button |
4 | ###### | ||
5 | |||
6 | .. image:: /images/button-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | This is a push-button. Press it and run some function. It can contain | ||
13 | a simple label and icon object and it also has an autorepeat feature. | ||
14 | |||
15 | |||
16 | Available styles | ||
17 | ================ | ||
18 | |||
19 | - ``default`` a normal button. | ||
20 | - ``anchor`` Like default, but the button fades away when the mouse is not | ||
21 | over it, leaving only the text or icon. | ||
22 | - ``hoversel_vertical`` Internally used by | ||
23 | :py:class:`~efl.elementary.hoversel.Hoversel` to give a continuous look | ||
24 | across its options. | ||
25 | - ``hoversel_vertical_entry`` Another internal for | ||
26 | :py:class:`~efl.elementary.hoversel.Hoversel`. | ||
27 | - ``naviframe`` Internally used by | ||
28 | :py:class:`~efl.elementary.naviframe.Naviframe` for its back button. | ||
29 | - ``colorselector`` Internally used by | ||
30 | :py:class:`~efl.elementary.colorselector.Colorselector` for its left and | ||
31 | right buttons. | ||
32 | |||
33 | |||
34 | Layout content parts | ||
35 | ==================== | ||
36 | |||
37 | - ``icon`` - An icon of the button | ||
38 | |||
39 | |||
40 | Layout text parts | ||
41 | ================= | ||
42 | |||
43 | - ``default`` - Label of the button | ||
44 | |||
45 | |||
46 | Emitted signals | ||
47 | =============== | ||
48 | |||
49 | - ``clicked``: the user clicked the button (press/release). | ||
50 | - ``repeated``: the user pressed the button without releasing it. | ||
51 | - ``pressed``: button was pressed. | ||
52 | - ``unpressed``: button was released after being pressed. | ||
53 | - ``focused`` : When the button has received focus. (since 1.8) | ||
54 | - ``unfocused`` : When the button has lost focus. (since 1.8) | ||
55 | |||
56 | |||
57 | Inheritance diagram | ||
58 | =================== | ||
59 | |||
60 | .. inheritance-diagram:: Button | ||
61 | :parts: 2 | ||
62 | |||
63 | |||
64 | .. autoclass:: Button | ||
3 | 65 | ||
diff --git a/doc/elementary/calendar.rst b/doc/elementary/calendar.rst index c3fd57a..5278f3d 100644 --- a/doc/elementary/calendar.rst +++ b/doc/elementary/calendar.rst | |||
@@ -1,2 +1,165 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.calendar_elm | 3 | Calendar |
4 | ######## | ||
5 | |||
6 | .. image:: /images/calendar-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | This is a calendar widget. | ||
13 | |||
14 | It helps applications to flexibly display a calender with day of the week, | ||
15 | date, year and month. Applications are able to set specific dates to be | ||
16 | reported back, when selected, in the smart callbacks of the calendar widget. | ||
17 | The API of this widget lets the applications perform other functions, like: | ||
18 | |||
19 | - placing marks on specific dates | ||
20 | - setting the bounds for the calendar (minimum and maximum years) | ||
21 | - setting the day names of the week (e.g. "Thu" or "Thursday") | ||
22 | - setting the year and month format. | ||
23 | |||
24 | |||
25 | Emitted signals | ||
26 | =============== | ||
27 | |||
28 | - ``changed`` - emitted when the date in the calendar is changed. | ||
29 | - ``display,changed`` - emitted when the current month displayed in the | ||
30 | calendar is changed. | ||
31 | - ``focused`` - When the calendar has received focus. (since 1.8) | ||
32 | - ``unfocused`` - When the calendar has lost focus. (since 1.8) | ||
33 | |||
34 | |||
35 | Enumerations | ||
36 | ============ | ||
37 | |||
38 | .. _Elm_Calendar_Mark_Repeat_Type: | ||
39 | |||
40 | Calendar mark repeat types | ||
41 | -------------------------- | ||
42 | |||
43 | .. data:: ELM_CALENDAR_UNIQUE | ||
44 | |||
45 | Default value. | ||
46 | |||
47 | Marks will be displayed only on event day. | ||
48 | |||
49 | .. data:: ELM_CALENDAR_DAILY | ||
50 | |||
51 | Marks will be displayed every day after event day (inclusive). | ||
52 | |||
53 | .. data:: ELM_CALENDAR_WEEKLY | ||
54 | |||
55 | Marks will be displayed every week after event day (inclusive) - i.e. | ||
56 | each seven days. | ||
57 | |||
58 | .. data:: ELM_CALENDAR_MONTHLY | ||
59 | |||
60 | Marks will be displayed every month day that coincides to event day. | ||
61 | |||
62 | E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, | ||
63 | but will be displayed on 30th Mar | ||
64 | |||
65 | .. data:: ELM_CALENDAR_ANNUALLY | ||
66 | |||
67 | Marks will be displayed every year that coincides to event day (and month). | ||
68 | |||
69 | E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013. | ||
70 | |||
71 | .. data:: ELM_CALENDAR_LAST_DAY_OF_MONTH | ||
72 | |||
73 | Marks will be displayed every last day of month after event day | ||
74 | (inclusive). | ||
75 | |||
76 | |||
77 | .. _Elm_Calendar_Select_Mode: | ||
78 | |||
79 | Calendar selection modes | ||
80 | ------------------------ | ||
81 | |||
82 | .. data:: ELM_CALENDAR_SELECT_MODE_DEFAULT | ||
83 | |||
84 | Default mode | ||
85 | |||
86 | .. data:: ELM_CALENDAR_SELECT_MODE_ALWAYS | ||
87 | |||
88 | Select always | ||
89 | |||
90 | .. data:: ELM_CALENDAR_SELECT_MODE_NONE | ||
91 | |||
92 | Don't select | ||
93 | |||
94 | .. data:: ELM_CALENDAR_SELECT_MODE_ONDEMAND | ||
95 | |||
96 | Select on demand | ||
97 | |||
98 | |||
99 | .. _Elm_Calendar_Selectable: | ||
100 | |||
101 | Selectable | ||
102 | ---------- | ||
103 | |||
104 | .. data:: ELM_CALENDAR_SELECTABLE_NONE | ||
105 | |||
106 | None selectable | ||
107 | |||
108 | .. data:: ELM_CALENDAR_SELECTABLE_YEAR | ||
109 | |||
110 | Year is selectable | ||
111 | |||
112 | .. data:: ELM_CALENDAR_SELECTABLE_MONTH | ||
113 | |||
114 | Month is selectable | ||
115 | |||
116 | .. data:: ELM_CALENDAR_SELECTABLE_DAY | ||
117 | |||
118 | Day is selectable | ||
119 | |||
120 | |||
121 | .. _Elm_Calendar_Weekday: | ||
122 | |||
123 | Days | ||
124 | ---- | ||
125 | |||
126 | .. data:: ELM_DAY_SUNDAY | ||
127 | |||
128 | Sunday | ||
129 | |||
130 | .. data:: ELM_DAY_MONDAY | ||
131 | |||
132 | Monday | ||
133 | |||
134 | .. data:: ELM_DAY_TUESDAY | ||
135 | |||
136 | Tuesday | ||
137 | |||
138 | .. data:: ELM_DAY_WEDNESDAY | ||
139 | |||
140 | Wednesday | ||
141 | |||
142 | .. data:: ELM_DAY_THURSDAY | ||
143 | |||
144 | Thursday | ||
145 | |||
146 | .. data:: ELM_DAY_FRIDAY | ||
147 | |||
148 | Friday | ||
149 | |||
150 | .. data:: ELM_DAY_SATURDAY | ||
151 | |||
152 | Saturday | ||
153 | |||
154 | |||
155 | Inheritance diagram | ||
156 | =================== | ||
157 | |||
158 | .. inheritance-diagram:: | ||
159 | Calendar | ||
160 | CalendarMark | ||
161 | :parts: 2 | ||
162 | |||
163 | |||
164 | .. autoclass:: Calendar | ||
165 | .. autoclass:: CalendarMark | ||
diff --git a/doc/elementary/check.rst b/doc/elementary/check.rst index 7da1ef8..62a714a 100644 --- a/doc/elementary/check.rst +++ b/doc/elementary/check.rst | |||
@@ -1,2 +1,49 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.check | 3 | Check |
4 | ##### | ||
5 | |||
6 | .. image:: /images/check-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | The check widget allows for toggling a value between true and false. | ||
13 | |||
14 | Check objects are a lot like radio objects in layout and functionality, | ||
15 | except they do not work as a group, but independently, and only toggle | ||
16 | the value of a boolean :py:attr:`~Check.state` between false and true. | ||
17 | |||
18 | |||
19 | Emitted signals | ||
20 | =============== | ||
21 | |||
22 | - ``changed`` - This is called whenever the user changes the state of | ||
23 | the check objects. | ||
24 | - ``focused`` - When the check has received focus. (since 1.8) | ||
25 | - ``unfocused`` - When the check has lost focus. (since 1.8) | ||
26 | |||
27 | |||
28 | Layout content parts | ||
29 | ==================== | ||
30 | |||
31 | - ``icon`` - An icon of the check | ||
32 | |||
33 | |||
34 | Layout text parts | ||
35 | ================= | ||
36 | |||
37 | - ``default`` - A label of the check | ||
38 | - ``on`` - On state label of the check | ||
39 | - ``off`` - Off state label of the check | ||
40 | |||
41 | |||
42 | Inheritance diagram | ||
43 | =================== | ||
44 | |||
45 | .. inheritance-diagram:: Check | ||
46 | :parts: 2 | ||
47 | |||
48 | |||
49 | .. autoclass:: Check | ||
diff --git a/doc/elementary/clock.rst b/doc/elementary/clock.rst index 519a6e2..d0a896a 100644 --- a/doc/elementary/clock.rst +++ b/doc/elementary/clock.rst | |||
@@ -1,2 +1,94 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.clock | 3 | Clock |
4 | ##### | ||
5 | |||
6 | .. image:: /images/clock-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | This is a digital clock widget. | ||
13 | |||
14 | In its default theme, it has a vintage "flipping numbers clock" appearance, | ||
15 | which will animate sheets of individual algarisms individually as time goes | ||
16 | by. | ||
17 | |||
18 | A newly created clock will fetch system's time (already considering | ||
19 | local time adjustments) to start with, and will tick accordingly. It may | ||
20 | or may not show seconds. | ||
21 | |||
22 | Clocks have an **edition** mode. When in it, the sheets will display | ||
23 | extra arrow indications on the top and bottom and the user may click on | ||
24 | them to raise or lower the time values. After it's told to exit edition | ||
25 | mode, it will keep ticking with that new time set (it keeps the | ||
26 | difference from local time). | ||
27 | |||
28 | Also, when under edition mode, user clicks on the cited arrows which are | ||
29 | **held** for some time will make the clock to flip the sheet, thus | ||
30 | editing the time, continuously and automatically for the user. The | ||
31 | interval between sheet flips will keep growing in time, so that it helps | ||
32 | the user to reach a time which is distant from the one set. | ||
33 | |||
34 | The time display is, by default, in military mode (24h), but an am/pm | ||
35 | indicator may be optionally shown, too, when it will switch to 12h. | ||
36 | |||
37 | |||
38 | Emitted signals | ||
39 | =============== | ||
40 | |||
41 | - ``changed`` - the clock's user changed the time | ||
42 | - ``focused`` - When the clock has received focus. (since 1.8) | ||
43 | - ``unfocused`` - When the clock has lost focus. (since 1.8) | ||
44 | |||
45 | |||
46 | Enumerations | ||
47 | ============ | ||
48 | |||
49 | .. _Elm_Clock_Edit_Mode: | ||
50 | |||
51 | Clock edit modes | ||
52 | ---------------- | ||
53 | |||
54 | .. data:: ELM_CLOCK_EDIT_DEFAULT | ||
55 | |||
56 | Default edit | ||
57 | |||
58 | .. data:: ELM_CLOCK_EDIT_HOUR_DECIMAL | ||
59 | |||
60 | Edit hours' decimal | ||
61 | |||
62 | .. data:: ELM_CLOCK_EDIT_HOUR_UNIT | ||
63 | |||
64 | Edit hours' unit | ||
65 | |||
66 | .. data:: ELM_CLOCK_EDIT_MIN_DECIMAL | ||
67 | |||
68 | Edit minutes' decimal | ||
69 | |||
70 | .. data:: ELM_CLOCK_EDIT_MIN_UNIT | ||
71 | |||
72 | Edit minutes' unit | ||
73 | |||
74 | .. data:: ELM_CLOCK_EDIT_SEC_DECIMAL | ||
75 | |||
76 | Edit seconds' decimal | ||
77 | |||
78 | .. data:: ELM_CLOCK_EDIT_SEC_UNIT | ||
79 | |||
80 | Edit seconds' unit | ||
81 | |||
82 | .. data:: ELM_CLOCK_EDIT_ALL | ||
83 | |||
84 | Edit all | ||
85 | |||
86 | |||
87 | Inheritance diagram | ||
88 | =================== | ||
89 | |||
90 | .. inheritance-diagram:: Clock | ||
91 | :parts: 2 | ||
92 | |||
93 | |||
94 | .. autoclass:: Clock | ||
diff --git a/doc/elementary/colorselector.rst b/doc/elementary/colorselector.rst index 21b8103..b79c393 100644 --- a/doc/elementary/colorselector.rst +++ b/doc/elementary/colorselector.rst | |||
@@ -1,2 +1,66 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.colorselector | 3 | Colorselector |
4 | ############# | ||
5 | |||
6 | .. image:: /images/colorselector-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | A Colorselector is a color selection widget. | ||
13 | |||
14 | It allows application to set a series of colors. It also allows to | ||
15 | load/save colors from/to config with a unique identifier, by default, | ||
16 | the colors are loaded/saved from/to config using "default" identifier. | ||
17 | The colors can be picked by user from the color set by clicking on | ||
18 | individual color item on the palette or by selecting it from selector. | ||
19 | |||
20 | |||
21 | Emitted signals | ||
22 | =============== | ||
23 | |||
24 | - ``"changed"`` - When the color value changes on selector | ||
25 | - ``"color,item,selected"`` - When user clicks on color item. | ||
26 | The event_info parameter of the callback will be the selected | ||
27 | color item. | ||
28 | - ``"color,item,longpressed"`` - When user long presses on color item. | ||
29 | The event_info parameter of the callback will be the selected | ||
30 | color item. | ||
31 | - ``focused`` - When the colorselector has received focus. (since 1.8) | ||
32 | - ``unfocused`` - When the colorselector has lost focus. (since 1.8) | ||
33 | |||
34 | |||
35 | Enumerations | ||
36 | ============ | ||
37 | |||
38 | .. _Elm_Colorselector_Mode: | ||
39 | |||
40 | Colorselector modes | ||
41 | ------------------- | ||
42 | |||
43 | .. data:: ELM_COLORSELECTOR_PALETTE | ||
44 | |||
45 | Show palette | ||
46 | |||
47 | .. data:: ELM_COLORSELECTOR_COMPONENTS | ||
48 | |||
49 | Show components | ||
50 | |||
51 | .. data:: ELM_COLORSELECTOR_BOTH | ||
52 | |||
53 | Show palette and components | ||
54 | |||
55 | |||
56 | Inheritance diagram | ||
57 | =================== | ||
58 | |||
59 | .. inheritance-diagram:: | ||
60 | Colorselector | ||
61 | ColorselectorPaletteItem | ||
62 | :parts: 2 | ||
63 | |||
64 | |||
65 | .. autoclass:: Colorselector | ||
66 | .. autoclass:: ColorselectorPaletteItem | ||
diff --git a/doc/elementary/configuration.rst b/doc/elementary/configuration.rst index 3c992da..8dbd278 100644 --- a/doc/elementary/configuration.rst +++ b/doc/elementary/configuration.rst | |||
@@ -1,2 +1,162 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.configuration | 3 | Configuration |
4 | ############# | ||
5 | |||
6 | Description | ||
7 | =========== | ||
8 | |||
9 | Elementary configuration is formed by a set options bounded to a | ||
10 | given profile, like theme, "finger size", etc. | ||
11 | |||
12 | These are functions with which one synchronizes changes made to those | ||
13 | values to the configuration storing files, de facto. You most probably | ||
14 | don't want to use the functions in this group unless you're writing an | ||
15 | elementary configuration manager. | ||
16 | |||
17 | Profiles | ||
18 | ======== | ||
19 | |||
20 | Profiles are pre-set options that affect the whole look-and-feel of | ||
21 | Elementary-based applications. There are, for example, profiles | ||
22 | aimed at desktop computer applications and others aimed at mobile, | ||
23 | touchscreen-based ones. You most probably don't want to use the | ||
24 | functions in this group unless you're writing an elementary | ||
25 | configuration manager. | ||
26 | |||
27 | Elementary Scrolling | ||
28 | ==================== | ||
29 | |||
30 | These set how scrollable views in Elementary widgets should behave on | ||
31 | user interaction. | ||
32 | |||
33 | Password show last | ||
34 | ================== | ||
35 | |||
36 | Show last feature of password mode enables user to view the last input | ||
37 | entered for few seconds before masking it. These functions allow to set | ||
38 | this feature in password mode of entry widget and also allow to | ||
39 | manipulate the duration for which the input has to be visible. | ||
40 | |||
41 | Elementary Engine | ||
42 | ================= | ||
43 | |||
44 | These are functions setting and querying which rendering engine | ||
45 | Elementary will use for drawing its windows' pixels. | ||
46 | |||
47 | The following are the available engines: | ||
48 | |||
49 | - "software_x11" | ||
50 | - "fb" | ||
51 | - "directfb" | ||
52 | - "software_16_x11" | ||
53 | - "software_8_x11" | ||
54 | - "xrender_x11" | ||
55 | - "opengl_x11" | ||
56 | - "software_gdi" | ||
57 | - "software_16_wince_gdi" | ||
58 | - "sdl" | ||
59 | - "software_16_sdl" | ||
60 | - "opengl_sdl" | ||
61 | - "buffer" | ||
62 | - "ews" | ||
63 | - "opengl_cocoa" | ||
64 | - "psl1ght" | ||
65 | |||
66 | |||
67 | ATSPI AT-SPI2 Accessibility | ||
68 | =========================== | ||
69 | |||
70 | Elementary widgets support Linux Accessibility standard. For more | ||
71 | information please visit: | ||
72 | http://www.linuxfoundation.org/collaborate/workgroups/accessibility/atk/at-spi/at-spi_on_d-bus | ||
73 | |||
74 | |||
75 | Enumerations | ||
76 | ============ | ||
77 | |||
78 | .. _Elm_Softcursor_Mode: | ||
79 | |||
80 | Elm_Softcursor_Mode | ||
81 | ------------------- | ||
82 | |||
83 | .. data:: ELM_SOFTCURSOR_MODE_AUTO | ||
84 | |||
85 | Auto-detect if a software cursor should be used (default) | ||
86 | |||
87 | .. data:: ELM_SOFTCURSOR_MODE_ON | ||
88 | |||
89 | Always use a softcursor | ||
90 | |||
91 | .. data:: ELM_SOFTCURSOR_MODE_OFF | ||
92 | |||
93 | Never use a softcursor | ||
94 | |||
95 | |||
96 | .. _Elm_Slider_Indicator_Visible_Mode: | ||
97 | |||
98 | Elm_Slider_Indicator_Visible_Mode | ||
99 | --------------------------------- | ||
100 | |||
101 | .. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_DEFAULT | ||
102 | |||
103 | show indicator on mouse down or change in slider value | ||
104 | |||
105 | .. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_ALWAYS | ||
106 | |||
107 | Always show the indicator | ||
108 | |||
109 | .. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_ON_FOCUS | ||
110 | |||
111 | Show the indicator on focus | ||
112 | |||
113 | .. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_NONE | ||
114 | |||
115 | Never show the indicator | ||
116 | |||
117 | |||
118 | .. _Edje_Channel: | ||
119 | |||
120 | Audio Channels | ||
121 | -------------- | ||
122 | |||
123 | .. data:: EDJE_CHANNEL_EFFECT | ||
124 | |||
125 | Standard audio effects | ||
126 | |||
127 | .. data:: EDJE_CHANNEL_BACKGROUND | ||
128 | |||
129 | Background audio sounds | ||
130 | |||
131 | .. data:: EDJE_CHANNEL_MUSIC | ||
132 | |||
133 | Music audio | ||
134 | |||
135 | .. data:: EDJE_CHANNEL_FOREGROUND | ||
136 | |||
137 | Foreground audio sounds | ||
138 | |||
139 | .. data:: EDJE_CHANNEL_INTERFACE | ||
140 | |||
141 | Sounds related to the interface | ||
142 | |||
143 | .. data:: EDJE_CHANNEL_INPUT | ||
144 | |||
145 | Sounds related to regular input | ||
146 | |||
147 | .. data:: EDJE_CHANNEL_ALERT | ||
148 | |||
149 | Sounds for major alerts | ||
150 | |||
151 | .. data:: EDJE_CHANNEL_ALL | ||
152 | |||
153 | All audio channels (convenience) | ||
154 | |||
155 | |||
156 | Inheritance diagram | ||
157 | =================== | ||
158 | |||
159 | .. inheritance-diagram:: Configuration | ||
160 | :parts: 2 | ||
161 | |||
162 | .. autoclass:: Configuration | ||
diff --git a/doc/elementary/conformant.rst b/doc/elementary/conformant.rst index b13449c..19af68c 100644 --- a/doc/elementary/conformant.rst +++ b/doc/elementary/conformant.rst | |||
@@ -1,2 +1,43 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.conformant | 3 | Conformant |
4 | ########## | ||
5 | |||
6 | .. image:: /images/conformant-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | The aim is to provide a widget that can be used in elementary apps to | ||
13 | account for space taken up by the indicator, virtual keypad & softkey | ||
14 | windows when running the illume2 module of E17. | ||
15 | |||
16 | So conformant content will be sized and positioned considering the | ||
17 | space required for such stuff, and when they popup, as a keyboard | ||
18 | shows when an entry is selected, conformant content won't change. | ||
19 | |||
20 | |||
21 | Emitted signals | ||
22 | =============== | ||
23 | |||
24 | - ``virtualkeypad,state,on``: if virtualkeypad state is switched to ``on``. | ||
25 | - ``virtualkeypad,state,off``: if virtualkeypad state is switched to ``off``. | ||
26 | - ``clipboard,state,on``: if clipboard state is switched to ``on``. | ||
27 | - ``clipboard,state,off``: if clipboard state is switched to ``off``. | ||
28 | |||
29 | |||
30 | Layout content parts | ||
31 | ==================== | ||
32 | |||
33 | - ``default`` - A content of the conformant | ||
34 | |||
35 | |||
36 | Inheritance diagram | ||
37 | =================== | ||
38 | |||
39 | .. inheritance-diagram:: Conformant | ||
40 | :parts: 2 | ||
41 | |||
42 | |||
43 | .. autoclass:: Conformant | ||
diff --git a/doc/elementary/ctxpopup.rst b/doc/elementary/ctxpopup.rst index 95151ac..a9dc880 100644 --- a/doc/elementary/ctxpopup.rst +++ b/doc/elementary/ctxpopup.rst | |||
@@ -1,2 +1,86 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.ctxpopup | 3 | Ctxpopup |
4 | ######## | ||
5 | |||
6 | .. image:: /images/ctxpopup-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | A ctxpopup is a widget that, when shown, pops up a list of items. It | ||
13 | automatically chooses an area inside its parent object's view to | ||
14 | optimally fit into it. In the default theme, it will also point an arrow | ||
15 | to it's top left position at the time one shows it. Ctxpopup items have | ||
16 | a label and/or an icon. It is intended for a small number of items | ||
17 | (hence the use of list, not genlist). | ||
18 | |||
19 | .. note:: | ||
20 | |||
21 | Ctxpopup is a specialization of :py:class:`~efl.elementary.hover.Hover`. | ||
22 | |||
23 | Emitted signals | ||
24 | =============== | ||
25 | |||
26 | - ``dismissed`` - This is called when 1. the outside of ctxpopup was clicked | ||
27 | or 2. its parent area is changed or 3. the language is changed and also when | ||
28 | 4. the parent object is resized due to the window rotation. Then ctxpopup is | ||
29 | dismissed. | ||
30 | - ``language,changed`` - This is called when the program's language is | ||
31 | changed. | ||
32 | - ``focused`` - When the ctxpopup has received focus. (since 1.8) | ||
33 | - ``unfocused`` - When the ctxpopup has lost focus. (since 1.8) | ||
34 | |||
35 | Layout content parts | ||
36 | ==================== | ||
37 | |||
38 | - ``default`` - A content of the ctxpopup | ||
39 | - ``icon`` - An icon in the title area | ||
40 | |||
41 | Layout text parts | ||
42 | ================= | ||
43 | |||
44 | - ``default`` - Title label in the title area | ||
45 | |||
46 | |||
47 | Enumerations | ||
48 | ============ | ||
49 | |||
50 | .. _Elm_Ctxpopup_Direction: | ||
51 | |||
52 | Ctxpopup arrow directions | ||
53 | ------------------------- | ||
54 | |||
55 | .. data:: ELM_CTXPOPUP_DIRECTION_DOWN | ||
56 | |||
57 | Arrow is pointing down | ||
58 | |||
59 | .. data:: ELM_CTXPOPUP_DIRECTION_RIGHT | ||
60 | |||
61 | Arrow is pointing right | ||
62 | |||
63 | .. data:: ELM_CTXPOPUP_DIRECTION_LEFT | ||
64 | |||
65 | Arrow is pointing left | ||
66 | |||
67 | .. data:: ELM_CTXPOPUP_DIRECTION_UP | ||
68 | |||
69 | Arrow is pointing up | ||
70 | |||
71 | .. data:: ELM_CTXPOPUP_DIRECTION_UNKNOWN | ||
72 | |||
73 | Arrow direction is unknown | ||
74 | |||
75 | |||
76 | Inheritance diagram | ||
77 | =================== | ||
78 | |||
79 | .. inheritance-diagram:: | ||
80 | Ctxpopup | ||
81 | CtxpopupItem | ||
82 | :parts: 2 | ||
83 | |||
84 | |||
85 | .. autoclass:: Ctxpopup | ||
86 | .. autoclass:: CtxpopupItem | ||
diff --git a/doc/elementary/datetime.rst b/doc/elementary/datetime.rst index cf98d10..c271396 100644 --- a/doc/elementary/datetime.rst +++ b/doc/elementary/datetime.rst | |||
@@ -1,2 +1,219 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.datetime_elm | 3 | Datetime |
4 | ######## | ||
5 | |||
6 | Widget description | ||
7 | ================== | ||
8 | |||
9 | Datetime widget is used to display and input date & time values. | ||
10 | |||
11 | This widget displays date and time as per the **system's locale** settings | ||
12 | (Date includes Day, Month & Year along with the defined separators and Time | ||
13 | includes Hour, Minute & AM/PM fields). Separator for AM/PM field is ignored. | ||
14 | |||
15 | The corresponding Month, AM/PM strings are displayed according to the | ||
16 | system’s language settings. | ||
17 | |||
18 | Datetime format is a combination of LIBC standard characters like "%%d %%b | ||
19 | %%Y %%I : %%M %%p" which, as a whole represents both Date as well as Time | ||
20 | format. | ||
21 | |||
22 | Elm_datetime supports only the following sub set of libc date format specifiers: | ||
23 | |||
24 | **%%Y** The year as a decimal number including the century (example: 2011). | ||
25 | |||
26 | **%%y** The year as a decimal number without a century (range 00 to 99) | ||
27 | |||
28 | **%%m** The month as a decimal number (range 01 to 12). | ||
29 | |||
30 | **%%b** The abbreviated month name according to the current locale. | ||
31 | |||
32 | **%%B** The full month name according to the current locale. | ||
33 | |||
34 | **%%h** The abbreviated month name according to the current locale(same as %%b). | ||
35 | |||
36 | **%%d** The day of the month as a decimal number (range 01 to 31). | ||
37 | |||
38 | **%%e** The day of the month as a decimal number (range 1 to 31). single | ||
39 | digits are preceded by a blank. | ||
40 | |||
41 | **%%I** The hour as a decimal number using a 12-hour clock (range 01 to 12). | ||
42 | |||
43 | **%%H** The hour as a decimal number using a 24-hour clock (range 00 to 23). | ||
44 | |||
45 | **%%k** The hour (24-hour clock) as a decimal number (range 0 to 23). single | ||
46 | digits are preceded by a blank. | ||
47 | |||
48 | **%%l** The hour (12-hour clock) as a decimal number (range 1 to 12); single | ||
49 | digits are preceded by a blank. | ||
50 | |||
51 | **%%M** The minute as a decimal number (range 00 to 59). | ||
52 | |||
53 | **%%p** Either 'AM' or 'PM' according to the given time value, or the | ||
54 | corresponding strings for the current locale. Noon is treated as 'PM' | ||
55 | and midnight as 'AM' | ||
56 | |||
57 | **%%P** Like %p but in lower case: 'am' or 'pm' or a corresponding string for | ||
58 | the current locale. | ||
59 | |||
60 | **%%c** The preferred date and time representation for the current locale. | ||
61 | |||
62 | **%%x** The preferred date representation for the current locale without the time. | ||
63 | |||
64 | **%%X** The preferred time representation for the current locale without the date. | ||
65 | |||
66 | **%%r** The complete calendar time using the AM/PM format of the current locale. | ||
67 | |||
68 | **%%R** The hour and minute in decimal numbers using the format %H:%M. | ||
69 | |||
70 | **%%T** The time of day in decimal numbers using the format %H:%M:%S. | ||
71 | |||
72 | **%%D** The date using the format %%m/%%d/%%y. | ||
73 | |||
74 | **%%F** The date using the format %%Y-%%m-%%d. | ||
75 | |||
76 | |||
77 | (For more reference on the available **LIBC date format specifiers**, | ||
78 | please visit the link: | ||
79 | http://www.gnu.org/s/hello/manual/libc.html#Formatting-Calendar-Time ) | ||
80 | |||
81 | Datetime widget can provide Unicode **separators** in between its fields | ||
82 | except for AM/PM field. A separator can be any **Unicode character** | ||
83 | other than the LIBC standard date format specifiers. | ||
84 | |||
85 | Example: In the format:: | ||
86 | |||
87 | %%b %%d **,** %%y %%H **:** %%M | ||
88 | |||
89 | comma(,) is separator for date field %%d and colon(:) is separator for | ||
90 | hour field %%H. | ||
91 | |||
92 | The default format is a predefined one, based on the system Locale. | ||
93 | |||
94 | Hour format 12hr(1-12) or 24hr(0-23) display can be selected by setting | ||
95 | the corresponding user format. | ||
96 | |||
97 | Datetime supports six fields: Year, Month, Date, Hour, Minute, AM/PM. | ||
98 | Depending on the Datetime module that is loaded, the user can see | ||
99 | different UI to select the individual field values. | ||
100 | |||
101 | The individual fields of Datetime can be arranged in any order according | ||
102 | to the format set by application. | ||
103 | |||
104 | There is a provision to set the visibility of a particular field as TRUE/ | ||
105 | FALSE so that **only time/ only date / only required fields** will be | ||
106 | displayed. | ||
107 | |||
108 | Each field is having a default minimum and maximum values just like the | ||
109 | daily calendar information. These min/max values can be modified as per | ||
110 | the application usage. | ||
111 | |||
112 | User can enter the values only in between the range of maximum and | ||
113 | minimum. Apart from these APIs, there is a provision to display only a | ||
114 | limited set of values out of the possible values. APIs to select the | ||
115 | individual field limits are intended for this purpose. | ||
116 | |||
117 | The whole widget is left aligned and its size grows horizontally | ||
118 | depending on the current format and each field's visible/disabled state. | ||
119 | |||
120 | Datetime individual field selection is implemented in a modular style. | ||
121 | Module can be implemented as a Ctxpopup based selection or an ISE based | ||
122 | selection or even a spinner like selection etc. | ||
123 | |||
124 | Datetime Module design | ||
125 | ====================== | ||
126 | |||
127 | The following functions are expected to be implemented in a Datetime module: | ||
128 | |||
129 | **Field creation**:: | ||
130 | |||
131 | __________ __________ | ||
132 | | |----- obj_hook() ---------------------->>>| | | ||
133 | | |<<<----------------returns Mod_data ------| | | ||
134 | | Datetime |_______ | | | ||
135 | | widget | |Assign module call backs | Module | | ||
136 | | base |<<<____| | | | ||
137 | | | | | | ||
138 | | |----- field_create() ------------------>>>| | | ||
139 | |__________|<<<----------------returns field_obj -----|__________| | ||
140 | |||
141 | **Field value setting**:: | ||
142 | |||
143 | __________ __________ | ||
144 | | | | | | ||
145 | | Datetime |<<<----------elm_datetime_value_set()---| | | ||
146 | | widget | | Module | | ||
147 | | base |----display_field_value()------------>>>| | | ||
148 | |__________| |__________| | ||
149 | |||
150 | **del_hook**:: | ||
151 | |||
152 | __________ __________ | ||
153 | | | | | | ||
154 | | Datetime |----obj_unhook()-------------------->>>>| | | ||
155 | | widget | | Module | | ||
156 | | base | <<<-----frees mod_data---------| | | ||
157 | |__________| |__________| | ||
158 | |||
159 | Any module can use the following shared functions that are implemented in | ||
160 | elm_datetime.c: | ||
161 | |||
162 | **field_format_get()** - gives the field format. | ||
163 | |||
164 | **field_limit_get()** - gives the field minimum, maximum limits. | ||
165 | |||
166 | To enable a module, set the ELM_MODULES environment variable as shown: | ||
167 | |||
168 | **export ELM_MODULES="datetime_input_ctxpopup>datetime/api"** | ||
169 | |||
170 | |||
171 | Emitted signals | ||
172 | =============== | ||
173 | |||
174 | - ``changed`` - whenever Datetime field value is changed, this signal is sent. | ||
175 | - ``language,changed`` - whenever system locale changes, this signal is sent. | ||
176 | - ``focused`` - When the datetime has received focus. (since 1.8) | ||
177 | - ``unfocused`` - When the datetime has lost focus. (since 1.8) | ||
178 | |||
179 | |||
180 | Enumerations | ||
181 | ============ | ||
182 | |||
183 | .. _Elm_Datetime_Field_Type: | ||
184 | |||
185 | Datetime fields | ||
186 | --------------- | ||
187 | |||
188 | .. data:: ELM_DATETIME_YEAR | ||
189 | |||
190 | Year | ||
191 | |||
192 | .. data:: ELM_DATETIME_MONTH | ||
193 | |||
194 | Month | ||
195 | |||
196 | .. data:: ELM_DATETIME_DATE | ||
197 | |||
198 | Date | ||
199 | |||
200 | .. data:: ELM_DATETIME_HOUR | ||
201 | |||
202 | Hour | ||
203 | |||
204 | .. data:: ELM_DATETIME_MINUTE | ||
205 | |||
206 | Minute | ||
207 | |||
208 | .. data:: ELM_DATETIME_AMPM | ||
209 | |||
210 | Am/Pm | ||
211 | |||
212 | |||
213 | Inheritance diagram | ||
214 | =================== | ||
215 | |||
216 | .. inheritance-diagram:: Datetime | ||
217 | :parts: 2 | ||
218 | |||
219 | .. autoclass:: Datetime | ||
diff --git a/doc/elementary/dayselector.rst b/doc/elementary/dayselector.rst index 4540b10..7eb0ac8 100644 --- a/doc/elementary/dayselector.rst +++ b/doc/elementary/dayselector.rst | |||
@@ -1,2 +1,99 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.dayselector | 3 | Dayselector |
4 | ########### | ||
5 | |||
6 | .. image:: /images/dayselector-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | Dayselector displays all seven days of the week and allows the user to | ||
13 | select multiple days. | ||
14 | |||
15 | The selection can be toggle by just clicking on the day. | ||
16 | |||
17 | Dayselector also provides the functionality to check whether a day is | ||
18 | selected or not. | ||
19 | |||
20 | First day of the week is taken from config settings by default. It can be | ||
21 | altered by using the API :py:attr:`~Dayselector.week_start` API. | ||
22 | |||
23 | APIs are provided for setting the duration of weekend | ||
24 | :py:attr:`~Dayselector.weekend_start` and :py:attr:`~Dayselector.weekend_length` | ||
25 | does this job. | ||
26 | |||
27 | Two styles of weekdays and weekends are supported in Dayselector. | ||
28 | Application can emit signals on individual check objects for setting the | ||
29 | weekday, weekend styles. | ||
30 | |||
31 | Once the weekend start day or weekend length changes, all the weekday & | ||
32 | weekend styles will be reset to default style. It's the application's | ||
33 | responsibility to set the styles again by sending corresponding signals. | ||
34 | |||
35 | "day0" indicates Sunday, "day1" indicates Monday etc. continues and so, | ||
36 | "day6" indicates the Saturday part name. | ||
37 | |||
38 | Application can change individual day display string by using the API | ||
39 | :py:meth:`~efl.elementary.object.Object.part_text_set`. | ||
40 | |||
41 | :py:meth:`~efl.elementary.object.Object.part_content_set` API sets the | ||
42 | individual day object only if the passed one is a Check widget. | ||
43 | |||
44 | Check object representing a day can be set/get by the application by using | ||
45 | the elm_object_part_content_set/get APIs thus providing a way to handle | ||
46 | the different check styles for individual days. | ||
47 | |||
48 | |||
49 | Emitted signals | ||
50 | =============== | ||
51 | |||
52 | - ``dayselector,changed`` - when the user changes the state of a day. | ||
53 | - ``language,changed`` - the program's language changed | ||
54 | |||
55 | |||
56 | Enumerations | ||
57 | ============ | ||
58 | |||
59 | .. _Elm_Dayselector_Day: | ||
60 | |||
61 | Dayselector days | ||
62 | ---------------- | ||
63 | |||
64 | .. data:: ELM_DAYSELECTOR_SUN | ||
65 | |||
66 | Sunday | ||
67 | |||
68 | .. data:: ELM_DAYSELECTOR_MON | ||
69 | |||
70 | Monday | ||
71 | |||
72 | .. data:: ELM_DAYSELECTOR_TUE | ||
73 | |||
74 | Tuesday | ||
75 | |||
76 | .. data:: ELM_DAYSELECTOR_WED | ||
77 | |||
78 | Wednesday | ||
79 | |||
80 | .. data:: ELM_DAYSELECTOR_THU | ||
81 | |||
82 | Thursday | ||
83 | |||
84 | .. data:: ELM_DAYSELECTOR_FRI | ||
85 | |||
86 | Friday | ||
87 | |||
88 | .. data:: ELM_DAYSELECTOR_SAT | ||
89 | |||
90 | Saturday | ||
91 | |||
92 | |||
93 | Inheritance diagram | ||
94 | =================== | ||
95 | |||
96 | .. inheritance-diagram:: Dayselector | ||
97 | :parts: 2 | ||
98 | |||
99 | .. autoclass:: Dayselector | ||
diff --git a/doc/elementary/diskselector.rst b/doc/elementary/diskselector.rst index 10879bd..76ec557 100644 --- a/doc/elementary/diskselector.rst +++ b/doc/elementary/diskselector.rst | |||
@@ -1,2 +1,72 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.diskselector | 3 | Diskselector |
4 | ############ | ||
5 | |||
6 | .. image:: /images/diskselector-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | A diskselector is a kind of list widget. It scrolls horizontally, | ||
13 | and can contain label and icon objects. Three items are displayed | ||
14 | with the selected one in the middle. | ||
15 | |||
16 | It can act like a circular list with round mode and labels can be | ||
17 | reduced for a defined length for side items. | ||
18 | |||
19 | |||
20 | Emitted signals | ||
21 | =============== | ||
22 | |||
23 | - ``selected`` - when item is selected, i.e. scroller stops. | ||
24 | - ``clicked`` - This is called when a user clicks an item | ||
25 | - ``scroll,anim,start`` - scrolling animation has started | ||
26 | - ``scroll,anim,stop`` - scrolling animation has stopped | ||
27 | - ``scroll,drag,start`` - dragging the diskselector has started | ||
28 | - ``scroll,drag,stop`` - dragging the diskselector has stopped | ||
29 | - ``focused`` - When the diskselector has received focus. (since 1.8) | ||
30 | - ``unfocused`` - When the diskselector has lost focus. (since 1.8) | ||
31 | |||
32 | .. note:: The ``scroll,anim,*`` and ``scroll,drag,*`` signals are only emitted | ||
33 | by user intervention. | ||
34 | |||
35 | Layout content parts | ||
36 | ==================== | ||
37 | |||
38 | - ``icon`` - An icon in the diskselector item | ||
39 | |||
40 | |||
41 | Layout text parts | ||
42 | ================= | ||
43 | |||
44 | - ``default`` - Label of the diskselector item | ||
45 | |||
46 | |||
47 | Scrollable Interface | ||
48 | ==================== | ||
49 | |||
50 | This widget supports the scrollable interface. | ||
51 | |||
52 | If you wish to control the scrolling behaviour using these functions, | ||
53 | inherit both the widget class and the | ||
54 | :py:class:`~efl.elementary.scroller.Scrollable` class | ||
55 | using multiple inheritance, for example:: | ||
56 | |||
57 | class ScrollableGenlist(Genlist, Scrollable): | ||
58 | def __init__(self, canvas, *args, **kwargs): | ||
59 | Genlist.__init__(self, canvas) | ||
60 | |||
61 | |||
62 | Inheritance diagram | ||
63 | =================== | ||
64 | |||
65 | .. inheritance-diagram:: | ||
66 | Diskselector | ||
67 | DiskselectorItem | ||
68 | :parts: 2 | ||
69 | |||
70 | |||
71 | .. autoclass:: Diskselector | ||
72 | .. autoclass:: DiskselectorItem | ||
diff --git a/doc/elementary/elementary.rst b/doc/elementary/elementary.rst index 657598f..197ca59 100644 --- a/doc/elementary/elementary.rst +++ b/doc/elementary/elementary.rst | |||
@@ -1,10 +1,7 @@ | |||
1 | 1 | .. module:: efl.elementary | |
2 | Elementary | ||
3 | ########## | ||
4 | |||
5 | 2 | ||
6 | What is elementary? | 3 | What is elementary? |
7 | =================== | 4 | ******************* |
8 | 5 | ||
9 | Elementary is a the high level toolkit based on the underlying efl | 6 | Elementary is a the high level toolkit based on the underlying efl |
10 | technologies (:doc:`Evas </evas/evas>`, :doc:`Edje </edje/edje>`, | 7 | technologies (:doc:`Evas </evas/evas>`, :doc:`Edje </edje/edje>`, |
@@ -16,10 +13,10 @@ of flexibility. | |||
16 | 13 | ||
17 | 14 | ||
18 | Callbacks | 15 | Callbacks |
19 | ========= | 16 | ********* |
20 | 17 | ||
21 | Widget callbacks | 18 | Widget callbacks |
22 | ---------------- | 19 | ================ |
23 | 20 | ||
24 | Widget callbacks are set with callback_*_add methods which take a callable, | 21 | Widget callbacks are set with callback_*_add methods which take a callable, |
25 | and optional args, kwargs as data. | 22 | and optional args, kwargs as data. |
@@ -34,7 +31,7 @@ or:: | |||
34 | 31 | ||
35 | 32 | ||
36 | Event callbacks | 33 | Event callbacks |
37 | --------------- | 34 | =============== |
38 | 35 | ||
39 | Event callbacks have signature of:: | 36 | Event callbacks have signature of:: |
40 | 37 | ||
@@ -42,91 +39,418 @@ Event callbacks have signature of:: | |||
42 | 39 | ||
43 | 40 | ||
44 | A sample Python Elementary program | 41 | A sample Python Elementary program |
45 | ================================== | 42 | ********************************** |
46 | 43 | ||
47 | .. literalinclude:: ../../examples/elementary/test_win_dialog.py | 44 | .. literalinclude:: ../../examples/elementary/test_win_dialog.py |
48 | :language: python | 45 | :language: python |
49 | 46 | ||
50 | 47 | ||
51 | API Reference | 48 | API Reference |
52 | ============= | 49 | ************* |
50 | |||
51 | |||
52 | Enumerations | ||
53 | ============ | ||
54 | |||
55 | .. _Elm_Object_Layer: | ||
56 | |||
57 | Object layers | ||
58 | ------------- | ||
59 | |||
60 | .. versionadded:: 1.14 | ||
61 | |||
62 | .. data:: ELM_OBJECT_LAYER_BACKGROUND | ||
63 | |||
64 | where to place backgrounds | ||
65 | |||
66 | .. data:: ELM_OBJECT_LAYER_DEFAULT | ||
67 | |||
68 | Evas_Object default layer (and thus for Elementary) | ||
69 | |||
70 | .. data:: ELM_OBJECT_LAYER_FOCUS | ||
71 | |||
72 | where focus object visualization is | ||
73 | |||
74 | .. data:: ELM_OBJECT_LAYER_TOOLTIP | ||
75 | |||
76 | where to show tooltips | ||
77 | |||
78 | .. data:: ELM_OBJECT_LAYER_CURSOR | ||
79 | |||
80 | where to show cursors | ||
81 | |||
82 | .. data:: ELM_OBJECT_LAYER_LAST | ||
83 | |||
84 | last layer known by Elementary | ||
85 | |||
86 | |||
87 | .. _Elm_Policy: | ||
88 | |||
89 | Policy types | ||
90 | ------------ | ||
91 | |||
92 | .. data:: ELM_POLICY_QUIT | ||
93 | |||
94 | Under which circumstances the application should quit automatically. | ||
95 | |||
96 | .. data:: ELM_POLICY_EXIT | ||
97 | |||
98 | Defines elm_exit() behaviour. (since 1.8) | ||
99 | |||
100 | .. data:: ELM_POLICY_THROTTLE | ||
101 | |||
102 | Defines how throttling should work (since 1.8) | ||
103 | |||
104 | |||
105 | .. _Elm_Policy_Quit: | ||
106 | |||
107 | Quit policy types | ||
108 | ----------------- | ||
109 | |||
110 | .. data:: ELM_POLICY_QUIT_NONE | ||
111 | |||
112 | Never quit the application automatically | ||
113 | |||
114 | .. data:: ELM_POLICY_QUIT_LAST_WINDOW_CLOSED | ||
115 | |||
116 | Quit when the application's last window is closed | ||
117 | |||
118 | |||
119 | .. _Elm_Policy_Exit: | ||
120 | |||
121 | Exit policy types | ||
122 | ----------------- | ||
123 | |||
124 | Possible values for the ELM_POLICY_EXIT policy. | ||
125 | |||
126 | .. data:: ELM_POLICY_EXIT_NONE | ||
127 | |||
128 | Just quit the main loop on exit(). | ||
129 | |||
130 | .. data:: ELM_POLICY_EXIT_WINDOWS_DEL | ||
131 | |||
132 | Delete all the windows after quitting the main loop. | ||
133 | |||
134 | |||
135 | .. _Elm_Policy_Throttle: | ||
136 | |||
137 | Throttle policy types | ||
138 | --------------------- | ||
139 | |||
140 | Possible values for the #ELM_POLICY_THROTTLE policy. | ||
141 | |||
142 | .. data:: ELM_POLICY_THROTTLE_CONFIG | ||
143 | |||
144 | Do whatever elementary config is configured to do. | ||
145 | |||
146 | .. data:: ELM_POLICY_THROTTLE_HIDDEN_ALWAYS | ||
147 | |||
148 | Always throttle when all windows are no longer visible. | ||
149 | |||
150 | .. data:: ELM_POLICY_THROTTLE_NEVER | ||
151 | |||
152 | Never throttle when windows are all hidden, regardless of config settings. | ||
153 | |||
154 | |||
155 | .. _Elm_Process_State: | ||
156 | |||
157 | Elm_Process_State | ||
158 | ----------------- | ||
159 | |||
160 | .. data:: ELM_PROCESS_STATE_FOREGROUND | ||
161 | |||
162 | The process is in a foreground/active/running state - work as normal. | ||
163 | |||
164 | .. versionadded:: 1.12 | ||
165 | |||
166 | .. data:: ELM_PROCESS_STATE_BACKGROUND | ||
167 | |||
168 | The process is in the bacgkround, so you may want to stop animating, | ||
169 | fetching data as often etc. | ||
170 | |||
171 | .. versionadded:: 1.12 | ||
172 | |||
173 | |||
174 | .. _Elm_Sys_Notify_Closed_Reason: | ||
175 | |||
176 | Notify close reasons | ||
177 | -------------------- | ||
178 | |||
179 | The reason the notification was closed | ||
180 | |||
181 | .. data:: ELM_SYS_NOTIFY_CLOSED_EXPIRED | ||
182 | |||
183 | The notification expired. | ||
184 | |||
185 | .. versionadded:: 1.10 | ||
186 | |||
187 | .. data:: ELM_SYS_NOTIFY_CLOSED_DISMISSED | ||
188 | |||
189 | The notification was dismissed by the user. | ||
190 | |||
191 | .. versionadded:: 1.10 | ||
192 | |||
193 | .. data:: ELM_SYS_NOTIFY_CLOSED_REQUESTED | ||
194 | |||
195 | The notification was closed by a call to CloseNotification method. | ||
196 | |||
197 | .. versionadded:: 1.10 | ||
198 | |||
199 | .. data:: ELM_SYS_NOTIFY_CLOSED_UNDEFINED | ||
200 | |||
201 | Undefined/reserved reasons. | ||
202 | |||
203 | .. versionadded:: 1.10 | ||
204 | |||
205 | |||
206 | .. _Elm_Sys_Notify_Urgency: | ||
207 | |||
208 | Notify urgency levels | ||
209 | --------------------- | ||
210 | |||
211 | Urgency levels of a notification | ||
212 | |||
213 | :see: :py:func:`sys_notify_send` | ||
214 | |||
215 | .. data:: ELM_SYS_NOTIFY_URGENCY_LOW | ||
216 | |||
217 | Low | ||
218 | |||
219 | .. versionadded:: 1.10 | ||
220 | |||
221 | .. data:: ELM_SYS_NOTIFY_URGENCY_NORMAL | ||
222 | |||
223 | Normal | ||
224 | |||
225 | .. versionadded:: 1.10 | ||
226 | |||
227 | .. data:: ELM_SYS_NOTIFY_URGENCY_CRITICAL | ||
228 | |||
229 | Critical | ||
230 | |||
231 | .. versionadded:: 1.10 | ||
232 | |||
233 | |||
234 | .. _Elm_Glob_Match_Flags: | ||
235 | |||
236 | Glob matching | ||
237 | ------------- | ||
238 | |||
239 | Glob matching bitfiled flags | ||
240 | |||
241 | .. data:: ELM_GLOB_MATCH_NO_ESCAPE | ||
242 | |||
243 | Treat backslash as an ordinary character instead of escape. | ||
244 | |||
245 | .. versionadded:: 1.11 | ||
246 | |||
247 | .. data:: ELM_GLOB_MATCH_PATH | ||
248 | |||
249 | Match a slash in string only with a slash in pattern and not by an | ||
250 | asterisk (*) or a question mark (?) metacharacter, nor by a bracket | ||
251 | expression ([]) containing a slash. | ||
252 | |||
253 | .. versionadded:: 1.11 | ||
254 | |||
255 | .. data:: ELM_GLOB_MATCH_PERIOD | ||
256 | |||
257 | Leading period in string has to be matched exactly by a period in | ||
258 | pattern. A period is considered to be leading if it is the first | ||
259 | character in string, or if both ELM_GLOB_MATCH_PATH is set and the | ||
260 | period immediately follows a slash. | ||
261 | |||
262 | .. versionadded:: 1.11 | ||
263 | |||
264 | .. data:: ELM_GLOB_MATCH_NOCASE | ||
265 | |||
266 | The pattern is matched case-insensitively. | ||
267 | |||
268 | .. versionadded:: 1.11 | ||
269 | |||
270 | |||
271 | .. _General: | ||
272 | |||
273 | General | ||
274 | ======= | ||
275 | |||
276 | General Elementary API. Functions that don't relate to | ||
277 | Elementary objects specifically. | ||
278 | |||
279 | Here are documented functions which init/shutdown the library, | ||
280 | that apply to generic Elementary objects, that deal with | ||
281 | configuration, et cetera. | ||
282 | |||
283 | .. autoclass:: EthumbConnect | ||
284 | .. autoclass:: ConfigAllChanged | ||
285 | .. autoclass:: PolicyChanged | ||
286 | .. autoclass:: ProcessBackground | ||
287 | .. autoclass:: ProcessForeground | ||
288 | |||
289 | .. autofunction:: on_ethumb_connect | ||
290 | .. autofunction:: on_config_all_changed | ||
291 | .. autofunction:: on_policy_changed | ||
292 | .. autofunction:: on_process_background | ||
293 | .. autofunction:: on_process_foreground | ||
294 | |||
295 | .. autofunction:: init | ||
296 | .. autofunction:: shutdown | ||
297 | .. autofunction:: run | ||
298 | .. autofunction:: exit | ||
299 | |||
300 | .. autofunction:: policy_set | ||
301 | .. autofunction:: policy_get | ||
302 | .. autofunction:: language_set | ||
303 | .. autofunction:: process_state_get | ||
304 | |||
305 | |||
306 | .. _Fingers: | ||
307 | |||
308 | Fingers | ||
309 | ======= | ||
310 | |||
311 | Elementary is designed to be finger-friendly for touchscreens, | ||
312 | and so in addition to scaling for display resolution, it can | ||
313 | also scale based on finger "resolution" (or size). You can then | ||
314 | customize the granularity of the areas meant to receive clicks | ||
315 | on touchscreens. | ||
316 | |||
317 | Different profiles may have pre-set values for finger sizes. | ||
318 | |||
319 | .. autofunction:: coords_finger_size_adjust | ||
320 | |||
321 | |||
322 | .. _Caches: | ||
323 | |||
324 | Caches | ||
325 | ====== | ||
326 | |||
327 | These are functions which let one fine-tune some cache values for | ||
328 | Elementary applications, thus allowing for performance adjustments. | ||
329 | |||
330 | .. autofunction:: cache_all_flush | ||
331 | |||
332 | |||
333 | .. _Fonts: | ||
334 | |||
335 | Fonts | ||
336 | ===== | ||
337 | |||
338 | These are functions dealing with font rendering, selection and the | ||
339 | like for Elementary applications. One might fetch which system | ||
340 | fonts are there to use and set custom fonts for individual classes | ||
341 | of UI items containing text (text classes). | ||
342 | |||
343 | .. autofunction:: font_properties_get | ||
344 | .. autofunction:: font_properties_free | ||
345 | |||
346 | .. autofunction:: font_fontconfig_name_get | ||
347 | |||
348 | .. autoclass:: FontProperties | ||
349 | |||
350 | |||
351 | .. _Debug: | ||
352 | |||
353 | Debug | ||
354 | ===== | ||
355 | |||
356 | Don't use them unless you are sure. | ||
357 | |||
358 | .. autofunction:: object_tree_dump | ||
359 | .. autofunction:: object_tree_dot_dump | ||
360 | |||
361 | |||
362 | .. _Sys_Notify: | ||
363 | |||
364 | Sys Notify | ||
365 | ========== | ||
366 | |||
367 | .. autofunction:: sys_notify_close | ||
368 | .. autofunction:: sys_notify_send | ||
369 | |||
370 | .. autofunction:: on_sys_notify_notification_closed | ||
371 | .. autofunction:: on_sys_notify_action_invoked | ||
372 | |||
373 | .. autoclass:: SysNotifyNotificationClosed | ||
374 | .. autoclass:: SysNotifyActionInvoked | ||
375 | |||
376 | |||
377 | Widgets | ||
378 | ======= | ||
53 | 379 | ||
54 | .. toctree:: * | 380 | .. toctree:: * |
55 | :glob: | 381 | :glob: |
56 | :maxdepth: 1 | 382 | :maxdepth: 1 |
57 | 383 | ||
58 | 384 | ||
385 | |||
59 | Inheritance diagram | 386 | Inheritance diagram |
60 | =================== | 387 | =================== |
61 | 388 | ||
62 | .. inheritance-diagram:: | 389 | .. inheritance-diagram:: |
63 | efl.elementary.actionslider | 390 | efl.elementary.Actionslider |
64 | efl.elementary.background | 391 | efl.elementary.Background |
65 | efl.elementary.box | 392 | efl.elementary.Box |
66 | efl.elementary.bubble | 393 | efl.elementary.Bubble |
67 | efl.elementary.button | 394 | efl.elementary.Button |
68 | efl.elementary.calendar_elm | 395 | efl.elementary.Calendar |
69 | efl.elementary.check | 396 | efl.elementary.Check |
70 | efl.elementary.clock | 397 | efl.elementary.Clock |
71 | efl.elementary.colorselector | 398 | efl.elementary.Colorselector |
72 | efl.elementary.configuration | 399 | efl.elementary.Configuration |
73 | efl.elementary.conformant | 400 | efl.elementary.Conformant |
74 | efl.elementary.ctxpopup | 401 | efl.elementary.Ctxpopup |
75 | efl.elementary.datetime_elm | 402 | efl.elementary.Datetime |
76 | efl.elementary.dayselector | 403 | efl.elementary.Dayselector |
77 | efl.elementary.diskselector | 404 | efl.elementary.Diskselector |
78 | efl.elementary.entry | 405 | efl.elementary.Entry |
79 | efl.elementary.fileselector | 406 | efl.elementary.Fileselector |
80 | efl.elementary.fileselector_button | 407 | efl.elementary.FileselectorButton |
81 | efl.elementary.fileselector_entry | 408 | efl.elementary.FileselectorEntry |
82 | efl.elementary.flip | 409 | efl.elementary.Flip |
83 | efl.elementary.flipselector | 410 | efl.elementary.FlipSelector |
84 | efl.elementary.frame | 411 | efl.elementary.Frame |
85 | efl.elementary.general | 412 | efl.elementary.Gengrid |
86 | efl.elementary.gengrid | 413 | efl.elementary.Genlist |
87 | efl.elementary.genlist | 414 | efl.elementary.GestureLayer |
88 | efl.elementary.gesture_layer | 415 | efl.elementary.Grid |
89 | efl.elementary.grid | 416 | efl.elementary.Hover |
90 | efl.elementary.hover | 417 | efl.elementary.Hoversel |
91 | efl.elementary.hoversel | 418 | efl.elementary.Icon |
92 | efl.elementary.icon | 419 | efl.elementary.Image |
93 | efl.elementary.image | 420 | efl.elementary.Index |
94 | efl.elementary.index | 421 | efl.elementary.InnerWindow |
95 | efl.elementary.innerwindow | 422 | efl.elementary.Label |
96 | efl.elementary.label | 423 | efl.elementary.Layout |
97 | efl.elementary.layout | 424 | efl.elementary.List |
98 | efl.elementary.layout_class | 425 | efl.elementary.Map |
99 | efl.elementary.list | 426 | efl.elementary.Mapbuf |
100 | efl.elementary.map | 427 | efl.elementary.Menu |
101 | efl.elementary.mapbuf | 428 | efl.elementary.MultiButtonEntry |
102 | efl.elementary.menu | 429 | efl.elementary.Naviframe |
103 | efl.elementary.multibuttonentry | 430 | efl.elementary.Notify |
104 | efl.elementary.naviframe | 431 | efl.elementary.Object |
105 | efl.elementary.need | 432 | efl.elementary.ObjectItem |
106 | efl.elementary.notify | 433 | efl.elementary.Panel |
107 | efl.elementary.object | 434 | efl.elementary.Panes |
108 | efl.elementary.object_item | 435 | efl.elementary.Photo |
109 | efl.elementary.panel | 436 | efl.elementary.Photocam |
110 | efl.elementary.panes | 437 | efl.elementary.Plug |
111 | efl.elementary.photo | 438 | efl.elementary.Popup |
112 | efl.elementary.photocam | 439 | efl.elementary.Progressbar |
113 | efl.elementary.plug | 440 | efl.elementary.Radio |
114 | efl.elementary.popup | 441 | efl.elementary.Scroller |
115 | efl.elementary.progressbar | 442 | efl.elementary.SegmentControl |
116 | efl.elementary.radio | 443 | efl.elementary.Separator |
117 | efl.elementary.scroller | 444 | efl.elementary.Slider |
118 | efl.elementary.segment_control | 445 | efl.elementary.Slideshow |
119 | efl.elementary.separator | 446 | efl.elementary.Spinner |
120 | efl.elementary.slider | 447 | efl.elementary.Systray |
121 | efl.elementary.slideshow | 448 | efl.elementary.Table |
122 | efl.elementary.spinner | 449 | efl.elementary.Theme |
123 | efl.elementary.systray | 450 | efl.elementary.Thumb |
124 | efl.elementary.table | 451 | efl.elementary.Toolbar |
125 | efl.elementary.theme | 452 | efl.elementary.Transit |
126 | efl.elementary.thumb | 453 | efl.elementary.Video |
127 | efl.elementary.toolbar | 454 | efl.elementary.Web |
128 | efl.elementary.transit | 455 | efl.elementary.Window |
129 | efl.elementary.video | 456 | :parts: 1 |
130 | efl.elementary.web | ||
131 | efl.elementary.window | ||
132 | :parts: 2 | ||
diff --git a/doc/elementary/entry.rst b/doc/elementary/entry.rst index bd5ba13..f25708f 100644 --- a/doc/elementary/entry.rst +++ b/doc/elementary/entry.rst | |||
@@ -1,2 +1,581 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.entry | 3 | Entry |
4 | ##### | ||
5 | |||
6 | .. image:: /images/entry-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | An entry is a convenience widget which shows a box that the user can | ||
13 | enter text into. | ||
14 | |||
15 | Entries by default don't scroll, so they grow to accommodate the entire text, | ||
16 | resizing the parent window as needed. This can be changed with the property | ||
17 | :py:attr:`~efl.elementary.entry.Entry.scrollable`. | ||
18 | |||
19 | They can also be single line or multi line (the default) and when set | ||
20 | to multi line mode they support text wrapping in any of the modes | ||
21 | indicated by :ref:`Elm_Wrap_Type`. | ||
22 | |||
23 | Other features include password mode, filtering of inserted text with | ||
24 | :py:meth:`~efl.elementary.entry.Entry.markup_filter_append` and related | ||
25 | functions, inline "items" and formatted markup text. | ||
26 | |||
27 | |||
28 | Scrollable Interface | ||
29 | ==================== | ||
30 | |||
31 | This widget supports the scrollable interface. | ||
32 | |||
33 | If you wish to control the scolling behaviour using these functions, | ||
34 | inherit both the widget class and the | ||
35 | :py:class:`~efl.elementary.scroller.Scrollable` class | ||
36 | using multiple inheritance, for example:: | ||
37 | |||
38 | class ScrollableGenlist(Genlist, Scrollable): | ||
39 | def __init__(self, canvas, *args, **kwargs): | ||
40 | Genlist.__init__(self, canvas) | ||
41 | |||
42 | |||
43 | Formatted text | ||
44 | ============== | ||
45 | |||
46 | The markup tags supported by the Entry are defined by the theme, but | ||
47 | even when writing new themes or extensions it's a good idea to stick to | ||
48 | a sane default, to maintain coherency and avoid application breakages. | ||
49 | Currently defined by the default theme are the following tags: | ||
50 | |||
51 | ``<br>`` | ||
52 | Inserts a line break. | ||
53 | ``<ps>`` | ||
54 | Inserts a paragraph separator. This is preferred over line | ||
55 | breaks. | ||
56 | ``<tab>`` | ||
57 | Inserts a tab. | ||
58 | ``<em>...</em>`` | ||
59 | Emphasis. Sets the *oblique* style for the | ||
60 | enclosed text. | ||
61 | ``<b>...</b>`` | ||
62 | Sets the **bold** style for the enclosed text. | ||
63 | ``<link>...</link>`` | ||
64 | Underlines the enclosed text. | ||
65 | ``<hilight>...</hilight>`` | ||
66 | Highlights the enclosed text. | ||
67 | |||
68 | |||
69 | Special markups | ||
70 | =============== | ||
71 | |||
72 | Besides those used to format text, entries support two special markup | ||
73 | tags used to insert click-able portions of text or items inlined within | ||
74 | the text. | ||
75 | |||
76 | |||
77 | Anchors | ||
78 | ------- | ||
79 | |||
80 | Anchors are similar to HTML anchors. Text can be surrounded by <a> and | ||
81 | </a> tags and an event will be generated when this text is clicked, | ||
82 | like this:: | ||
83 | |||
84 | This text is outside <a href=anc-01>but this one is an anchor</a> | ||
85 | |||
86 | The ``href`` attribute in the opening tag gives the name that will be | ||
87 | used to identify the anchor and it can be any valid utf8 string. | ||
88 | |||
89 | When an anchor is clicked, an ``"anchor,clicked"`` signal is emitted with | ||
90 | an :py:class:`EntryAnchorInfo` in the ``event_info`` parameter for the | ||
91 | callback function. The same applies for ``anchor,in`` (mouse in), | ||
92 | ``anchor,out`` (mouse out), ``anchor,down`` (mouse down), and ``anchor,up`` | ||
93 | (mouse up) events on an anchor. | ||
94 | |||
95 | |||
96 | Items | ||
97 | ----- | ||
98 | |||
99 | Inlined in the text, any other :py:class:`~efl.elementary.object.Object` can | ||
100 | be inserted by using ``<item>`` tags this way:: | ||
101 | |||
102 | <item size=16x16 vsize=full href=emoticon/haha></item> | ||
103 | |||
104 | Just like with anchors, the ``href`` identifies each item, but these need, | ||
105 | in addition, to indicate their size, which is done using any one of | ||
106 | ``size``, ``absize`` or ``relsize`` attributes. These attributes take their | ||
107 | value in the WxH format, where W is the width and H the height of the | ||
108 | item. | ||
109 | |||
110 | - absize: Absolute pixel size for the item. Whatever value is set will | ||
111 | be the item's size regardless of any scale value the object may have | ||
112 | been set to. The final line height will be adjusted to fit larger items. | ||
113 | - size: Similar to *absize*, but it's adjusted to the scale value set | ||
114 | for the object. | ||
115 | - relsize: Size is adjusted for the item to fit within the current | ||
116 | line height. | ||
117 | |||
118 | Besides their size, items are specified a ``vsize`` value that affects | ||
119 | how their final size and position are calculated. The possible values | ||
120 | are: | ||
121 | |||
122 | - ``ascent``: Item will be placed within the line's baseline and its | ||
123 | ascent. That is, the height between the line where all characters are | ||
124 | positioned and the highest point in the line. For ``size`` and | ||
125 | ``absize`` items, the descent value will be added to the total line | ||
126 | height to make them fit. ``relsize`` items will be adjusted to fit | ||
127 | within this space. | ||
128 | - ``full``: Items will be placed between the descent and ascent, or the | ||
129 | lowest point in the line and its highest. | ||
130 | |||
131 | After the size for an item is calculated, the entry will request an object to | ||
132 | place in its space. For this, the functions set with | ||
133 | :py:meth:`~efl.elementary.entry.Entry.item_provider_append` and related | ||
134 | functions will be called in order until one of them returns a non-*None* value. | ||
135 | If no providers are available, or all of them return *None*, then the entry | ||
136 | falls back to one of the internal defaults, provided the name matches with one | ||
137 | of them. | ||
138 | |||
139 | All of the following are currently supported: | ||
140 | |||
141 | - emoticon/angry | ||
142 | - emoticon/angry-shout | ||
143 | - emoticon/crazy-laugh | ||
144 | - emoticon/evil-laugh | ||
145 | - emoticon/evil | ||
146 | - emoticon/goggle-smile | ||
147 | - emoticon/grumpy | ||
148 | - emoticon/grumpy-smile | ||
149 | - emoticon/guilty | ||
150 | - emoticon/guilty-smile | ||
151 | - emoticon/haha | ||
152 | - emoticon/half-smile | ||
153 | - emoticon/happy-panting | ||
154 | - emoticon/happy | ||
155 | - emoticon/indifferent | ||
156 | - emoticon/kiss | ||
157 | - emoticon/knowing-grin | ||
158 | - emoticon/laugh | ||
159 | - emoticon/little-bit-sorry | ||
160 | - emoticon/love-lots | ||
161 | - emoticon/love | ||
162 | - emoticon/minimal-smile | ||
163 | - emoticon/not-happy | ||
164 | - emoticon/not-impressed | ||
165 | - emoticon/omg | ||
166 | - emoticon/opensmile | ||
167 | - emoticon/smile | ||
168 | - emoticon/sorry | ||
169 | - emoticon/squint-laugh | ||
170 | - emoticon/surprised | ||
171 | - emoticon/suspicious | ||
172 | - emoticon/tongue-dangling | ||
173 | - emoticon/tongue-poke | ||
174 | - emoticon/uh | ||
175 | - emoticon/unhappy | ||
176 | - emoticon/very-sorry | ||
177 | - emoticon/what | ||
178 | - emoticon/wink | ||
179 | - emoticon/worried | ||
180 | - emoticon/wtf | ||
181 | |||
182 | Alternatively, an item may reference an image by its path, using | ||
183 | the URI form ``file:///path/to/an/image.png`` and the entry will then | ||
184 | use that image for the item. | ||
185 | |||
186 | |||
187 | Setting entry's style | ||
188 | ===================== | ||
189 | |||
190 | There are 2 major ways to change the entry's style: | ||
191 | |||
192 | - Theme - set the "base" field to the desired style. | ||
193 | - User style - Pushing overrides to the theme style to the textblock object | ||
194 | by using :py:meth:`~efl.elementary.entry.Entry.text_style_user_push`. | ||
195 | |||
196 | You should modify the theme when you would like to change the style for | ||
197 | aesthetic reasons. While the user style should be changed when you would | ||
198 | like to change the style to something specific defined at run-time, e.g, | ||
199 | setting font or font size in a text editor. | ||
200 | |||
201 | |||
202 | Loading and saving files | ||
203 | ======================== | ||
204 | |||
205 | Entries have convenience functions to load text from a file and save changes | ||
206 | back to it after a short delay. The automatic saving is enabled by default, but | ||
207 | can be disabled with :py:attr:`~efl.elementary.entry.Entry.autosave` and files | ||
208 | can be loaded directly as plain text or have any markup in them recognized. See | ||
209 | :py:attr:`~efl.elementary.entry.Entry.file` for more details. | ||
210 | |||
211 | |||
212 | Emitted signals | ||
213 | =============== | ||
214 | |||
215 | - ``changed``: The text within the entry was changed. | ||
216 | - ``changed,user``: The text within the entry was changed because of user | ||
217 | interaction. | ||
218 | - ``activated``: The enter key was pressed on a single line entry. | ||
219 | - ``aborted``: The escape key was pressed on a single line entry. (since 1.7) | ||
220 | - ``press``: A mouse button has been pressed on the entry. | ||
221 | - ``longpressed``: A mouse button has been pressed and held for a couple | ||
222 | seconds. | ||
223 | - ``clicked``: The entry has been clicked (mouse press and release). | ||
224 | - ``clicked,double``: The entry has been double clicked. | ||
225 | - ``clicked,triple``: The entry has been triple clicked. | ||
226 | - ``focused``: The entry has received focus. | ||
227 | - ``unfocused``: The entry has lost focus. | ||
228 | - ``selection,paste``: A paste of the clipboard contents was requested. | ||
229 | - ``selection,copy``: A copy of the selected text into the clipboard was | ||
230 | requested. | ||
231 | - ``selection,cut``: A cut of the selected text into the clipboard was | ||
232 | requested. | ||
233 | - ``selection,start``: A selection has begun and no previous selection | ||
234 | existed. | ||
235 | - ``selection,changed``: The current selection has changed. | ||
236 | - ``selection,cleared``: The current selection has been cleared. | ||
237 | - ``cursor,changed``: The cursor has changed position. | ||
238 | - ``anchor,clicked``: An anchor has been clicked. The event_info | ||
239 | parameter for the callback will be an :py:class:`EntryAnchorInfo`. | ||
240 | - ``anchor,in``: Mouse cursor has moved into an anchor. The event_info | ||
241 | parameter for the callback will be an :py:class:`EntryAnchorInfo`. | ||
242 | - ``anchor,out``: Mouse cursor has moved out of an anchor. The event_info | ||
243 | parameter for the callback will be an :py:class:`EntryAnchorInfo`. | ||
244 | - ``anchor,up``: Mouse button has been unpressed on an anchor. The event_info | ||
245 | parameter for the callback will be an :py:class:`EntryAnchorInfo`. | ||
246 | - ``anchor,down``: Mouse button has been pressed on an anchor. The event_info | ||
247 | parameter for the callback will be an :py:class:`EntryAnchorInfo`. | ||
248 | - ``preedit,changed``: The preedit string has changed. | ||
249 | - ``language,changed``: Program language changed. | ||
250 | - ``text,set,done``: Whole text has been set to the entry. | ||
251 | - ``rejected``: .Called when some of inputs are rejected by the filter. (since 1.9) | ||
252 | |||
253 | |||
254 | Layout content parts | ||
255 | ==================== | ||
256 | |||
257 | - ``icon`` - An icon in the entry | ||
258 | - ``end`` - A content in the end of the entry | ||
259 | |||
260 | |||
261 | Layout text parts | ||
262 | ================= | ||
263 | |||
264 | - ``default`` - text of the entry | ||
265 | - ``guide`` - placeholder of the entry | ||
266 | |||
267 | |||
268 | Enumerations | ||
269 | ============ | ||
270 | |||
271 | .. _Elm_Entry_Autocapital_Type: | ||
272 | |||
273 | Autocapitalization types | ||
274 | ------------------------ | ||
275 | |||
276 | .. data:: ELM_AUTOCAPITAL_TYPE_NONE | ||
277 | |||
278 | No auto-capitalization when typing | ||
279 | |||
280 | .. data:: ELM_AUTOCAPITAL_TYPE_WORD | ||
281 | |||
282 | Autocapitalize each word typed | ||
283 | |||
284 | .. data:: ELM_AUTOCAPITAL_TYPE_SENTENCE | ||
285 | |||
286 | Autocapitalize the start of each sentence | ||
287 | |||
288 | .. data:: ELM_AUTOCAPITAL_TYPE_ALLCHARACTER | ||
289 | |||
290 | Autocapitalize all letters | ||
291 | |||
292 | |||
293 | .. _Elm_Entry_Cnp_Mode: | ||
294 | |||
295 | Copy & paste modes | ||
296 | ------------------ | ||
297 | |||
298 | .. data:: ELM_CNP_MODE_MARKUP | ||
299 | |||
300 | Copy & paste text with markup tags | ||
301 | |||
302 | .. data:: ELM_CNP_MODE_NO_IMAGE | ||
303 | |||
304 | Copy & paste text without item (image) tags | ||
305 | |||
306 | .. data:: ELM_CNP_MODE_PLAINTEXT | ||
307 | |||
308 | Copy & paste text without markup tags | ||
309 | |||
310 | |||
311 | .. _Elm_Input_Hints: | ||
312 | |||
313 | Input Hints | ||
314 | ----------- | ||
315 | |||
316 | .. data:: ELM_INPUT_HINT_NONE | ||
317 | |||
318 | No active hints | ||
319 | |||
320 | .. versionadded:: 1.12 | ||
321 | |||
322 | .. data:: ELM_INPUT_HINT_AUTO_COMPLETE | ||
323 | |||
324 | Suggest word auto completion | ||
325 | |||
326 | .. versionadded:: 1.12 | ||
327 | |||
328 | .. data:: ELM_INPUT_HINT_SENSITIVE_DATA | ||
329 | |||
330 | typed text should not be stored | ||
331 | |||
332 | .. versionadded:: 1.12 | ||
333 | |||
334 | |||
335 | .. _Elm_Entry_Input_Panel_Lang: | ||
336 | |||
337 | Input panel language sort order | ||
338 | ------------------------------- | ||
339 | |||
340 | .. data:: ELM_INPUT_PANEL_LANG_AUTOMATIC | ||
341 | |||
342 | Automatic | ||
343 | |||
344 | .. data:: ELM_INPUT_PANEL_LANG_ALPHABET | ||
345 | |||
346 | Alphabetic | ||
347 | |||
348 | |||
349 | .. _Elm_Entry_Input_Panel_Layout: | ||
350 | |||
351 | Input panel layouts | ||
352 | ------------------- | ||
353 | |||
354 | .. data:: ELM_INPUT_PANEL_LAYOUT_NORMAL | ||
355 | |||
356 | Default layout | ||
357 | |||
358 | .. data:: ELM_INPUT_PANEL_LAYOUT_NUMBER | ||
359 | |||
360 | Number layout | ||
361 | |||
362 | .. data:: ELM_INPUT_PANEL_LAYOUT_EMAIL | ||
363 | |||
364 | Email layout | ||
365 | |||
366 | .. data:: ELM_INPUT_PANEL_LAYOUT_URL | ||
367 | |||
368 | URL layout | ||
369 | |||
370 | .. data:: ELM_INPUT_PANEL_LAYOUT_PHONENUMBER | ||
371 | |||
372 | Phone number layout | ||
373 | |||
374 | .. data:: ELM_INPUT_PANEL_LAYOUT_IP | ||
375 | |||
376 | IP layout | ||
377 | |||
378 | .. data:: ELM_INPUT_PANEL_LAYOUT_MONTH | ||
379 | |||
380 | Month layout | ||
381 | |||
382 | .. data:: ELM_INPUT_PANEL_LAYOUT_NUMBERONLY | ||
383 | |||
384 | Number only layout | ||
385 | |||
386 | .. data:: ELM_INPUT_PANEL_LAYOUT_INVALID | ||
387 | |||
388 | Never use this | ||
389 | |||
390 | .. data:: ELM_INPUT_PANEL_LAYOUT_HEX | ||
391 | |||
392 | Hexadecimal layout | ||
393 | |||
394 | .. data:: ELM_INPUT_PANEL_LAYOUT_TERMINAL | ||
395 | |||
396 | Command-line terminal layout | ||
397 | |||
398 | .. data:: ELM_INPUT_PANEL_LAYOUT_PASSWORD | ||
399 | |||
400 | Like normal, but no auto-correct, no auto-capitalization etc. | ||
401 | |||
402 | .. data:: ELM_INPUT_PANEL_LAYOUT_DATETIME | ||
403 | |||
404 | Date and time layout | ||
405 | |||
406 | .. versionadded:: 1.10 | ||
407 | |||
408 | .. data:: ELM_INPUT_PANEL_LAYOUT_EMOTICON | ||
409 | |||
410 | Emoticon layout | ||
411 | |||
412 | .. versionadded:: 1.10 | ||
413 | |||
414 | |||
415 | .. _Elm_Input_Panel_Layout_Normal_Variation: | ||
416 | |||
417 | Input panel normal layout variation | ||
418 | ----------------------------------- | ||
419 | |||
420 | .. data:: ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_NORMAL | ||
421 | |||
422 | The plain normal layout | ||
423 | |||
424 | .. versionadded:: 1.12 | ||
425 | |||
426 | .. data:: ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_FILENAME | ||
427 | |||
428 | Filename layout. Symbols such as '/' should be disabled | ||
429 | |||
430 | .. versionadded:: 1.12 | ||
431 | |||
432 | .. data:: ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_PERSON_NAME | ||
433 | |||
434 | The name of a person | ||
435 | |||
436 | .. versionadded:: 1.12 | ||
437 | |||
438 | |||
439 | .. _Elm_Input_Panel_Layout_Numberonly_Variation: | ||
440 | |||
441 | Input panel numberonly layout variation | ||
442 | --------------------------------------- | ||
443 | |||
444 | .. data:: ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_NORMAL | ||
445 | |||
446 | The numberonly normal layout | ||
447 | |||
448 | .. versionadded:: 1.12 | ||
449 | |||
450 | .. data:: ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED | ||
451 | |||
452 | The signed number layout | ||
453 | |||
454 | .. versionadded:: 1.12 | ||
455 | |||
456 | .. data:: ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_DECIMAL | ||
457 | |||
458 | The decimal number layout | ||
459 | |||
460 | .. versionadded:: 1.12 | ||
461 | |||
462 | .. data:: ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED_AND_DECIMAL | ||
463 | |||
464 | The signed and decimal number layout | ||
465 | |||
466 | .. versionadded:: 1.12 | ||
467 | |||
468 | |||
469 | .. _Elm_Input_Panel_Layout_Password_Variation: | ||
470 | |||
471 | Input panel password layout variation | ||
472 | ------------------------------------- | ||
473 | |||
474 | .. data:: ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NORMAL | ||
475 | |||
476 | The normal password layout | ||
477 | |||
478 | .. versionadded:: 1.12 | ||
479 | |||
480 | .. data:: ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NUMBERONLY | ||
481 | |||
482 | The password layout to allow only number | ||
483 | |||
484 | .. versionadded:: 1.12 | ||
485 | |||
486 | |||
487 | .. _Elm_Entry_Input_Panel_Return_Key_Type: | ||
488 | |||
489 | Input panel return key modes | ||
490 | ---------------------------- | ||
491 | |||
492 | .. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT | ||
493 | |||
494 | Default | ||
495 | |||
496 | .. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_DONE | ||
497 | |||
498 | Done | ||
499 | |||
500 | .. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_GO | ||
501 | |||
502 | Go | ||
503 | |||
504 | .. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_JOIN | ||
505 | |||
506 | Join | ||
507 | |||
508 | .. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN | ||
509 | |||
510 | Login | ||
511 | |||
512 | .. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_NEXT | ||
513 | |||
514 | Next | ||
515 | |||
516 | .. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH | ||
517 | |||
518 | Search | ||
519 | |||
520 | .. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEND | ||
521 | |||
522 | Send | ||
523 | |||
524 | .. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_SIGNIN | ||
525 | |||
526 | Sign-in | ||
527 | |||
528 | .. versionadded:: 1.10 | ||
529 | |||
530 | |||
531 | .. _Elm_Entry_Text_Format: | ||
532 | |||
533 | Text format | ||
534 | ----------- | ||
535 | |||
536 | .. data:: ELM_TEXT_FORMAT_PLAIN_UTF8 | ||
537 | |||
538 | Plain UTF-8 type | ||
539 | |||
540 | .. data:: ELM_TEXT_FORMAT_MARKUP_UTF8 | ||
541 | |||
542 | UTF-8 with markup | ||
543 | |||
544 | |||
545 | .. _Elm_Wrap_Type: | ||
546 | |||
547 | Wrap mode | ||
548 | --------- | ||
549 | |||
550 | .. data:: ELM_WRAP_NONE | ||
551 | |||
552 | No wrap | ||
553 | |||
554 | .. data:: ELM_WRAP_CHAR | ||
555 | |||
556 | Wrap between characters | ||
557 | |||
558 | .. data:: ELM_WRAP_WORD | ||
559 | |||
560 | Wrap in allowed wrapping points (as defined in the unicode standard) | ||
561 | |||
562 | .. data:: ELM_WRAP_MIXED | ||
563 | |||
564 | Word wrap, and if that fails, char wrap | ||
565 | |||
566 | |||
567 | Inheritance diagram | ||
568 | =================== | ||
569 | |||
570 | .. inheritance-diagram:: Entry | ||
571 | :parts: 2 | ||
572 | |||
573 | .. autofunction:: markup_to_utf8 | ||
574 | .. autofunction:: utf8_to_markup | ||
575 | |||
576 | .. autoclass:: Entry | ||
577 | .. autoclass:: EntryContextMenuItem | ||
578 | .. autoclass:: FilterLimitSize | ||
579 | .. autoclass:: FilterAcceptSet | ||
580 | .. autoclass:: EntryAnchorInfo | ||
581 | .. autoclass:: EntryAnchorHoverInfo | ||
diff --git a/doc/elementary/fileselector.rst b/doc/elementary/fileselector.rst index 00ddcf4..96da8c2 100644 --- a/doc/elementary/fileselector.rst +++ b/doc/elementary/fileselector.rst | |||
@@ -1,2 +1,137 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.fileselector | 3 | Fileselector |
4 | ############ | ||
5 | |||
6 | .. image:: /images/fileselector-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | A file selector is a widget that allows a user to navigate through a | ||
13 | file system, reporting file selections back via its API. | ||
14 | |||
15 | It contains shortcut buttons for home directory (*~*) and to jump one | ||
16 | directory upwards (..), as well as cancel/ok buttons to confirm/cancel a | ||
17 | given selection. After either one of those two former actions, the file | ||
18 | selector will issue its ``"done"`` smart callback. | ||
19 | |||
20 | There's a text entry on it, too, showing the name of the current | ||
21 | selection. There's the possibility of making it editable, so it is | ||
22 | useful on file saving dialogs on applications, where one gives a file | ||
23 | name to save contents to, in a given directory in the system. This | ||
24 | custom file name will be reported on the ``"done"`` smart callback | ||
25 | (explained in sequence). | ||
26 | |||
27 | Finally, it has a view to display file system items into in two possible | ||
28 | forms: | ||
29 | |||
30 | - list | ||
31 | - grid | ||
32 | |||
33 | If Elementary is built with support of the Ethumb thumbnailing library, | ||
34 | the second form of view will display preview thumbnails of files which | ||
35 | it supports. | ||
36 | |||
37 | |||
38 | Emitted signals | ||
39 | =============== | ||
40 | |||
41 | - ``activated`` - the user activated a file. This can happen by | ||
42 | double-clicking or pressing Enter key. (**event_info** is a string with the | ||
43 | activated file path) | ||
44 | - ``selected`` - the user has clicked on a file (when not in folders-only | ||
45 | mode) or directory (when in folders-only mode) | ||
46 | - ``directory,open`` - the list has been populated with new content | ||
47 | (*event_info* is the directory's path) | ||
48 | - ``done`` - the user has clicked on the "ok" or "cancel" | ||
49 | buttons (*event_info* is the selection's path) | ||
50 | |||
51 | |||
52 | Layout text parts | ||
53 | ================= | ||
54 | |||
55 | - ``ok`` - OK button label if the ok button is set. (since 1.8) | ||
56 | - ``cancel`` - Cancel button label if the cancel button is set. (since 1.8) | ||
57 | |||
58 | |||
59 | Enumerations | ||
60 | ============ | ||
61 | |||
62 | .. _Elm_Fileselector_Mode: | ||
63 | |||
64 | Fileselector modes | ||
65 | ------------------ | ||
66 | |||
67 | .. data:: ELM_FILESELECTOR_LIST | ||
68 | |||
69 | Layout as a list | ||
70 | |||
71 | .. data:: ELM_FILESELECTOR_GRID | ||
72 | |||
73 | Layout as a grid | ||
74 | |||
75 | |||
76 | .. _Elm_Fileselector_Sort: | ||
77 | |||
78 | Fileselector sort method | ||
79 | ------------------------ | ||
80 | |||
81 | .. data:: ELM_FILESELECTOR_SORT_BY_FILENAME_ASC | ||
82 | |||
83 | Sort by filename in ascending order | ||
84 | |||
85 | .. versionadded:: 1.9 | ||
86 | |||
87 | .. data:: ELM_FILESELECTOR_SORT_BY_FILENAME_DESC | ||
88 | |||
89 | Sort by filename in descending order | ||
90 | |||
91 | .. versionadded:: 1.9 | ||
92 | |||
93 | .. data:: ELM_FILESELECTOR_SORT_BY_TYPE_ASC | ||
94 | |||
95 | Sort by file type in ascending order | ||
96 | |||
97 | .. versionadded:: 1.9 | ||
98 | |||
99 | .. data:: ELM_FILESELECTOR_SORT_BY_TYPE_DESC | ||
100 | |||
101 | Sort by file type in descending order | ||
102 | |||
103 | .. versionadded:: 1.9 | ||
104 | |||
105 | .. data:: ELM_FILESELECTOR_SORT_BY_SIZE_ASC | ||
106 | |||
107 | Sort by file size in ascending order | ||
108 | |||
109 | .. versionadded:: 1.9 | ||
110 | |||
111 | .. data:: ELM_FILESELECTOR_SORT_BY_SIZE_DESC | ||
112 | |||
113 | Sort by file size in descending order | ||
114 | |||
115 | .. versionadded:: 1.9 | ||
116 | |||
117 | .. data:: ELM_FILESELECTOR_SORT_BY_MODIFIED_ASC | ||
118 | |||
119 | Sort by file modification date in ascending order | ||
120 | |||
121 | .. versionadded:: 1.9 | ||
122 | |||
123 | .. data:: ELM_FILESELECTOR_SORT_BY_MODIFIED_DESC | ||
124 | |||
125 | Sort by file modification date in descending order | ||
126 | |||
127 | .. versionadded:: 1.9 | ||
128 | |||
129 | |||
130 | Inheritance diagram | ||
131 | =================== | ||
132 | |||
133 | .. inheritance-diagram:: Fileselector | ||
134 | :parts: 2 | ||
135 | |||
136 | |||
137 | .. autoclass:: Fileselector | ||
diff --git a/doc/elementary/fileselector_button.rst b/doc/elementary/fileselector_button.rst index b2566b7..fd06331 100644 --- a/doc/elementary/fileselector_button.rst +++ b/doc/elementary/fileselector_button.rst | |||
@@ -1,2 +1,75 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.fileselector_button | 3 | Fileselector Button |
4 | ################### | ||
5 | |||
6 | .. image:: /images/fileselector-button-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | This is a button that, when clicked, creates an Elementary window (or | ||
13 | inner window) with a :py:class:`~efl.elementary.fileselector.Fileselector` | ||
14 | within. | ||
15 | |||
16 | When a file is chosen, the (inner) window is closed and the button emits | ||
17 | a signal having the selected file as it's ``event_info``. | ||
18 | |||
19 | This widget encapsulates operations on its internal file selector on its | ||
20 | own API. There is less control over its file selector than that one | ||
21 | would have instantiating one directly. | ||
22 | |||
23 | |||
24 | Available styles | ||
25 | ================ | ||
26 | |||
27 | - ``default`` | ||
28 | - ``anchor`` | ||
29 | - ``hoversel_vertical`` | ||
30 | - ``hoversel_vertical_entry`` | ||
31 | |||
32 | |||
33 | Emitted signals | ||
34 | =============== | ||
35 | |||
36 | - ``file,chosen`` - the user has selected a path which comes as the | ||
37 | ``event_info`` data | ||
38 | - ``language,changed`` - the program's language changed | ||
39 | |||
40 | |||
41 | Layout text parts | ||
42 | ================= | ||
43 | |||
44 | - ``default`` - Label of the fileselector_button | ||
45 | |||
46 | |||
47 | Layout content parts | ||
48 | ==================== | ||
49 | |||
50 | - ``icon`` - Icon of the fileselector_button | ||
51 | |||
52 | |||
53 | Fileselector Interface | ||
54 | ====================== | ||
55 | |||
56 | This widget supports the fileselector interface. | ||
57 | |||
58 | If you wish to control the fileselector part using these functions, | ||
59 | inherit both the widget class and the | ||
60 | :py:class:`~efl.elementary.fileselector.Fileselector` class | ||
61 | using multiple inheritance, for example:: | ||
62 | |||
63 | class CustomFileselectorButton(Fileselector, FileselectorButton): | ||
64 | def __init__(self, canvas, *args, **kwargs): | ||
65 | FileselectorButton.__init__(self, canvas) | ||
66 | |||
67 | |||
68 | Inheritance diagram | ||
69 | =================== | ||
70 | |||
71 | .. inheritance-diagram:: FileselectorButton | ||
72 | :parts: 2 | ||
73 | |||
74 | |||
75 | .. autoclass:: FileselectorButton | ||
diff --git a/doc/elementary/fileselector_entry.rst b/doc/elementary/fileselector_entry.rst index 8479474..b916ab4 100644 --- a/doc/elementary/fileselector_entry.rst +++ b/doc/elementary/fileselector_entry.rst | |||
@@ -1,2 +1,90 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.fileselector_entry | 3 | Fileselector Entry |
4 | ################## | ||
5 | |||
6 | .. image:: /images/fileselector-entry-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | This is an entry made to be filled with or display a file | ||
13 | system path string. | ||
14 | |||
15 | Besides the entry itself, the widget has a | ||
16 | :py:class:`~efl.elementary.fileselector_button.FileselectorButton` on its side, | ||
17 | which will raise an internal | ||
18 | :py:class:`~efl.elementary.fileselector.Fileselector`, when clicked, for path | ||
19 | selection aided by file system navigation. | ||
20 | |||
21 | This file selector may appear in an Elementary window or in an | ||
22 | inner window. When a file is chosen from it, the (inner) window | ||
23 | is closed and the selected file's path string is exposed both as | ||
24 | a smart event and as the new text on the entry. | ||
25 | |||
26 | This widget encapsulates operations on its internal file | ||
27 | selector on its own API. There is less control over its file | ||
28 | selector than that one would have instantiating one directly. | ||
29 | |||
30 | |||
31 | Emitted signals | ||
32 | =============== | ||
33 | |||
34 | - ``changed`` - The text within the entry was changed | ||
35 | - ``activated`` - The entry has had editing finished and | ||
36 | changes are to be "committed" | ||
37 | - ``press`` - The entry has been clicked | ||
38 | - ``longpressed`` - The entry has been clicked (and held) for a | ||
39 | couple seconds | ||
40 | - ``clicked`` - The entry has been clicked | ||
41 | - ``clicked,double`` - The entry has been double clicked | ||
42 | - ``focused`` - The entry has received focus | ||
43 | - ``unfocused`` - The entry has lost focus | ||
44 | - ``selection,paste`` - A paste action has occurred on the | ||
45 | entry | ||
46 | - ``selection,copy`` - A copy action has occurred on the entry | ||
47 | - ``selection,cut`` - A cut action has occurred on the entry | ||
48 | - ``unpressed`` - The file selector entry's button was released | ||
49 | after being pressed. | ||
50 | - ``file,chosen`` - The user has selected a path via the file | ||
51 | selector entry's internal file selector, whose string | ||
52 | comes as the ``event_info`` data. | ||
53 | - ``language,changed`` - the program's language changed | ||
54 | |||
55 | |||
56 | Layout text parts | ||
57 | ================= | ||
58 | |||
59 | - ``default`` - Label of the fileselector_button | ||
60 | |||
61 | |||
62 | Layout content parts | ||
63 | ==================== | ||
64 | |||
65 | - ``button icon`` - Button icon of the fileselector_entry | ||
66 | |||
67 | |||
68 | Fileselector Interface | ||
69 | ====================== | ||
70 | |||
71 | This widget supports the fileselector interface. | ||
72 | |||
73 | If you wish to control the fileselector part using these functions, | ||
74 | inherit both the widget class and the | ||
75 | :py:class:`~efl.elementary.fileselector.Fileselector` class | ||
76 | using multiple inheritance, for example:: | ||
77 | |||
78 | class CustomFileselectorButton(Fileselector, FileselectorButton): | ||
79 | def __init__(self, canvas, *args, **kwargs): | ||
80 | FileselectorButton.__init__(self, canvas) | ||
81 | |||
82 | |||
83 | Inheritance diagram | ||
84 | =================== | ||
85 | |||
86 | .. inheritance-diagram:: FileselectorEntry | ||
87 | :parts: 2 | ||
88 | |||
89 | |||
90 | .. autoclass:: FileselectorEntry | ||
diff --git a/doc/elementary/flip.rst b/doc/elementary/flip.rst index 0644602..0e3ae83 100644 --- a/doc/elementary/flip.rst +++ b/doc/elementary/flip.rst | |||
@@ -1,2 +1,164 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.flip | 3 | Flip |
4 | #### | ||
5 | |||
6 | .. image:: /images/flip-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | This widget holds two content :py:class:`efl.evas.Object`: one on | ||
13 | the front and one on the back. It allows you to flip from front to back | ||
14 | and vice-versa using various animations. | ||
15 | |||
16 | If either the front or back contents are not set the flip will treat that | ||
17 | as transparent. So if you were to set the front content but not the back, | ||
18 | and then call :py:meth:`Flip.go` you would see whatever is below the flip. | ||
19 | |||
20 | For a list of supported animations see :py:meth:`Flip.go`. | ||
21 | |||
22 | |||
23 | Emitted signals | ||
24 | =============== | ||
25 | |||
26 | - ``animate,begin`` - when a flip animation was started | ||
27 | - ``animate,done`` - when a flip animation is finished | ||
28 | |||
29 | |||
30 | Layout content parts | ||
31 | ==================== | ||
32 | |||
33 | - ``front`` - A front content of the flip | ||
34 | - ``back`` - A back content of the flip | ||
35 | |||
36 | |||
37 | Enumerations | ||
38 | ============ | ||
39 | |||
40 | .. _Elm_Flip_Direction: | ||
41 | |||
42 | Flip directions | ||
43 | --------------- | ||
44 | |||
45 | .. data:: ELM_FLIP_DIRECTION_UP | ||
46 | |||
47 | Allows interaction with the top of the widget. | ||
48 | |||
49 | .. data:: ELM_FLIP_DIRECTION_DOWN | ||
50 | |||
51 | Allows interaction with the bottom of the widget. | ||
52 | |||
53 | .. data:: ELM_FLIP_DIRECTION_LEFT | ||
54 | |||
55 | Allows interaction with the left portion of | ||
56 | |||
57 | the widget. | ||
58 | .. data:: ELM_FLIP_DIRECTION_RIGHT | ||
59 | |||
60 | Allows interaction with the right portion of | ||
61 | |||
62 | the widget. | ||
63 | |||
64 | |||
65 | .. _Elm_Flip_Interaction: | ||
66 | |||
67 | Flip interaction modes | ||
68 | ---------------------- | ||
69 | |||
70 | .. data:: ELM_FLIP_INTERACTION_NONE | ||
71 | |||
72 | No interaction is allowed | ||
73 | |||
74 | .. data:: ELM_FLIP_INTERACTION_ROTATE | ||
75 | |||
76 | Interaction will cause rotate animation | ||
77 | |||
78 | .. data:: ELM_FLIP_INTERACTION_CUBE | ||
79 | |||
80 | Interaction will cause cube animation | ||
81 | |||
82 | .. data:: ELM_FLIP_INTERACTION_PAGE | ||
83 | |||
84 | Interaction will cause page animation | ||
85 | |||
86 | |||
87 | .. _Elm_Flip_Mode: | ||
88 | |||
89 | Flip types | ||
90 | ---------- | ||
91 | |||
92 | .. data:: ELM_FLIP_ROTATE_Y_CENTER_AXIS | ||
93 | |||
94 | Rotate the currently visible content around a vertical axis in the | ||
95 | middle of its width, the other content is shown as the other side of the | ||
96 | flip. | ||
97 | |||
98 | .. data:: ELM_FLIP_ROTATE_X_CENTER_AXIS | ||
99 | |||
100 | Rotate the currently visible content around a horizontal axis in the | ||
101 | middle of its height, the other content is shown as the other side of | ||
102 | the flip. | ||
103 | |||
104 | .. data:: ELM_FLIP_ROTATE_XZ_CENTER_AXIS | ||
105 | |||
106 | Rotate the currently visible content around a diagonal axis in the | ||
107 | middle of its width, the other content is shown as the other side of the | ||
108 | flip. | ||
109 | |||
110 | .. data:: ELM_FLIP_ROTATE_YZ_CENTER_AXIS | ||
111 | |||
112 | Rotate the currently visible content around a diagonal axis in the | ||
113 | middle of its height, the other content is shown as the other side of | ||
114 | the flip. | ||
115 | |||
116 | .. data:: ELM_FLIP_CUBE_LEFT | ||
117 | |||
118 | Rotate the currently visible content to the left as if the flip was a | ||
119 | cube, the other content is show as the right face of the cube. | ||
120 | |||
121 | .. data:: ELM_FLIP_CUBE_RIGHT | ||
122 | |||
123 | Rotate the currently visible content to the right as if the flip was a | ||
124 | cube, the other content is show as the left face of the cube. | ||
125 | |||
126 | .. data:: ELM_FLIP_CUBE_UP | ||
127 | |||
128 | Rotate the currently visible content up as if the flip was a cube, the | ||
129 | other content is show as the bottom face of the cube. | ||
130 | |||
131 | .. data:: ELM_FLIP_CUBE_DOWN | ||
132 | |||
133 | Rotate the currently visible content down as if the flip was a cube, the | ||
134 | other content is show as the upper face of the cube. | ||
135 | |||
136 | .. data:: ELM_FLIP_PAGE_LEFT | ||
137 | |||
138 | Move the currently visible content to the left as if the flip was a | ||
139 | book, the other content is shown as the page below that. | ||
140 | |||
141 | .. data:: ELM_FLIP_PAGE_RIGHT | ||
142 | |||
143 | Move the currently visible content to the right as if the flip was a | ||
144 | book, the other content is shown as the page below that. | ||
145 | |||
146 | .. data:: ELM_FLIP_PAGE_UP | ||
147 | |||
148 | Move the currently visible content up as if the flip was a book, the | ||
149 | other content is shown as the page below that. | ||
150 | |||
151 | .. data:: ELM_FLIP_PAGE_DOWN | ||
152 | |||
153 | Move the currently visible content down as if the flip was a book, the | ||
154 | other content is shown as the page below that. | ||
155 | |||
156 | |||
157 | Inheritance diagram | ||
158 | =================== | ||
159 | |||
160 | .. inheritance-diagram:: Flip | ||
161 | :parts: 2 | ||
162 | |||
163 | |||
164 | .. autoclass:: Flip | ||
diff --git a/doc/elementary/flipselector.rst b/doc/elementary/flipselector.rst index 0bf5cf1..aa4e4af 100644 --- a/doc/elementary/flipselector.rst +++ b/doc/elementary/flipselector.rst | |||
@@ -1,2 +1,52 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.flipselector | 3 | Flipselector |
4 | ############ | ||
5 | |||
6 | .. image:: /images/flipselector-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | A flip selector is a widget to show a set of *text* items, one at a time, with | ||
13 | the same sheet switching style as the :py:class:`~efl.elementary.clock.Clock` | ||
14 | widget, when one changes the current displaying sheet (thus, the "flip" in the | ||
15 | name). | ||
16 | |||
17 | User clicks to flip sheets which are *held* for some time will | ||
18 | make the flip selector to flip continuously and automatically for | ||
19 | the user. The interval between flips will keep growing in time, | ||
20 | so that it helps the user to reach an item which is distant from | ||
21 | the current selection. | ||
22 | |||
23 | |||
24 | Emitted signals | ||
25 | =============== | ||
26 | |||
27 | - ``selected`` - when the widget's selected text item is changed | ||
28 | - ``overflowed`` - when the widget's current selection is changed | ||
29 | from the first item in its list to the last | ||
30 | - ``underflowed`` - when the widget's current selection is changed | ||
31 | from the last item in its list to the first | ||
32 | - ``focused`` - When the flipselector has received focus. (since 1.8) | ||
33 | - ``unfocused`` - When the flipselector has lost focus. (since 1.8) | ||
34 | |||
35 | |||
36 | Layout text parts | ||
37 | ================= | ||
38 | |||
39 | - ``default`` - label of the flipselector item | ||
40 | |||
41 | |||
42 | Inheritance diagram | ||
43 | =================== | ||
44 | |||
45 | .. inheritance-diagram:: | ||
46 | FlipSelector | ||
47 | FlipSelectorItem | ||
48 | :parts: 2 | ||
49 | |||
50 | |||
51 | .. autoclass:: FlipSelector | ||
52 | .. autoclass:: FlipSelectorItem | ||
diff --git a/doc/elementary/frame.rst b/doc/elementary/frame.rst index c87a2d2..ce18e88 100644 --- a/doc/elementary/frame.rst +++ b/doc/elementary/frame.rst | |||
@@ -1,2 +1,54 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.frame | 3 | Frame |
4 | ##### | ||
5 | |||
6 | .. image:: /images/frame-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | Frame is a widget that holds some content and has a title. | ||
13 | |||
14 | |||
15 | Available styles | ||
16 | ================ | ||
17 | |||
18 | - default | ||
19 | - pad_small | ||
20 | - pad_medium | ||
21 | - pad_large | ||
22 | - pad_huge | ||
23 | - outdent_top | ||
24 | - outdent_bottom | ||
25 | |||
26 | Out of all these styles only default shows the title. | ||
27 | |||
28 | |||
29 | Emitted signals | ||
30 | =============== | ||
31 | |||
32 | - ``clicked`` - The user has clicked the frame's label | ||
33 | |||
34 | |||
35 | Layout content parts | ||
36 | ==================== | ||
37 | |||
38 | - ``default`` - A content of the frame | ||
39 | |||
40 | |||
41 | Layout text parts | ||
42 | ================= | ||
43 | |||
44 | - ``default`` - Label of the frame | ||
45 | |||
46 | |||
47 | Inheritance diagram | ||
48 | =================== | ||
49 | |||
50 | .. inheritance-diagram:: Frame | ||
51 | :parts: 2 | ||
52 | |||
53 | |||
54 | .. autoclass:: 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..294fb9b 100644 --- a/doc/elementary/gengrid.rst +++ b/doc/elementary/gengrid.rst | |||
@@ -1,2 +1,329 @@ | |||
1 | .. currentmodule:: efl.elementary | ||
1 | 2 | ||
2 | .. automodule:: efl.elementary.gengrid | 3 | Gengrid |
4 | ####### | ||
5 | |||
6 | .. image:: /images/gengrid-preview.png | ||
7 | |||
8 | |||
9 | Widget description | ||
10 | ================== | ||
11 | |||
12 | This widget aims to position objects in a grid layout while actually | ||
13 | creating and rendering only the visible ones, using the same idea as the | ||
14 | :py:class:`~efl.elementary.genlist.Genlist`: the user defines a **class** for | ||
15 | each item, specifying functions that will be called at object creation, | ||
16 | deletion, etc. When those items are selected by the user, a callback | ||
17 | function is issued. Users may interact with a gengrid via the mouse (by | ||
18 | clicking on items to select them and clicking on the grid's viewport and | ||
19 | swiping to pan the whole view) or via the keyboard, navigating through | ||
20 | item with the arrow keys. | ||
21 | |||
22 | |||