From 660c0a7e5131d3b68f1ff1adbf317b5983cd3046 Mon Sep 17 00:00:00 2001 From: Dave Andreoli Date: Sun, 18 Jan 2015 19:07:06 +0100 Subject: [PATCH] Huge documentation work Improved structure, contents and style for better readability --- doc/edje/edje.rst | 80 +-------------------- doc/edje/edje_module.rst | 5 -- doc/edje/edje_object.rst | 7 -- doc/elementary/actionslider.rst | 6 -- doc/elementary/background.rst | 6 -- doc/elementary/box.rst | 6 -- doc/elementary/bubble.rst | 6 -- doc/elementary/button.rst | 5 -- doc/elementary/calendar.rst | 6 -- doc/elementary/check.rst | 6 -- doc/elementary/clock.rst | 6 -- doc/elementary/colorselector.rst | 6 -- doc/elementary/configuration.rst | 2 - doc/elementary/conformant.rst | 6 -- doc/elementary/ctxpopup.rst | 6 -- doc/elementary/datetime.rst | 6 -- doc/elementary/dayselector.rst | 6 -- doc/elementary/diskselector.rst | 6 -- doc/elementary/elementary.rst | 93 ++++-------------------- doc/elementary/elementary_module.rst | 5 -- doc/elementary/entry.rst | 6 -- doc/elementary/fileselector.rst | 6 -- doc/elementary/fileselector_button.rst | 6 -- doc/elementary/fileselector_entry.rst | 6 -- doc/elementary/flip.rst | 6 -- doc/elementary/flipselector.rst | 6 -- doc/elementary/frame.rst | 6 -- doc/elementary/general.rst | 2 - doc/elementary/gengrid.rst | 6 -- doc/elementary/genlist.rst | 9 --- doc/elementary/gesture_layer.rst | 6 -- doc/elementary/grid.rst | 6 -- doc/elementary/hover.rst | 6 -- doc/elementary/hoversel.rst | 6 -- doc/elementary/icon.rst | 6 -- doc/elementary/image.rst | 6 -- doc/elementary/index.rst | 6 -- doc/elementary/innerwindow.rst | 6 -- doc/elementary/label.rst | 6 -- doc/elementary/layout.rst | 6 -- doc/elementary/layout_class.rst | 6 -- doc/elementary/list.rst | 6 -- doc/elementary/map.rst | 6 -- doc/elementary/mapbuf.rst | 6 -- doc/elementary/menu.rst | 6 -- doc/elementary/multibuttonentry.rst | 6 -- doc/elementary/naviframe.rst | 6 -- doc/elementary/need.rst | 2 - doc/elementary/notify.rst | 6 -- doc/elementary/object.rst | 6 -- doc/elementary/object_item.rst | 6 -- doc/elementary/panel.rst | 6 -- doc/elementary/panes.rst | 6 -- doc/elementary/photo.rst | 6 -- doc/elementary/photocam.rst | 6 -- doc/elementary/plug.rst | 6 -- doc/elementary/popup.rst | 6 -- doc/elementary/progressbar.rst | 6 -- doc/elementary/radio.rst | 6 -- doc/elementary/scroller.rst | 6 -- doc/elementary/segment_control.rst | 6 -- doc/elementary/separator.rst | 6 -- doc/elementary/slider.rst | 6 -- doc/elementary/slideshow.rst | 6 -- doc/elementary/spinner.rst | 6 -- doc/elementary/table.rst | 6 -- doc/elementary/theme.rst | 6 -- doc/elementary/thumb.rst | 6 -- doc/elementary/toolbar.rst | 6 -- doc/elementary/transit.rst | 6 -- doc/elementary/video.rst | 6 -- doc/elementary/web.rst | 6 -- doc/elementary/window.rst | 6 -- doc/emotion/emotion.rst | 96 +------------------------ doc/emotion/emotion_module.rst | 5 -- doc/emotion/emotion_object.rst | 6 -- doc/evas/evas.rst | 48 ++++++------- doc/index.rst | 34 ++++----- doc/themes/efldoc/layout.html | 1 + doc/themes/efldoc/static/efl.css | 43 +++++++++++- efl/ecore/efl.ecore.pyx | 20 ++++-- efl/edje/efl.edje.pyx | 97 ++++++++++++++++++++++++++ efl/edje/efl.edje_object.pxi | 43 ++---------- efl/elementary/actionslider.pyx | 26 +++++-- efl/elementary/background.pyx | 20 ++++-- efl/elementary/box.pyx | 20 ++++-- efl/elementary/bubble.pyx | 38 +++++++--- efl/elementary/button.pyx | 70 ++++++++++++------- efl/elementary/calendar_elm.pyx | 31 +++++--- efl/elementary/check.pyx | 29 ++++++-- efl/elementary/clock.pyx | 25 +++++-- efl/elementary/colorselector.pyx | 25 +++++-- efl/elementary/configuration.pyx | 22 ++++-- efl/elementary/conformant.pyx | 26 ++++--- efl/elementary/ctxpopup.pyx | 41 +++++++---- efl/elementary/datetime_elm.pyx | 22 ++++-- efl/elementary/dayselector.pyx | 26 ++++--- efl/elementary/diskselector.pyx | 31 +++++--- efl/elementary/entry.pyx | 64 +++++++++++------ efl/elementary/fileselector.pyx | 42 +++++++---- efl/elementary/fileselector_button.pyx | 34 ++++++--- efl/elementary/fileselector_entry.pyx | 28 ++++++-- efl/elementary/flip.pyx | 38 ++++++---- efl/elementary/flipselector.pyx | 27 ++++--- efl/elementary/frame.pyx | 31 ++++++-- efl/elementary/general.pyx | 11 ++- efl/elementary/gengrid.pyx | 32 ++++++--- efl/elementary/genlist.pyx | 40 ++++++++--- efl/elementary/gesture_layer.pyx | 19 +++-- efl/elementary/glview.pyx | 8 +-- efl/elementary/grid.pyx | 13 +++- efl/elementary/hover.pyx | 33 ++++++--- efl/elementary/hoversel.pyx | 33 ++++++--- efl/elementary/icon.pyx | 24 +++++-- efl/elementary/image.pyx | 23 ++++-- efl/elementary/index.pyx | 18 ++++- efl/elementary/innerwindow.pyx | 26 +++++-- efl/elementary/label.pyx | 30 ++++++-- efl/elementary/layout.pyx | 21 +++++- efl/elementary/layout_class.pyx | 67 +++++++++++------- efl/elementary/list.pyx | 42 ++++++++--- efl/elementary/map.pyx | 31 +++++--- efl/elementary/mapbuf.pyx | 20 ++++-- efl/elementary/menu.pyx | 25 +++++-- efl/elementary/multibuttonentry.pyx | 24 +++++-- efl/elementary/naviframe.pyx | 32 ++++++--- efl/elementary/need.pyx | 14 ++++ efl/elementary/notify.pyx | 25 +++++-- efl/elementary/object.pyx | 32 ++++++--- efl/elementary/object_item.pyx | 17 ++++- efl/elementary/panel.pyx | 31 ++++---- efl/elementary/panes.pyx | 27 ++++--- efl/elementary/photo.pyx | 17 ++++- efl/elementary/photocam.pyx | 23 ++++-- efl/elementary/plug.pyx | 19 ++++- efl/elementary/popup.pyx | 43 +++++++----- efl/elementary/progressbar.pyx | 16 ++++- efl/elementary/radio.pyx | 29 ++++++-- efl/elementary/scroller.pyx | 44 +++++++----- efl/elementary/segment_control.pyx | 28 +++++--- efl/elementary/separator.pyx | 17 +++-- efl/elementary/slider.pyx | 28 +++++--- efl/elementary/slideshow.pyx | 18 ++++- efl/elementary/spinner.pyx | 25 +++++-- efl/elementary/table.pyx | 20 ++++-- efl/elementary/theme.pyx | 15 +++- efl/elementary/thumb.pyx | 32 ++++++--- efl/elementary/toolbar.pyx | 37 +++++++--- efl/elementary/transit.pyx | 24 +++++-- efl/elementary/video.pyx | 14 +++- efl/elementary/web.pyx | 28 +++++--- efl/elementary/window.pyx | 29 +++++--- efl/emotion/efl.emotion.pyx | 94 ++++++++++++++++++++++++- 153 files changed, 1721 insertions(+), 1294 deletions(-) delete mode 100644 doc/edje/edje_module.rst delete mode 100644 doc/edje/edje_object.rst delete mode 100644 doc/elementary/elementary_module.rst delete mode 100644 doc/emotion/emotion_module.rst delete mode 100644 doc/emotion/emotion_object.rst diff --git a/doc/edje/edje.rst b/doc/edje/edje.rst index 6ff3bc1..e21c1cc 100644 --- a/doc/edje/edje.rst +++ b/doc/edje/edje.rst @@ -1,80 +1,2 @@ -What is Edje? --------------- - -Edje is a complex graphical design & layout library. - -It doesn't intend to do containing and regular layout like a widget -set, but it is the base for such components. Based on the requirements -of Enlightenment 0.17, Edje should serve all the purposes of creating -visual elements (borders of windows, buttons, scrollbars, etc.) and -allow the designer the ability to animate, layout and control the look -and feel of any program using Edje as its basic GUI constructor. This -library allows for multiple collections of Layouts in one file, -sharing the same image and font database and thus allowing a whole -theme to be conveniently packaged into 1 file and shipped around. - -Edje separates the layout and behavior logic. Edje files ship with an -image and font database, used by all the parts in all the collections -to source graphical data. It has a directory of logical part names -pointing to the part collection entry ID in the file (thus allowing -for multiple logical names to point to the same part collection, -allowing for the sharing of data between display elements). Each part -collection consists of a list of visual parts, as well as a list of -programs. A program is a conditionally run program that if a -particular event occurs (a button is pressed, a mouse enters or leaves -a part) will trigger an action that may affect other parts. In this -way a part collection can be "programmed" via its file as to hilight -buttons when the mouse passes over them or show hidden parts when a -button is clicked somewhere etc. The actions performed in changing -from one state to another are also allowed to transition over a period -of time, allowing animation. Programs and animations can be run in -"parallel". - -This separation and simplistic event driven style of programming can produce -almost any look and feel one could want for basic visual elements. Anything -more complex is likely the domain of an application or widget set that may -use Edje as a convenient way of being able to configure parts of the display. - - -So how does this all work? --------------------------- - -Edje internally holds a geometry state machine and state graph of what is -visible, not, where, at what size, with what colors etc. This is described -to Edje from an Edje .edj file containing this information. These files can -be produced by using edje_cc to take a text file (a .edc file) and "compile" -an output .edj file that contains this information, images and any other -data needed. - -The application using Edje will then create an object in its Evas -canvas and set the bundle file to use, specifying the **group** name to -use. Edje will load such information and create all the required -children objects with the specified properties as defined in each -**part** of the given **group**. - -Although simple, this example illustrates that animations and state -changes can be done from the Edje file itself without any requirement -in the Python application. - -Before digging into changing or creating your own Edje source (edc) -files, read the @ref edcref. - - -API Reference -------------- - -.. toctree:: - :maxdepth: 4 - - edje_module - edje_object - - -Inheritance diagram -------------------- - -.. inheritance-diagram:: - efl.edje - :parts: 2 - +.. automodule:: efl.edje diff --git a/doc/edje/edje_module.rst b/doc/edje/edje_module.rst deleted file mode 100644 index e47bdad..0000000 --- a/doc/edje/edje_module.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`efl.edje` Module -======================= - -.. automodule:: efl.edje - :exclude-members: Edje diff --git a/doc/edje/edje_object.rst b/doc/edje/edje_object.rst deleted file mode 100644 index 2bca040..0000000 --- a/doc/edje/edje_object.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. currentmodule:: efl.edje - -:class:`efl.edje.Edje` Class -============================== - -.. autoclass:: efl.edje.Edje - diff --git a/doc/elementary/actionslider.rst b/doc/elementary/actionslider.rst index e993816..df745d4 100644 --- a/doc/elementary/actionslider.rst +++ b/doc/elementary/actionslider.rst @@ -1,8 +1,2 @@ -:mod:`actionslider` Module --------------------------- .. automodule:: efl.elementary.actionslider - -.. inheritance-diagram:: - efl.elementary.actionslider - :parts: 2 diff --git a/doc/elementary/background.rst b/doc/elementary/background.rst index 9c9e1c7..ddac36a 100644 --- a/doc/elementary/background.rst +++ b/doc/elementary/background.rst @@ -1,8 +1,2 @@ -:mod:`background` Module ------------------------- .. automodule:: efl.elementary.background - -.. inheritance-diagram:: - efl.elementary.background - :parts: 2 diff --git a/doc/elementary/box.rst b/doc/elementary/box.rst index e40667d..0661cf1 100644 --- a/doc/elementary/box.rst +++ b/doc/elementary/box.rst @@ -1,8 +1,2 @@ -:mod:`box` Module ------------------ .. automodule:: efl.elementary.box - -.. inheritance-diagram:: - efl.elementary.box - :parts: 2 diff --git a/doc/elementary/bubble.rst b/doc/elementary/bubble.rst index 9d2c1bb..3f0c1a9 100644 --- a/doc/elementary/bubble.rst +++ b/doc/elementary/bubble.rst @@ -1,8 +1,2 @@ -:mod:`bubble` Module ------------------------- .. automodule:: efl.elementary.bubble - -.. inheritance-diagram:: - efl.elementary.bubble - :parts: 2 diff --git a/doc/elementary/button.rst b/doc/elementary/button.rst index 2b44a72..d138ba2 100644 --- a/doc/elementary/button.rst +++ b/doc/elementary/button.rst @@ -1,8 +1,3 @@ -:mod:`button` Module --------------------- .. automodule:: efl.elementary.button -.. inheritance-diagram:: - efl.elementary.button - :parts: 2 diff --git a/doc/elementary/calendar.rst b/doc/elementary/calendar.rst index f735b62..c3fd57a 100644 --- a/doc/elementary/calendar.rst +++ b/doc/elementary/calendar.rst @@ -1,8 +1,2 @@ -:mod:`calendar_elm` Module --------------------------- .. automodule:: efl.elementary.calendar_elm - -.. inheritance-diagram:: - efl.elementary.calendar_elm - :parts: 2 diff --git a/doc/elementary/check.rst b/doc/elementary/check.rst index a83975f..7da1ef8 100644 --- a/doc/elementary/check.rst +++ b/doc/elementary/check.rst @@ -1,8 +1,2 @@ -:mod:`check` Module -------------------- .. automodule:: efl.elementary.check - -.. inheritance-diagram:: - efl.elementary.check - :parts: 2 diff --git a/doc/elementary/clock.rst b/doc/elementary/clock.rst index 56cc8de..519a6e2 100644 --- a/doc/elementary/clock.rst +++ b/doc/elementary/clock.rst @@ -1,8 +1,2 @@ -:mod:`clock` Module ------------------------- .. automodule:: efl.elementary.clock - -.. inheritance-diagram:: - efl.elementary.clock - :parts: 2 diff --git a/doc/elementary/colorselector.rst b/doc/elementary/colorselector.rst index 53ba62f..21b8103 100644 --- a/doc/elementary/colorselector.rst +++ b/doc/elementary/colorselector.rst @@ -1,8 +1,2 @@ -:mod:`colorselector` Module ---------------------------- .. automodule:: efl.elementary.colorselector - -.. inheritance-diagram:: - efl.elementary.colorselector - :parts: 2 diff --git a/doc/elementary/configuration.rst b/doc/elementary/configuration.rst index 1e647cf..3c992da 100644 --- a/doc/elementary/configuration.rst +++ b/doc/elementary/configuration.rst @@ -1,4 +1,2 @@ -:mod:`configuration` Module ---------------------------- .. automodule:: efl.elementary.configuration diff --git a/doc/elementary/conformant.rst b/doc/elementary/conformant.rst index 1907f01..b13449c 100644 --- a/doc/elementary/conformant.rst +++ b/doc/elementary/conformant.rst @@ -1,8 +1,2 @@ -:mod:`conformant` Module ------------------------- .. automodule:: efl.elementary.conformant - -.. inheritance-diagram:: - efl.elementary.conformant - :parts: 2 diff --git a/doc/elementary/ctxpopup.rst b/doc/elementary/ctxpopup.rst index b54548e..95151ac 100644 --- a/doc/elementary/ctxpopup.rst +++ b/doc/elementary/ctxpopup.rst @@ -1,8 +1,2 @@ -:mod:`ctxpopup` Module ------------------------- .. automodule:: efl.elementary.ctxpopup - -.. inheritance-diagram:: - efl.elementary.ctxpopup - :parts: 2 diff --git a/doc/elementary/datetime.rst b/doc/elementary/datetime.rst index f15fc9f..cf98d10 100644 --- a/doc/elementary/datetime.rst +++ b/doc/elementary/datetime.rst @@ -1,8 +1,2 @@ -:mod:`datetime_elm` Module --------------------------- .. automodule:: efl.elementary.datetime_elm - -.. inheritance-diagram:: - efl.elementary.datetime_elm - :parts: 2 diff --git a/doc/elementary/dayselector.rst b/doc/elementary/dayselector.rst index e184ae5..4540b10 100644 --- a/doc/elementary/dayselector.rst +++ b/doc/elementary/dayselector.rst @@ -1,8 +1,2 @@ -:mod:`dayselector` Module -------------------------- .. automodule:: efl.elementary.dayselector - -.. inheritance-diagram:: - efl.elementary.dayselector - :parts: 2 diff --git a/doc/elementary/diskselector.rst b/doc/elementary/diskselector.rst index d9739d6..10879bd 100644 --- a/doc/elementary/diskselector.rst +++ b/doc/elementary/diskselector.rst @@ -1,8 +1,2 @@ -:mod:`diskselector` Module --------------------------- .. automodule:: efl.elementary.diskselector - -.. inheritance-diagram:: - efl.elementary.diskselector - :parts: 2 diff --git a/doc/elementary/elementary.rst b/doc/elementary/elementary.rst index a874d8c..be0ac5c 100644 --- a/doc/elementary/elementary.rst +++ b/doc/elementary/elementary.rst @@ -1,7 +1,10 @@ +Elementary +########## + -What is Elementary? -------------------- +What is elementary? +=================== Elementary is a the high level toolkit based on the underlying efl technologies (:doc:`Evas `, :doc:`Edje `, @@ -13,10 +16,10 @@ of flexibility. Callbacks ---------- +========= Widget callbacks -^^^^^^^^^^^^^^^^ +---------------- Widget callbacks are set with callback_*_add methods which take a callable, and optional args, kwargs as data. @@ -31,7 +34,7 @@ or:: Event callbacks -^^^^^^^^^^^^^^^ +--------------- Event callbacks have signature of:: @@ -39,92 +42,22 @@ Event callbacks have signature of:: A sample Python Elementary program ----------------------------------- +================================== .. literalinclude:: ../../examples/elementary/test_win_dialog.py :language: python - API Reference -------------- +============= -.. toctree:: +.. toctree:: * + :glob: :maxdepth: 1 - elementary_module - actionslider - background - box - bubble - button - calendar - check - clock - colorselector - configuration - conformant - ctxpopup - datetime - dayselector - diskselector - entry - fileselector - fileselector_button - fileselector_entry - flip - flipselector - frame - general - gengrid - genlist - gesture_layer - grid - hover - hoversel - icon - image - index - innerwindow - label - layout - layout_class - list - map - mapbuf - menu - multibuttonentry - naviframe - need - notify - object - object_item - panel - panes - photo - photocam - plug - popup - progressbar - radio - scroller - segment_control - separator - slider - slideshow - spinner - table - theme - thumb - toolbar - transit - video - web - window - Inheritance diagram -------------------- +=================== .. inheritance-diagram:: efl.elementary.actionslider diff --git a/doc/elementary/elementary_module.rst b/doc/elementary/elementary_module.rst deleted file mode 100644 index 10d89de..0000000 --- a/doc/elementary/elementary_module.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`efl.elementary` Package -============================= - -.. automodule:: efl.elementary - :exclude-members: ActionSlider diff --git a/doc/elementary/entry.rst b/doc/elementary/entry.rst index 765bc6d..bd5ba13 100644 --- a/doc/elementary/entry.rst +++ b/doc/elementary/entry.rst @@ -1,8 +1,2 @@ -:mod:`entry` Module -------------------- .. automodule:: efl.elementary.entry - -.. inheritance-diagram:: - efl.elementary.entry - :parts: 2 diff --git a/doc/elementary/fileselector.rst b/doc/elementary/fileselector.rst index 0a271cd..00ddcf4 100644 --- a/doc/elementary/fileselector.rst +++ b/doc/elementary/fileselector.rst @@ -1,8 +1,2 @@ -:mod:`fileselector` Module --------------------------- .. automodule:: efl.elementary.fileselector - -.. inheritance-diagram:: - efl.elementary.fileselector - :parts: 2 diff --git a/doc/elementary/fileselector_button.rst b/doc/elementary/fileselector_button.rst index 4ac580d..b2566b7 100644 --- a/doc/elementary/fileselector_button.rst +++ b/doc/elementary/fileselector_button.rst @@ -1,8 +1,2 @@ -:mod:`fileselector_button` Module ---------------------------------- .. automodule:: efl.elementary.fileselector_button - -.. inheritance-diagram:: - efl.elementary.fileselector_button - :parts: 2 diff --git a/doc/elementary/fileselector_entry.rst b/doc/elementary/fileselector_entry.rst index 60f9e85..8479474 100644 --- a/doc/elementary/fileselector_entry.rst +++ b/doc/elementary/fileselector_entry.rst @@ -1,8 +1,2 @@ -:mod:`fileselector_entry` Module --------------------------------- .. automodule:: efl.elementary.fileselector_entry - -.. inheritance-diagram:: - efl.elementary.fileselector_entry - :parts: 2 diff --git a/doc/elementary/flip.rst b/doc/elementary/flip.rst index 4c7d99b..0644602 100644 --- a/doc/elementary/flip.rst +++ b/doc/elementary/flip.rst @@ -1,8 +1,2 @@ -:mod:`flip` Module ------------------------- .. automodule:: efl.elementary.flip - -.. inheritance-diagram:: - efl.elementary.flip - :parts: 2 diff --git a/doc/elementary/flipselector.rst b/doc/elementary/flipselector.rst index 83610aa..0bf5cf1 100644 --- a/doc/elementary/flipselector.rst +++ b/doc/elementary/flipselector.rst @@ -1,8 +1,2 @@ -:mod:`flipselector` Module --------------------------- .. automodule:: efl.elementary.flipselector - -.. inheritance-diagram:: - efl.elementary.flipselector - :parts: 2 diff --git a/doc/elementary/frame.rst b/doc/elementary/frame.rst index 8b90f74..c87a2d2 100644 --- a/doc/elementary/frame.rst +++ b/doc/elementary/frame.rst @@ -1,8 +1,2 @@ -:mod:`frame` Module ------------------------- .. automodule:: efl.elementary.frame - -.. inheritance-diagram:: - efl.elementary.frame - :parts: 2 diff --git a/doc/elementary/general.rst b/doc/elementary/general.rst index 0eb8483..949970f 100644 --- a/doc/elementary/general.rst +++ b/doc/elementary/general.rst @@ -1,4 +1,2 @@ -:mod:`general` Module ---------------------- .. automodule:: efl.elementary.general diff --git a/doc/elementary/gengrid.rst b/doc/elementary/gengrid.rst index e7374c8..d2e5c2e 100644 --- a/doc/elementary/gengrid.rst +++ b/doc/elementary/gengrid.rst @@ -1,8 +1,2 @@ -:mod:`gengrid` Module ------------------------- .. automodule:: efl.elementary.gengrid - -.. inheritance-diagram:: - efl.elementary.gengrid - :parts: 2 diff --git a/doc/elementary/genlist.rst b/doc/elementary/genlist.rst index e4d1de3..a2a583c 100644 --- a/doc/elementary/genlist.rst +++ b/doc/elementary/genlist.rst @@ -1,11 +1,2 @@ -:mod:`genlist` Module ---------------------- .. automodule:: efl.elementary.genlist - - Reference - --------- - -.. inheritance-diagram:: - efl.elementary.genlist - :parts: 2 diff --git a/doc/elementary/gesture_layer.rst b/doc/elementary/gesture_layer.rst index 84460b1..3ec4ffb 100644 --- a/doc/elementary/gesture_layer.rst +++ b/doc/elementary/gesture_layer.rst @@ -1,8 +1,2 @@ -:mod:`gesture_layer` Module ---------------------------- .. automodule:: efl.elementary.gesture_layer - -.. inheritance-diagram:: - efl.elementary.gesture_layer - :parts: 2 diff --git a/doc/elementary/grid.rst b/doc/elementary/grid.rst index 42c7619..956c3b8 100644 --- a/doc/elementary/grid.rst +++ b/doc/elementary/grid.rst @@ -1,8 +1,2 @@ -:mod:`grid` Module ------------------------- .. automodule:: efl.elementary.grid - -.. inheritance-diagram:: - efl.elementary.grid - :parts: 2 diff --git a/doc/elementary/hover.rst b/doc/elementary/hover.rst index bd89fbb..50206b0 100644 --- a/doc/elementary/hover.rst +++ b/doc/elementary/hover.rst @@ -1,8 +1,2 @@ -:mod:`hover` Module -------------------- .. automodule:: efl.elementary.hover - -.. inheritance-diagram:: - efl.elementary.hover - :parts: 2 diff --git a/doc/elementary/hoversel.rst b/doc/elementary/hoversel.rst index 078bf5d..530016a 100644 --- a/doc/elementary/hoversel.rst +++ b/doc/elementary/hoversel.rst @@ -1,8 +1,2 @@ -:mod:`hoversel` Module ----------------------- .. automodule:: efl.elementary.hoversel - -.. inheritance-diagram:: - efl.elementary.hoversel - :parts: 2 diff --git a/doc/elementary/icon.rst b/doc/elementary/icon.rst index bbd0080..51723ab 100644 --- a/doc/elementary/icon.rst +++ b/doc/elementary/icon.rst @@ -1,8 +1,2 @@ -:mod:`icon` Module ------------------- .. automodule:: efl.elementary.icon - -.. inheritance-diagram:: - efl.elementary.icon - :parts: 2 diff --git a/doc/elementary/image.rst b/doc/elementary/image.rst index 041c7c3..0590ed9 100644 --- a/doc/elementary/image.rst +++ b/doc/elementary/image.rst @@ -1,8 +1,2 @@ -:mod:`image` Module -------------------- .. automodule:: efl.elementary.image - -.. inheritance-diagram:: - efl.elementary.image - :parts: 2 diff --git a/doc/elementary/index.rst b/doc/elementary/index.rst index 468159d..fea21e2 100644 --- a/doc/elementary/index.rst +++ b/doc/elementary/index.rst @@ -1,8 +1,2 @@ -:mod:`index` Module ------------------------- .. automodule:: efl.elementary.index - -.. inheritance-diagram:: - efl.elementary.index - :parts: 2 diff --git a/doc/elementary/innerwindow.rst b/doc/elementary/innerwindow.rst index 594db1c..77e867b 100644 --- a/doc/elementary/innerwindow.rst +++ b/doc/elementary/innerwindow.rst @@ -1,8 +1,2 @@ -:mod:`innerwindow` Module -------------------------- .. automodule:: efl.elementary.innerwindow - -.. inheritance-diagram:: - efl.elementary.innerwindow - :parts: 2 diff --git a/doc/elementary/label.rst b/doc/elementary/label.rst index be264c7..ba32422 100644 --- a/doc/elementary/label.rst +++ b/doc/elementary/label.rst @@ -1,8 +1,2 @@ -:mod:`label` Module -------------------- .. automodule:: efl.elementary.label - -.. inheritance-diagram:: - efl.elementary.label - :parts: 2 diff --git a/doc/elementary/layout.rst b/doc/elementary/layout.rst index 917a36c..4cff326 100644 --- a/doc/elementary/layout.rst +++ b/doc/elementary/layout.rst @@ -1,8 +1,2 @@ -:mod:`layout` Module --------------------- .. automodule:: efl.elementary.layout - -.. inheritance-diagram:: - efl.elementary.layout - :parts: 2 diff --git a/doc/elementary/layout_class.rst b/doc/elementary/layout_class.rst index aa8735b..75f9673 100644 --- a/doc/elementary/layout_class.rst +++ b/doc/elementary/layout_class.rst @@ -1,8 +1,2 @@ -:mod:`layout_class` Module --------------------------- .. automodule:: efl.elementary.layout_class - -.. inheritance-diagram:: - efl.elementary.layout_class - :parts: 2 diff --git a/doc/elementary/list.rst b/doc/elementary/list.rst index e097e58..4f3d17f 100644 --- a/doc/elementary/list.rst +++ b/doc/elementary/list.rst @@ -1,8 +1,2 @@ -:mod:`list` Module ------------------- .. automodule:: efl.elementary.list - -.. inheritance-diagram:: - efl.elementary.list - :parts: 2 diff --git a/doc/elementary/map.rst b/doc/elementary/map.rst index 0f5a89f..5a87dd9 100644 --- a/doc/elementary/map.rst +++ b/doc/elementary/map.rst @@ -1,8 +1,2 @@ -:mod:`map` Module ------------------------- .. automodule:: efl.elementary.map - -.. inheritance-diagram:: - efl.elementary.map - :parts: 2 diff --git a/doc/elementary/mapbuf.rst b/doc/elementary/mapbuf.rst index a0c1653..cb60020 100644 --- a/doc/elementary/mapbuf.rst +++ b/doc/elementary/mapbuf.rst @@ -1,8 +1,2 @@ -:mod:`mapbuf` Module ------------------------- .. automodule:: efl.elementary.mapbuf - -.. inheritance-diagram:: - efl.elementary.mapbuf - :parts: 2 diff --git a/doc/elementary/menu.rst b/doc/elementary/menu.rst index cf33637..97b8d8e 100644 --- a/doc/elementary/menu.rst +++ b/doc/elementary/menu.rst @@ -1,8 +1,2 @@ -:mod:`menu` Module ------------------------- .. automodule:: efl.elementary.menu - -.. inheritance-diagram:: - efl.elementary.menu - :parts: 2 diff --git a/doc/elementary/multibuttonentry.rst b/doc/elementary/multibuttonentry.rst index 376c4f7..d3d1070 100644 --- a/doc/elementary/multibuttonentry.rst +++ b/doc/elementary/multibuttonentry.rst @@ -1,8 +1,2 @@ -:mod:`multibuttonentry` Module ------------------------------- .. automodule:: efl.elementary.multibuttonentry - -.. inheritance-diagram:: - efl.elementary.multibuttonentry - :parts: 2 diff --git a/doc/elementary/naviframe.rst b/doc/elementary/naviframe.rst index 1ec88f9..c8377b7 100644 --- a/doc/elementary/naviframe.rst +++ b/doc/elementary/naviframe.rst @@ -1,8 +1,2 @@ -:mod:`naviframe` Module ------------------------ .. automodule:: efl.elementary.naviframe - -.. inheritance-diagram:: - efl.elementary.naviframe - :parts: 2 diff --git a/doc/elementary/need.rst b/doc/elementary/need.rst index 36d6ff1..31dc046 100644 --- a/doc/elementary/need.rst +++ b/doc/elementary/need.rst @@ -1,4 +1,2 @@ -:mod:`need` Module ------------------------- .. automodule:: efl.elementary.need diff --git a/doc/elementary/notify.rst b/doc/elementary/notify.rst index 9087fe5..bb7648e 100644 --- a/doc/elementary/notify.rst +++ b/doc/elementary/notify.rst @@ -1,8 +1,2 @@ -:mod:`notify` Module --------------------- .. automodule:: efl.elementary.notify - -.. inheritance-diagram:: - efl.elementary.notify - :parts: 2 diff --git a/doc/elementary/object.rst b/doc/elementary/object.rst index fade240..abc1e67 100644 --- a/doc/elementary/object.rst +++ b/doc/elementary/object.rst @@ -1,8 +1,2 @@ -:mod:`object` Module --------------------- .. automodule:: efl.elementary.object - -.. inheritance-diagram:: - efl.elementary.object - :parts: 2 diff --git a/doc/elementary/object_item.rst b/doc/elementary/object_item.rst index 2ca16e2..173cd05 100644 --- a/doc/elementary/object_item.rst +++ b/doc/elementary/object_item.rst @@ -1,8 +1,2 @@ -:mod:`object_item` Module -------------------------- .. automodule:: efl.elementary.object_item - -.. inheritance-diagram:: - efl.elementary.object_item - :parts: 2 diff --git a/doc/elementary/panel.rst b/doc/elementary/panel.rst index 2dc27e5..540ba86 100644 --- a/doc/elementary/panel.rst +++ b/doc/elementary/panel.rst @@ -1,8 +1,2 @@ -:mod:`panel` Module ------------------------- .. automodule:: efl.elementary.panel - -.. inheritance-diagram:: - efl.elementary.panel - :parts: 2 diff --git a/doc/elementary/panes.rst b/doc/elementary/panes.rst index 51cc675..00b9fb5 100644 --- a/doc/elementary/panes.rst +++ b/doc/elementary/panes.rst @@ -1,8 +1,2 @@ -:mod:`panes` Module ------------------------- .. automodule:: efl.elementary.panes - -.. inheritance-diagram:: - efl.elementary.panes - :parts: 2 diff --git a/doc/elementary/photo.rst b/doc/elementary/photo.rst index eeab4e6..936c88a 100644 --- a/doc/elementary/photo.rst +++ b/doc/elementary/photo.rst @@ -1,8 +1,2 @@ -:mod:`photo` Module ------------------------- .. automodule:: efl.elementary.photo - -.. inheritance-diagram:: - efl.elementary.photo - :parts: 2 diff --git a/doc/elementary/photocam.rst b/doc/elementary/photocam.rst index f863c7a..c38aebf 100644 --- a/doc/elementary/photocam.rst +++ b/doc/elementary/photocam.rst @@ -1,8 +1,2 @@ -:mod:`photocam` Module ------------------------- .. automodule:: efl.elementary.photocam - -.. inheritance-diagram:: - efl.elementary.photocam - :parts: 2 diff --git a/doc/elementary/plug.rst b/doc/elementary/plug.rst index 1298bd1..1c093a1 100644 --- a/doc/elementary/plug.rst +++ b/doc/elementary/plug.rst @@ -1,8 +1,2 @@ -:mod:`plug` Module ------------------- .. automodule:: efl.elementary.plug - -.. inheritance-diagram:: - efl.elementary.plug - :parts: 2 diff --git a/doc/elementary/popup.rst b/doc/elementary/popup.rst index 7d0a1b8..9ce6823 100644 --- a/doc/elementary/popup.rst +++ b/doc/elementary/popup.rst @@ -1,8 +1,2 @@ -:mod:`popup` Module ------------------------- .. automodule:: efl.elementary.popup - -.. inheritance-diagram:: - efl.elementary.popup - :parts: 2 diff --git a/doc/elementary/progressbar.rst b/doc/elementary/progressbar.rst index b784f9d..65bd832 100644 --- a/doc/elementary/progressbar.rst +++ b/doc/elementary/progressbar.rst @@ -1,8 +1,2 @@ -:mod:`progressbar` Module -------------------------- .. automodule:: efl.elementary.progressbar - -.. inheritance-diagram:: - efl.elementary.progressbar - :parts: 2 diff --git a/doc/elementary/radio.rst b/doc/elementary/radio.rst index 45f2823..6fd95da 100644 --- a/doc/elementary/radio.rst +++ b/doc/elementary/radio.rst @@ -1,8 +1,2 @@ -:mod:`radio` Module -------------------- .. automodule:: efl.elementary.radio - -.. inheritance-diagram:: - efl.elementary.radio - :parts: 2 diff --git a/doc/elementary/scroller.rst b/doc/elementary/scroller.rst index ea9e589..903c94d 100644 --- a/doc/elementary/scroller.rst +++ b/doc/elementary/scroller.rst @@ -1,8 +1,2 @@ -:mod:`scroller` Module ----------------------- .. automodule:: efl.elementary.scroller - -.. inheritance-diagram:: - efl.elementary.scroller - :parts: 2 diff --git a/doc/elementary/segment_control.rst b/doc/elementary/segment_control.rst index ae317a9..99f4224 100644 --- a/doc/elementary/segment_control.rst +++ b/doc/elementary/segment_control.rst @@ -1,8 +1,2 @@ -:mod:`segment_control` Module ------------------------------ .. automodule:: efl.elementary.segment_control - -.. inheritance-diagram:: - efl.elementary.segment_control - :parts: 2 diff --git a/doc/elementary/separator.rst b/doc/elementary/separator.rst index dd82ef9..73edfba 100644 --- a/doc/elementary/separator.rst +++ b/doc/elementary/separator.rst @@ -1,8 +1,2 @@ -:mod:`separator` Module ------------------------ .. automodule:: efl.elementary.separator - -.. inheritance-diagram:: - efl.elementary.separator - :parts: 2 diff --git a/doc/elementary/slider.rst b/doc/elementary/slider.rst index 3bac04e..6319441 100644 --- a/doc/elementary/slider.rst +++ b/doc/elementary/slider.rst @@ -1,8 +1,2 @@ -:mod:`slider` Module ------------------------- .. automodule:: efl.elementary.slider - -.. inheritance-diagram:: - efl.elementary.slider - :parts: 2 diff --git a/doc/elementary/slideshow.rst b/doc/elementary/slideshow.rst index 0dada89..9e3c5d6 100644 --- a/doc/elementary/slideshow.rst +++ b/doc/elementary/slideshow.rst @@ -1,8 +1,2 @@ -:mod:`slideshow` Module ------------------------- .. automodule:: efl.elementary.slideshow - -.. inheritance-diagram:: - efl.elementary.slideshow - :parts: 2 diff --git a/doc/elementary/spinner.rst b/doc/elementary/spinner.rst index ee0fce8..37a41a7 100644 --- a/doc/elementary/spinner.rst +++ b/doc/elementary/spinner.rst @@ -1,8 +1,2 @@ -:mod:`spinner` Module ------------------------- .. automodule:: efl.elementary.spinner - -.. inheritance-diagram:: - efl.elementary.spinner - :parts: 2 diff --git a/doc/elementary/table.rst b/doc/elementary/table.rst index 2f0e25b..9948f3e 100644 --- a/doc/elementary/table.rst +++ b/doc/elementary/table.rst @@ -1,8 +1,2 @@ -:mod:`table` Module -------------------- .. automodule:: efl.elementary.table - -.. inheritance-diagram:: - efl.elementary.table - :parts: 2 diff --git a/doc/elementary/theme.rst b/doc/elementary/theme.rst index 1d59ecb..b79be2f 100644 --- a/doc/elementary/theme.rst +++ b/doc/elementary/theme.rst @@ -1,8 +1,2 @@ -:mod:`theme` Module -------------------- .. automodule:: efl.elementary.theme - -.. inheritance-diagram:: - efl.elementary.theme - :parts: 2 diff --git a/doc/elementary/thumb.rst b/doc/elementary/thumb.rst index 7a1f473..af2e664 100644 --- a/doc/elementary/thumb.rst +++ b/doc/elementary/thumb.rst @@ -1,8 +1,2 @@ -:mod:`thumb` Module ------------------------- .. automodule:: efl.elementary.thumb - -.. inheritance-diagram:: - efl.elementary.thumb - :parts: 2 diff --git a/doc/elementary/toolbar.rst b/doc/elementary/toolbar.rst index 40b234d..4943239 100644 --- a/doc/elementary/toolbar.rst +++ b/doc/elementary/toolbar.rst @@ -1,8 +1,2 @@ -:mod:`toolbar` Module ------------------------- .. automodule:: efl.elementary.toolbar - -.. inheritance-diagram:: - efl.elementary.toolbar - :parts: 2 diff --git a/doc/elementary/transit.rst b/doc/elementary/transit.rst index 58d994f..5782be7 100644 --- a/doc/elementary/transit.rst +++ b/doc/elementary/transit.rst @@ -1,8 +1,2 @@ -:mod:`transit` Module ------------------------- .. automodule:: efl.elementary.transit - -.. inheritance-diagram:: - efl.elementary.transit - :parts: 2 diff --git a/doc/elementary/video.rst b/doc/elementary/video.rst index 2528365..514e25b 100644 --- a/doc/elementary/video.rst +++ b/doc/elementary/video.rst @@ -1,8 +1,2 @@ -:mod:`video` Module ------------------------- .. automodule:: efl.elementary.video - -.. inheritance-diagram:: - efl.elementary.video - :parts: 2 diff --git a/doc/elementary/web.rst b/doc/elementary/web.rst index 29bf082..70b0f7d 100644 --- a/doc/elementary/web.rst +++ b/doc/elementary/web.rst @@ -1,8 +1,2 @@ -:mod:`web` Module ------------------------- .. automodule:: efl.elementary.web - -.. inheritance-diagram:: - efl.elementary.web - :parts: 2 diff --git a/doc/elementary/window.rst b/doc/elementary/window.rst index a45ae3b..590baba 100644 --- a/doc/elementary/window.rst +++ b/doc/elementary/window.rst @@ -1,8 +1,2 @@ -:mod:`window` Module --------------------- .. automodule:: efl.elementary.window - -.. inheritance-diagram:: - efl.elementary.window - :parts: 2 diff --git a/doc/emotion/emotion.rst b/doc/emotion/emotion.rst index 36bd158..568fbd8 100644 --- a/doc/emotion/emotion.rst +++ b/doc/emotion/emotion.rst @@ -1,96 +1,2 @@ -What is Emotion? ----------------- - -Emotion is a media object library for Evas and Ecore. - -Emotion is a library that allows playing audio and video files, using one of -its backends (gstreamer, xine, vlc or generic shm player). - -It is integrated into Ecore through its mainloop, and is transparent to the -user of the library how the decoding of audio and video is being done. Once -the objects are created, the user can set callbacks to the specific events -and set options to this object, all in the main loop (no threads are needed). - -Emotion is also integrated with Evas. The emotion object returned by -emotion_object_add() is an Evas smart object, so it can be manipulated with -default Evas object functions. Callbacks can be added to the signals emitted -by this object with evas_object_smart_callback_add(). - -The Emotion library uses Evas smart objects to allow you to manipulate the -created object as any other Evas object, and to connect to its signals, -handling them when needed. It's also possible to swallow Emotion objects -inside Edje themes, and expect it to behave as a normal image or rectangle -when regarding to its dimensions. - - -How to use the Emotion object ------------------------------ - -Emotion provides an Evas smart object that allows to play, control and -display a video or audio file. The API is synchronous but not everything -happens immediately. There are also some signals to report changed states. - -Basically, once the object is created and initialized, a file will be set to -it, and then it can be resized, moved, and controlled by other Evas object -functions. - -However, the decoding of the music and video occurs not in the Ecore main -loop, but usually in another thread (this depends on the module being used). -The synchronization between this other thread and the main loop not visible -to the end user of the library. The user can just register callbacks to the -available signals to receive information about the changed states, and can -call other functions from the API to request more changes on the current -loaded file. - -There will be a delay between an API being called and it being really -executed, since this request will be done in the main thread, and it needs to -be sent to the decoding thread. For this reason, always call functions like -emotion_object_size_get() or emotion_object_length_get() after some signal -being sent, like "playback_started" or "open_done". - -.. rubric:: Available signals - -The Evas_Object returned by emotion_object_add() has a number of signals that -can be listened to using evas' smart callbacks mechanism. The following is -a list of interesting signals: - - - ``playback_started`` Emitted when the playback starts - - ``playback_finished`` Emitted when the playback finishes - - ``frame_decode`` Emitted every time a frame is decoded - - ``frame_resize`` Emitted when the frame change its size - - ``open_done`` Emitted when the media file is opened - - ``position_update`` Emitted when emotion_object_position_set is called - - ``audio_level_change`` Emitted when the volume change it's value - - ``decode_stop`` Emitted after the last frame is decoded - - ``length_change`` Emitted if the media change it's size - - ``channels_change`` Emitted when the number of channels change - - ``title_change`` Emitted when the title change (?) - - ``progress_change`` - - ``ref_change`` - - ``button_num_change`` - - ``button_change`` - - ``position_save,succeed`` - - ``position_save,failed`` - - ``position_load,succeed`` - - ``position_load,failed`` - - -API Reference -------------- - -.. toctree:: - :maxdepth: 4 - - emotion_module - emotion_object - - -Inheritance diagram -------------------- - -.. inheritance-diagram:: - efl.emotion - :parts: 2 - - +.. automodule:: efl.emotion diff --git a/doc/emotion/emotion_module.rst b/doc/emotion/emotion_module.rst deleted file mode 100644 index 8845624..0000000 --- a/doc/emotion/emotion_module.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`efl.emotion` Module -========================= - -.. automodule:: efl.emotion - :exclude-members: Emotion diff --git a/doc/emotion/emotion_object.rst b/doc/emotion/emotion_object.rst deleted file mode 100644 index 485fb96..0000000 --- a/doc/emotion/emotion_object.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. currentmodule:: efl.emotion - -:class:`efl.emotion.Emotion` Class -================================== - -.. autoclass:: efl.emotion.Emotion diff --git a/doc/evas/evas.rst b/doc/evas/evas.rst index b2c7988..a20e955 100644 --- a/doc/evas/evas.rst +++ b/doc/evas/evas.rst @@ -178,16 +178,16 @@ For example, box objects use alignment hints to align its lines/columns inside its container, padding hints to set the padding between each individual child, etc. -Size Hints are controlled using various :class:`Object` properties: +Size Hints are controlled using various :class:`~efl.evas.Object` properties: - * :attr:`~Object.size_hint_weight` (also called :attr:`~Object.size_hint_expand`) - * :attr:`~Object.size_hint_align` (also called :attr:`~Object.size_hint_fill`) - * :attr:`~Object.size_hint_min` - * :attr:`~Object.size_hint_max` - * :attr:`~Object.size_hint_aspect` - * :attr:`~Object.size_hint_padding` - * :attr:`~Object.size_hint_display_mode` - * :attr:`~Object.size_hint_request` + * :attr:`~efl.evas.Object.size_hint_weight` (also called :attr:`~efl.evas.Object.size_hint_expand`) + * :attr:`~efl.evas.Object.size_hint_align` (also called :attr:`~efl.evas.Object.size_hint_fill`) + * :attr:`~efl.evas.Object.size_hint_min` + * :attr:`~efl.evas.Object.size_hint_max` + * :attr:`~efl.evas.Object.size_hint_aspect` + * :attr:`~efl.evas.Object.size_hint_padding` + * :attr:`~efl.evas.Object.size_hint_display_mode` + * :attr:`~efl.evas.Object.size_hint_request` The **weight** and the **align** are quite special, they are also used to express the **expand** and the **fill** property of the object. For this @@ -253,21 +253,21 @@ API Reference .. toctree:: :maxdepth: 4 - evas_module - canvas - object - image - rectangle - line - polygon - text - textblock - textgrid - box - table - grid - map - rect + evas_module.rst + canvas.rst + object.rst + image.rst + rectangle.rst + line.rst + polygon.rst + text.rst + textblock.rst + textgrid.rst + box.rst + table.rst + grid.rst + map.rst + rect.rst Inheritance diagram diff --git a/doc/index.rst b/doc/index.rst index a09b701..013c1a9 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,6 +1,6 @@ Python Bindings for Enlightenment Foundation Libraries' documentation -===================================================================== +##################################################################### EFL is a collection of libraries that are independent or may build on top of each-other to provide useful features that complement an OS's existing @@ -26,67 +26,69 @@ and more. .. seealso:: - `EFL Overview `_ - `EFL Documentation `_ + - `EFL Overview `_ + - `EFL Documentation `_ + - `EDC Reference `_ + - `EFL Big Picture `_ EFL ---- +=== .. toctree:: efl.rst EO ---- +== .. toctree:: eo/eo.rst Ecore ------ +===== .. toctree:: ecore/ecore.rst - + :maxdepth: 2 Evas ----- +==== .. toctree:: evas/evas.rst Ethumb ------- +====== .. toctree:: ethumb/ethumb.rst Edje ----- +==== .. toctree:: edje/edje.rst Emotion -------- +======= .. toctree:: emotion/emotion.rst Elementary ----------- +========== .. toctree:: elementary/elementary.rst - :maxdepth: 2 + :maxdepth: 3 DBus integration ----------------- +================ .. toctree:: dbus/dbus Acknowledgements ----------------- +================ :Copyright: Python Bindings for EFL are Copyright (C) 2008-2015 Simon Busch @@ -111,7 +113,7 @@ Acknowledgements Indices and tables ------------------- +================== * :ref:`genindex` * :ref:`modindex` diff --git a/doc/themes/efldoc/layout.html b/doc/themes/efldoc/layout.html index f3af27f..3855625 100644 --- a/doc/themes/efldoc/layout.html +++ b/doc/themes/efldoc/layout.html @@ -66,6 +66,7 @@
    • +
  • {{ project }} - {{ version }}
  • python docs
  • other docs
  • EFL
    • diff --git a/doc/themes/efldoc/static/efl.css b/doc/themes/efldoc/static/efl.css index f9d071f..50d6bbd 100644 --- a/doc/themes/efldoc/static/efl.css +++ b/doc/themes/efldoc/static/efl.css @@ -74,7 +74,13 @@ body { height: 63px; width: 63px; } - +.pageheader li.maintitle { + float: left; + font-size: 26px; + color: #E6E6C8; + text-shadow: 0px 0px 6px #39F; + line-height: 63px; +} .pageheader li.current a { background: url("header_menu_current_background.png") no-repeat scroll 0% 0% transparent; padding-left: 12px; @@ -442,6 +448,41 @@ dt:target, .highlighted { /* */ border-bottom: 1px solid rgb(32,32,32); } +/* box for enumerations */ +div#enumerations > .section { + border: 1px solid #202020; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + margin-bottom: 1em; +} + +div#enumerations > .section h3 { + background-color: #333; + margin-top: 0; + padding: 2px; +} + + +/* box for classes */ +dd { + padding-right: 3px; +} + +dl.class { + border: 1px solid #202020; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +dl.class > dt { + font-size: 20px; + background-color: #333; + padding: 2px; +} + +dl.class dt{ + border-bottom: 1px solid #333; +} + + /* -- pygments fix ---------------------------------------------------------- */ .highlight .go { color: white !important; diff --git a/efl/ecore/efl.ecore.pyx b/efl/ecore/efl.ecore.pyx index 1ddb182..bbfc6d6 100644 --- a/efl/ecore/efl.ecore.pyx +++ b/efl/ecore/efl.ecore.pyx @@ -17,10 +17,13 @@ """ +Enumerations +============ + .. _Ecore_Fd_Handler_Flags: Fd handler flags -================ +---------------- What to monitor the file descriptor for: reading, writing or error. @@ -40,7 +43,7 @@ What to monitor the file descriptor for: reading, writing or error. .. _Ecore_Exe_Flags: Exe flags -========= +--------- Flags for executing a child with its stdin and/or stdout piped back. @@ -90,7 +93,7 @@ Flags for executing a child with its stdin and/or stdout piped back. Callback return values -====================== +---------------------- .. data:: ECORE_CALLBACK_CANCEL @@ -102,7 +105,7 @@ Callback return values Event return values -=================== +------------------- .. data:: ECORE_CALLBACK_PASS_ON @@ -116,7 +119,7 @@ Event return values .. _Ecore_Pos_Map: Position mappings for the animation -=================================== +----------------------------------- .. data:: ECORE_POS_MAP_LINEAR @@ -166,7 +169,7 @@ Position mappings for the animation .. _Ecore_Animator_Source: Timing sources for animators -============================ +---------------------------- .. data:: ECORE_ANIMATOR_SOURCE_TIMER @@ -180,7 +183,7 @@ Timing sources for animators .. Ecore_File_Event: File monitor events -=================== +------------------- .. data:: ECORE_FILE_EVENT_NONE @@ -215,6 +218,9 @@ File monitor events A file has been closed +Classes +======= + """ from libc.stdint cimport uintptr_t diff --git a/efl/edje/efl.edje.pyx b/efl/edje/efl.edje.pyx index 3a79c06..ba28804 100644 --- a/efl/edje/efl.edje.pyx +++ b/efl/edje/efl.edje.pyx @@ -15,6 +15,103 @@ # You should have received a copy of the GNU Lesser General Public License # along with this Python-EFL. If not, see . +""" + +:mod:`edje` Module +##################### + + +What is Edje? +============= + +Edje is a complex graphical design & layout library. + +It doesn't intend to do containing and regular layout like a widget +set, but it is the base for such components. Based on the requirements +of Enlightenment 0.17, Edje should serve all the purposes of creating +visual elements (borders of windows, buttons, scrollbars, etc.) and +allow the designer the ability to animate, layout and control the look +and feel of any program using Edje as its basic GUI constructor. This +library allows for multiple collections of Layouts in one file, +sharing the same image and font database and thus allowing a whole +theme to be conveniently packaged into 1 file and shipped around. + +Edje separates the layout and behavior logic. Edje files ship with an +image and font database, used by all the parts in all the collections +to source graphical data. It has a directory of logical part names +pointing to the part collection entry ID in the file (thus allowing +for multiple logical names to point to the same part collection, +allowing for the sharing of data between display elements). Each part +collection consists of a list of visual parts, as well as a list of +programs. A program is a conditionally run program that if a +particular event occurs (a button is pressed, a mouse enters or leaves +a part) will trigger an action that may affect other parts. In this +way a part collection can be "programmed" via its file as to hilight +buttons when the mouse passes over them or show hidden parts when a +button is clicked somewhere etc. The actions performed in changing +from one state to another are also allowed to transition over a period +of time, allowing animation. Programs and animations can be run in +"parallel". + +This separation and simplistic event driven style of programming can produce +almost any look and feel one could want for basic visual elements. Anything +more complex is likely the domain of an application or widget set that may +use Edje as a convenient way of being able to configure parts of the display. + + +So how does this all work? +========================== + +Edje internally holds a geometry state machine and state graph of what is +visible, not, where, at what size, with what colors etc. This is described +to Edje from an Edje .edj file containing this information. These files can +be produced by using edje_cc to take a text file (a .edc file) and "compile" +an output .edj file that contains this information, images and any other +data needed. + +The application using Edje will then create an object in its Evas +canvas and set the bundle file to use, specifying the **group** name to +use. Edje will load such information and create all the required +children objects with the specified properties as defined in each +**part** of the given **group**. + +Edje is an important EFL component because it makes easy to split logic and +UI, usually used as theme engine but can be much more powerful than just +changing some random images or text fonts. + +Edje also provides scripting through Embryo and communication can be +done using messages and signals. + +.. seealso:: + Before digging into changing or creating your own Edje source (edc) + files, read the `Edje Data Collection reference + `_ . + + +Signals from the edje object +============================ +You can debug signals and messagges by capturing all of them, example:: + + def sig_dbg(obj, emission, source): + print(obj, emission, source) + + def msg_dbg(obj, msg): + print(obj, msg) + + my_edje.signal_callback_add("*", "*", sig_dbg) + my_edje.message_handler_set(msg_dbg) + + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.edje + :parts: 2 + +""" + + import traceback import warnings diff --git a/efl/edje/efl.edje_object.pxi b/efl/edje/efl.edje_object.pxi index b8ff7b2..41bc3be 100644 --- a/efl/edje/efl.edje_object.pxi +++ b/efl/edje/efl.edje_object.pxi @@ -88,43 +88,18 @@ class EdjeLoadError(Exception): cdef class Edje(Object): """ - Edje evas object. + The Edje object. This is a high level :class:`efl.evas.SmartObject` that is defined as a group of parts, usually written in text files (.edc) and compiled as a package using EET to store resources (.edj). - Edje is an important EFL component because it makes easy to split logic - and UI, usually used as theme engine but can be much more powerful than - just changing some random images or text fonts. - - Edje also provides scripting through Embryo and communication can be - done using messages and signals. - - .. warning:: - although Edje provides part_object_get(), you should **NOT** - mess with these objects states or you'll screw the given Edje. The - objects you get with this function should be handled as "read-only". - .. attention:: messages are one way only! If you emit a message from Python you will just get it from your Embryo script, if you emit from Embryo you just get it in Python. If you want to emit events and capture them on the same side, use signals. - .. note:: - You can debug messages and signals by capturing all of them, - example:: - - >>> def sig_dbg(obj, emission, source): - ... print "%s: %s %s" % (obj, emission, source) - ... - >>> my_edje.signal_callback_add("*", "*", sig_dbg) - >>> def msg_dbg(obj, msg): - ... print "%s: %s" % (obj, msg) - ... - >>> my_edje.message_handler_set(msg_dbg) - """ def __cinit__(self, *a, **ka): self._signal_callbacks = {} @@ -135,10 +110,8 @@ cdef class Edje(Object): :param canvas: Evas canvas for this object :type canvas: :py:class:`~efl.evas.Canvas` - :keyword file: File name - :type file: string - :keyword group: Group name - :type group: string + :keyword string file: File name + :keyword string group: Group name :keyword size: Min size for the object :type size: tuple of ints :keyword geometry: Geometry for the object @@ -147,8 +120,6 @@ cdef class Edje(Object): as properties of the instance """ - - self._set_obj(edje_object_add(canvas.obj)) _register_decorated_callbacks(self) @@ -526,10 +497,10 @@ cdef class Edje(Object): """Get the efl.evas.Object that represents this part. .. warning:: - You should never modify the state of the returned object - (with Edje.move() or Edje.hide() for example), - but you can safely query info about its current state - (with Edje.visible_get() or Edje.color_get() for example). + You should never modify the state of the returned object (with + Edje.move() or Edje.hide() for example), but you can safely + query info about its current state (with Edje.visible_get() or + Edje.color_get() for example). """ cdef Evas_Object *obj diff --git a/efl/elementary/actionslider.pyx b/efl/elementary/actionslider.pyx index 1b8bc00..cf7b8c0 100644 --- a/efl/elementary/actionslider.pyx +++ b/efl/elementary/actionslider.pyx @@ -18,10 +18,14 @@ """ +:mod:`actionslider` Module +########################## + .. image:: /images/actionslider-preview.png + Widget description ------------------- +================== An actionslider is a switcher for two or three labels with customizable magnet properties. @@ -41,15 +45,18 @@ Magnets can be set on the above positions. When the indicator is released, it will move to its nearest "enabled and magnetized" position. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``selected`` - when user selects an enabled position (the label is passed as event info)". - ``pos_changed`` - when the indicator reaches any of the positions("left", "right" or "center"). -Default text parts of the actionslider widget that you can use for are: + +Layout text parts +================= - ``indicator`` - An indicator label of the actionslider - ``left`` - A left label of the actionslider @@ -58,12 +65,12 @@ Default text parts of the actionslider widget that you can use for are: Enumerations ------------- +============ .. _Elm_Actionslider_Pos: Actionslider positions -====================== +---------------------- .. data:: ELM_ACTIONSLIDER_NONE @@ -85,6 +92,13 @@ Actionslider positions All positions + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.actionslider + :parts: 2 + """ from libc.stdint cimport uintptr_t diff --git a/efl/elementary/background.pyx b/efl/elementary/background.pyx index 57abaf0..a239bd3 100644 --- a/efl/elementary/background.pyx +++ b/efl/elementary/background.pyx @@ -18,10 +18,14 @@ """ +:mod:`background` Module +######################## + .. image:: /images/background-preview.png + Widget description ------------------- +================== The background widget is used for setting a solid color, image or Edje group as a background to a window (unless it has transparency enabled) or any @@ -31,18 +35,19 @@ It works just like an image, but has some properties useful to a background, like setting it to tiled, centered, scaled or stretched. -Default content parts of the bg widget that you can use for are: +Layout content parts +==================== - ``overlay`` - overlay of the bg Enumerations ------------- +============ .. _Elm_Bg_Option: Background display modes -======================== +------------------------ .. data:: ELM_BG_OPTION_CENTER @@ -60,6 +65,13 @@ Background display modes Tile + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.background + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/box.pyx b/efl/elementary/box.pyx index 456ddff..3e00c3c 100644 --- a/efl/elementary/box.pyx +++ b/efl/elementary/box.pyx @@ -18,11 +18,14 @@ """ -Widget description ------------------- +:mod:`box` Module +################# .. image:: /images/box-preview.png - :align: left + + +Widget description +================== A box arranges objects in a linear fashion, governed by a layout function that defines the details of this arrangement. @@ -80,12 +83,12 @@ children of the box. Enumerations ------------- +============ .. _Evas_Object_Box_Layout: Box layout modes -================ +---------------- .. data:: ELM_BOX_LAYOUT_HORIZONTAL @@ -123,6 +126,13 @@ Box layout modes Stacking layout + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.box + :parts: 2 + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/bubble.pyx b/efl/elementary/bubble.pyx index cfdf303..7fea1fa 100644 --- a/efl/elementary/bubble.pyx +++ b/efl/elementary/bubble.pyx @@ -18,10 +18,14 @@ """ +:mod:`bubble` Module +#################### + .. image:: /images/bubble-preview.png + Widget description ------------------- +================== The Bubble is a widget to show text similar to how speech is represented in comics. @@ -45,31 +49,36 @@ selected. The four available corners are: - ``bottom_left`` - ``bottom_right`` -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: -- ``clicked`` - This is called when a user has clicked the bubble. -- ``focused`` - When the bubble has received focus. (since 1.8) -- ``unfocused`` - When the bubble has lost focus. (since 1.8) - -Default content parts of the bubble that you can use for are: +Layout content parts +==================== - ``default`` - A content of the bubble - ``icon`` - An icon of the bubble -Default text parts of the button widget that you can use for are: + +Layout text parts +================= - ``default`` - Label of the bubble - ``info`` - info of the bubble +Emitted signals +=============== + +- ``clicked`` - This is called when a user has clicked the bubble. +- ``focused`` - When the bubble has received focus. (since 1.8) +- ``unfocused`` - When the bubble has lost focus. (since 1.8) + + Enumerations ------------- +============ .. _Elm_Bubble_Pos: Bubble arrow positions -====================== +---------------------- .. data:: ELM_BUBBLE_POS_TOP_LEFT @@ -87,6 +96,13 @@ Bubble arrow positions Bottom right position + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.bubble + :parts: 2 + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/button.pyx b/efl/elementary/button.pyx index c005489..20f9e0a 100644 --- a/efl/elementary/button.pyx +++ b/efl/elementary/button.pyx @@ -17,17 +17,51 @@ """ -Widget description ------------------- +:mod:`button` Module +#################### .. image:: /images/button-preview.png - :align: left + + +Widget description +================== This is a push-button. Press it and run some function. It can contain a simple label and icon object and it also has an autorepeat feature. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Available styles +================ + +- ``default`` a normal button. +- ``anchor`` Like default, but the button fades away when the mouse is not + over it, leaving only the text or icon. +- ``hoversel_vertical`` Internally used by + :py:class:`~efl.elementary.hoversel.Hoversel` to give a continuous look + across its options. +- ``hoversel_vertical_entry`` Another internal for + :py:class:`~efl.elementary.hoversel.Hoversel`. +- ``naviframe`` Internally used by + :py:class:`~efl.elementary.naviframe.Naviframe` for its back button. +- ``colorselector`` Internally used by + :py:class:`~efl.elementary.colorselector.Colorselector` for its left and + right buttons. + + +Layout content parts +==================== + +- ``icon`` - An icon of the button + + +Layout text parts +================= + +- ``default`` - Label of the button + + +Emitted signals +=============== - ``clicked``: the user clicked the button (press/release). - ``repeated``: the user pressed the button without releasing it. @@ -36,30 +70,12 @@ This widget emits the following signals, besides the ones sent from - ``focused`` : When the button has received focus. (since 1.8) - ``unfocused`` : When the button has lost focus. (since 1.8) -Also, defined in the default theme, the button has the following styles -available: -- ``default``: a normal button. -- ``anchor``: Like default, but the button fades away when the mouse is not - over it, leaving only the text or icon. -- ``hoversel_vertical``: Internally used by - :py:class:`~efl.elementary.hoversel.Hoversel` to give a continuous look - across its options. -- ``hoversel_vertical_entry``: Another internal for - :py:class:`~efl.elementary.hoversel.Hoversel`. -- ``naviframe``: Internally used by - :py:class:`~efl.elementary.naviframe.Naviframe` for its back button. -- ``colorselector``: Internally used by - :py:class:`~efl.elementary.colorselector.Colorselector` for its left and - right buttons. +Inheritance diagram +=================== -Default content parts of the button widget that you can use for are: - -- ``icon`` - An icon of the button - -Default text parts of the button widget that you can use for are: - -- ``default`` - Label of the button +.. inheritance-diagram:: efl.elementary.button + :parts: 2 """ diff --git a/efl/elementary/calendar_elm.pyx b/efl/elementary/calendar_elm.pyx index 8b22311..77a2c5b 100644 --- a/efl/elementary/calendar_elm.pyx +++ b/efl/elementary/calendar_elm.pyx @@ -18,11 +18,14 @@ """ -Widget description ------------------- +:mod:`calendar_elm` Module +########################## .. image:: /images/calendar-preview.png - :align: left + + +Widget description +================== This is a calendar widget. @@ -36,8 +39,9 @@ The API of this widget lets the applications perform other functions, like: - setting the day names of the week (e.g. "Thu" or "Thursday") - setting the year and month format. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``changed`` - emitted when the date in the calendar is changed. - ``display,changed`` - emitted when the current month displayed in the @@ -47,12 +51,12 @@ This widget emits the following signals, besides the ones sent from Enumerations ------------- +============ .. _Elm_Calendar_Mark_Repeat_Type: Calendar mark repeat types -========================== +-------------------------- .. data:: ELM_CALENDAR_UNIQUE @@ -91,7 +95,7 @@ Calendar mark repeat types .. _Elm_Calendar_Select_Mode: Calendar selection modes -======================== +------------------------ .. data:: ELM_CALENDAR_SELECT_MODE_DEFAULT @@ -113,7 +117,7 @@ Calendar selection modes .. _Elm_Calendar_Selectable: Selectable -========== +---------- .. data:: ELM_CALENDAR_SELECTABLE_NONE @@ -135,7 +139,7 @@ Selectable .. _Elm_Calendar_Weekday: Days -==== +---- .. data:: ELM_DAY_SUNDAY @@ -165,6 +169,13 @@ Days Saturday + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.calendar_elm + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/check.pyx b/efl/elementary/check.pyx index b475319..76e66e2 100644 --- a/efl/elementary/check.pyx +++ b/efl/elementary/check.pyx @@ -18,11 +18,14 @@ """ -Widget description ------------------- +:mod:`check` Module +################### .. image:: /images/check-preview.png - :align: left + + +Widget description +================== The check widget allows for toggling a value between true and false. @@ -30,24 +33,36 @@ Check objects are a lot like radio objects in layout and functionality, except they do not work as a group, but independently, and only toggle the value of a boolean :py:attr:`~Check.state` between false and true. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``changed`` - This is called whenever the user changes the state of the check objects. - ``focused`` - When the check has received focus. (since 1.8) - ``unfocused`` - When the check has lost focus. (since 1.8) -Default content parts of the check widget that you can use for are: + +Layout content parts +==================== - ``icon`` - An icon of the check -Default text parts of the check widget that you can use for are: + +Layout text parts +================= - ``default`` - A label of the check - ``on`` - On state label of the check - ``off`` - Off state label of the check + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.check + :parts: 2 + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/clock.pyx b/efl/elementary/clock.pyx index da79fbe..2aa288d 100644 --- a/efl/elementary/clock.pyx +++ b/efl/elementary/clock.pyx @@ -18,11 +18,14 @@ """ -Widget description ------------------- +:mod:`clock` Module +################### .. image:: /images/clock-preview.png - :align: left + + +Widget description +================== This is a digital clock widget. @@ -49,8 +52,9 @@ the user to reach a time which is distant from the one set. The time display is, by default, in military mode (24h), but an am/pm indicator may be optionally shown, too, when it will switch to 12h. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``changed`` - the clock's user changed the time - ``focused`` - When the clock has received focus. (since 1.8) @@ -58,12 +62,12 @@ This widget emits the following signals, besides the ones sent from Enumerations ------------- +============ .. _Elm_Clock_Edit_Mode: Clock edit modes -================ +---------------- .. data:: ELM_CLOCK_EDIT_DEFAULT @@ -97,6 +101,13 @@ Clock edit modes Edit all + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.clock + :parts: 2 + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/colorselector.pyx b/efl/elementary/colorselector.pyx index 434d550..ee56320 100644 --- a/efl/elementary/colorselector.pyx +++ b/efl/elementary/colorselector.pyx @@ -18,11 +18,14 @@ """ -Widget description ------------------- +:mod:`colorselector` Module +########################### .. image:: /images/colorselector-preview.png - :align: left + + +Widget description +================== A Colorselector is a color selection widget. @@ -32,8 +35,9 @@ the colors are loaded/saved from/to config using "default" identifier. The colors can be picked by user from the color set by clicking on individual color item on the palette or by selecting it from selector. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``"changed"`` - When the color value changes on selector - ``"color,item,selected"`` - When user clicks on color item. @@ -47,12 +51,12 @@ This widget emits the following signals, besides the ones sent from Enumerations ------------- +============ .. _Elm_Colorselector_Mode: Colorselector modes -=================== +------------------- .. data:: ELM_COLORSELECTOR_PALETTE @@ -66,6 +70,13 @@ Colorselector modes Show palette and components + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.colorselector + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/configuration.pyx b/efl/elementary/configuration.pyx index baf9173..f57292d 100644 --- a/efl/elementary/configuration.pyx +++ b/efl/elementary/configuration.pyx @@ -18,8 +18,12 @@ """ +:mod:`configuration` Module +########################### + + Description ------------ +=========== Elementary configuration is formed by a set options bounded to a given profile, like theme, "finger size", etc. @@ -87,14 +91,13 @@ information please visit: http://www.linuxfoundation.org/collaborate/workgroups/accessibility/atk/at-spi/at-spi_on_d-bus - Enumerations ------------- +============ .. _Elm_Softcursor_Mode: Elm_Softcursor_Mode -=================== +------------------- .. data:: ELM_SOFTCURSOR_MODE_AUTO @@ -112,7 +115,7 @@ Elm_Softcursor_Mode .. _Elm_Slider_Indicator_Visible_Mode: Elm_Slider_Indicator_Visible_Mode -================================= +--------------------------------- .. data:: ELM_SLIDER_INDICATOR_VISIBLE_MODE_DEFAULT @@ -134,7 +137,7 @@ Elm_Slider_Indicator_Visible_Mode .. _Edje_Channel: Audio Channels -============== +-------------- .. data:: EDJE_CHANNEL_EFFECT @@ -168,6 +171,13 @@ Audio Channels All audio channels (convenience) + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.configuration + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/conformant.pyx b/efl/elementary/conformant.pyx index ab0af44..e154b0f 100644 --- a/efl/elementary/conformant.pyx +++ b/efl/elementary/conformant.pyx @@ -17,10 +17,14 @@ """ +:mod:`conformant` Module +######################## + .. image:: /images/conformant-preview.png + Widget description ------------------- +================== The aim is to provide a widget that can be used in elementary apps to account for space taken up by the indicator, virtual keypad & softkey @@ -30,21 +34,27 @@ So conformant content will be sized and positioned considering the space required for such stuff, and when they popup, as a keyboard shows when an entry is selected, conformant content won't change. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``virtualkeypad,state,on``: if virtualkeypad state is switched to ``on``. - ``virtualkeypad,state,off``: if virtualkeypad state is switched to ``off``. - ``clipboard,state,on``: if clipboard state is switched to ``on``. - ``clipboard,state,off``: if clipboard state is switched to ``off``. -In all cases, the ``event`` parameter of the callback will be None. -Available styles for it: - - ``default`` +Layout content parts +==================== -Default content parts of the conformant widget that you can use for are: - - ``default`` - A content of the conformant +- ``default`` - A content of the conformant + + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.conformant + :parts: 2 """ diff --git a/efl/elementary/ctxpopup.pyx b/efl/elementary/ctxpopup.pyx index 42fe107..ced29e2 100644 --- a/efl/elementary/ctxpopup.pyx +++ b/efl/elementary/ctxpopup.pyx @@ -18,11 +18,14 @@ """ -Widget description ------------------- +:mod:`ctxpopup` Module +###################### .. image:: /images/ctxpopup-preview.png - :align: left + + +Widget description +================== A ctxpopup is a widget that, when shown, pops up a list of items. It automatically chooses an area inside its parent object's view to @@ -31,7 +34,12 @@ to it's top left position at the time one shows it. Ctxpopup items have a label and/or an icon. It is intended for a small number of items (hence the use of list, not genlist). -Signals that you can add callbacks for are: +.. note:: + + Ctxpopup is a specialization of :py:class:`~efl.elementary.hover.Hover`. + +Emitted signals +=============== - ``dismissed`` - This is called when 1. the outside of ctxpopup was clicked or 2. its parent area is changed or 3. the language is changed and also when @@ -42,30 +50,25 @@ Signals that you can add callbacks for are: - ``focused`` - When the ctxpopup has received focus. (since 1.8) - ``unfocused`` - When the ctxpopup has lost focus. (since 1.8) -Default content parts of the ctxpopup widget that you can use for are: +Layout content parts +==================== - ``default`` - A content of the ctxpopup - -Default content parts of the ctxpopup items that you can use for are: - - ``icon`` - An icon in the title area -Default text parts of the ctxpopup items that you can use for are: +Layout text parts +================= - ``default`` - Title label in the title area -.. note:: - - Ctxpopup is a specialization of :py:class:`~efl.elementary.hover.Hover`. - Enumerations ------------- +============ .. _Elm_Ctxpopup_Direction: Ctxpopup arrow directions -========================= +------------------------- .. data:: ELM_CTXPOPUP_DIRECTION_DOWN @@ -87,6 +90,14 @@ Ctxpopup arrow directions Arrow direction is unknown + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.ctxpopup + :parts: 2 + + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/datetime_elm.pyx b/efl/elementary/datetime_elm.pyx index 3c27551..20cc43c 100644 --- a/efl/elementary/datetime_elm.pyx +++ b/efl/elementary/datetime_elm.pyx @@ -18,8 +18,12 @@ """ +:mod:`datetime_elm` Module +########################## + + Widget description ------------------- +================== Datetime widget is used to display and input date & time values. @@ -182,8 +186,9 @@ To enable a module, set the ELM_MODULES environment variable as shown: **export ELM_MODULES="datetime_input_ctxpopup>datetime/api"** -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``changed`` - whenever Datetime field value is changed, this signal is sent. - ``language,changed`` - whenever system locale changes, this signal is sent. @@ -192,12 +197,12 @@ This widget emits the following signals, besides the ones sent from Enumerations ------------- +============ .. _Elm_Datetime_Field_Type: Datetime fields -=============== +--------------- .. data:: ELM_DATETIME_YEAR @@ -223,6 +228,13 @@ Datetime fields Am/Pm + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.datetime_elm + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/dayselector.pyx b/efl/elementary/dayselector.pyx index 7abcf00..5a3cd4e 100644 --- a/efl/elementary/dayselector.pyx +++ b/efl/elementary/dayselector.pyx @@ -18,10 +18,14 @@ """ +:mod:`dayselector` Module +######################### + .. image:: /images/dayselector-preview.png + Widget description ------------------- +================== Dayselector displays all seven days of the week and allows the user to select multiple days. @@ -59,24 +63,21 @@ Check object representing a day can be set/get by the application by using the elm_object_part_content_set/get APIs thus providing a way to handle the different check styles for individual days. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``dayselector,changed`` - when the user changes the state of a day. - ``language,changed`` - the program's language changed -Available styles for dayselector are: - -- ``default`` - Enumerations ------------- +============ .. _Elm_Dayselector_Day: Dayselector days -================ +---------------- .. data:: ELM_DAYSELECTOR_SUN @@ -106,6 +107,13 @@ Dayselector days Saturday + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.dayselector + :parts: 2 + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/diskselector.pyx b/efl/elementary/diskselector.pyx index dafd6b1..a35549c 100644 --- a/efl/elementary/diskselector.pyx +++ b/efl/elementary/diskselector.pyx @@ -17,10 +17,14 @@ """ +:mod:`diskselector` Module +########################## + .. image:: /images/diskselector-preview.png + Widget description ------------------- +================== A diskselector is a kind of list widget. It scrolls horizontally, and can contain label and icon objects. Three items are displayed @@ -29,7 +33,9 @@ with the selected one in the middle. It can act like a circular list with round mode and labels can be reduced for a defined length for side items. -Smart callbacks one can listen to: + +Emitted signals +=============== - ``selected`` - when item is selected, i.e. scroller stops. - ``clicked`` - This is called when a user clicks an item @@ -40,20 +46,20 @@ Smart callbacks one can listen to: - ``focused`` - When the diskselector has received focus. (since 1.8) - ``unfocused`` - When the diskselector has lost focus. (since 1.8) -Available styles for it: +.. note:: The ``scroll,anim,*`` and ``scroll,drag,*`` signals are only emitted + by user intervention. -- ``default`` - -Default content parts of the diskselector items that you can use for are: +Layout content parts +==================== - ``icon`` - An icon in the diskselector item -Default text parts of the diskselector items that you can use for are: + +Layout text parts +================= - ``default`` - Label of the diskselector item -.. note:: The ``scroll,anim,*`` and ``scroll,drag,*`` signals are only emitted - by user intervention. Scrollable Interface ==================== @@ -69,6 +75,13 @@ using multiple inheritance, for example:: def __init__(self, canvas, *args, **kwargs): Genlist.__init__(self, canvas) + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.diskselector + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/entry.pyx b/efl/elementary/entry.pyx index ede71a6..d947335 100644 --- a/efl/elementary/entry.pyx +++ b/efl/elementary/entry.pyx @@ -18,11 +18,14 @@ """ -Widget description ------------------- +:mod:`entry` Module +################### .. image:: /images/entry-preview.png - :align: left + + +Widget description +================== An entry is a convenience widget which shows a box that the user can enter text into. @@ -39,6 +42,7 @@ Other features include password mode, filtering of inserted text with :py:meth:`~efl.elementary.entry.Entry.markup_filter_append` and related functions, inline "items" and formatted markup text. + Scrollable Interface ==================== @@ -53,6 +57,7 @@ using multiple inheritance, for example:: def __init__(self, canvas, *args, **kwargs): Genlist.__init__(self, canvas) + Formatted text ============== @@ -71,6 +76,7 @@ Currently defined by the default theme are the following tags: - ...: Underlines the enclosed text. - ...: Highlights the enclosed text. + Special markups =============== @@ -78,8 +84,9 @@ Besides those used to format text, entries support two special markup tags used to insert click-able portions of text or items inlined within the text. + Anchors -''''''' +------- Anchors are similar to HTML anchors. Text can be surrounded by and tags and an event will be generated when this text is clicked, @@ -96,8 +103,9 @@ callback function. The same applies for "anchor,in" (mouse in), "anchor,out" (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on an anchor. + Items -''''' +----- Inlined in the text, any other :py:class:`~efl.elementary.object.Object` can be inserted by using tags this way:: @@ -186,6 +194,7 @@ Alternatively, an item may reference an image by its path, using the URI form ``file:///path/to/an/image.png`` and the entry will then use that image for the item. + Setting entry's style ===================== @@ -200,6 +209,7 @@ aesthetic reasons. While the user style should be changed when you would like to change the style to something specific defined at run-time, e.g, setting font or font size in a text editor. + Loading and saving files ======================== @@ -209,10 +219,9 @@ can be disabled with :py:attr:`~efl.elementary.entry.Entry.autosave` and files can be loaded directly as plain text or have any markup in them recognized. See :py:attr:`~efl.elementary.entry.Entry.file` for more details. -Emitted signals ---------------- -This widget emits the following signals: +Emitted signals +=============== - ``changed``: The text within the entry was changed. - ``changed,user``: The text within the entry was changed because of user @@ -253,24 +262,27 @@ This widget emits the following signals: - ``rejected``: .Called when some of inputs are rejected by the filter. (since 1.9) -Default content parts of the entry items that you can use for are: +Layout content parts +==================== - ``icon`` - An icon in the entry - ``end`` - A content in the end of the entry -Default text parts of the entry that you can use for are: + +Layout text parts +================= - ``default`` - text of the entry - ``guide`` - placeholder of the entry Enumerations ------------- +============ .. _Elm_Entry_Autocapital_Type: Autocapitalization types -======================== +------------------------ .. data:: ELM_AUTOCAPITAL_TYPE_NONE @@ -292,7 +304,7 @@ Autocapitalization types .. _Elm_Entry_Cnp_Mode: Copy & paste modes -================== +------------------ .. data:: ELM_CNP_MODE_MARKUP @@ -310,7 +322,7 @@ Copy & paste modes .. _Elm_Input_Hints: Input Hints -=========== +----------- .. data:: ELM_INPUT_HINT_NONE @@ -334,7 +346,7 @@ Input Hints .. _Elm_Entry_Input_Panel_Lang: Input panel language sort order -=============================== +------------------------------- .. data:: ELM_INPUT_PANEL_LANG_AUTOMATIC @@ -348,7 +360,7 @@ Input panel language sort order .. _Elm_Entry_Input_Panel_Layout: Input panel layouts -=================== +------------------- .. data:: ELM_INPUT_PANEL_LAYOUT_NORMAL @@ -414,7 +426,7 @@ Input panel layouts .. _Elm_Input_Panel_Layout_Normal_Variation: Input panel normal layout variation -=================================== +----------------------------------- .. data:: ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_NORMAL @@ -438,7 +450,7 @@ Input panel normal layout variation .. _Elm_Input_Panel_Layout_Numberonly_Variation: Input panel numberonly layout variation -======================================= +--------------------------------------- .. data:: ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_NORMAL @@ -468,7 +480,7 @@ Input panel numberonly layout variation .. _Elm_Input_Panel_Layout_Password_Variation: Input panel password layout variation -===================================== +------------------------------------- .. data:: ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NORMAL @@ -486,7 +498,7 @@ Input panel password layout variation .. _Elm_Entry_Input_Panel_Return_Key_Type: Input panel return key modes -============================ +---------------------------- .. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT @@ -530,7 +542,7 @@ Input panel return key modes .. _Elm_Entry_Text_Format: Text format -=========== +----------- .. data:: ELM_TEXT_FORMAT_PLAIN_UTF8 @@ -544,7 +556,7 @@ Text format .. _Elm_Entry_Wrap_Type: Wrap mode -========= +--------- .. data:: ELM_WRAP_NONE @@ -566,7 +578,7 @@ Wrap mode .. _Elm_Entry_Icon_Type: Icon types -========== +---------- .. data:: ELM_ICON_NONE @@ -581,6 +593,12 @@ Icon types Icon is set with standards names +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.entry + :parts: 2 + """ from libc.string cimport strdup diff --git a/efl/elementary/fileselector.pyx b/efl/elementary/fileselector.pyx index 0a239b2..ef476da 100644 --- a/efl/elementary/fileselector.pyx +++ b/efl/elementary/fileselector.pyx @@ -18,10 +18,14 @@ """ +:mod:`fileselector` Module +########################## + .. image:: /images/fileselector-preview.png + Widget description ------------------- +================== A file selector is a widget that allows a user to navigate through a file system, reporting file selections back via its API. @@ -48,31 +52,35 @@ If Elementary is built with support of the Ethumb thumbnailing library, the second form of view will display preview thumbnails of files which it supports. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``activated`` - the user activated a file. This can happen by - double-clicking or pressing Enter key. (**event_info** is a - string with the activated file path) -- ``selected`` - the user has clicked on a file (when not in - folders-only mode) or directory (when in folders-only mode) -- ``directory,open`` - the list has been populated with new - content (*event_info* is the directory's path) + double-clicking or pressing Enter key. (**event_info** is a string with the + activated file path) +- ``selected`` - the user has clicked on a file (when not in folders-only + mode) or directory (when in folders-only mode) +- ``directory,open`` - the list has been populated with new content + (*event_info* is the directory's path) - ``done`` - the user has clicked on the "ok" or "cancel" buttons (*event_info* is the selection's path) -For text, elm_layout_text_set() will work here on: + +Layout text parts +================= - ``ok`` - OK button label if the ok button is set. (since 1.8) - ``cancel`` - Cancel button label if the cancel button is set. (since 1.8) + Enumerations ------------- +============ .. _Elm_Fileselector_Mode: Fileselector modes -================== +------------------ .. data:: ELM_FILESELECTOR_LIST @@ -82,10 +90,11 @@ Fileselector modes Layout as a grid + .. _Elm_Fileselector_Sort: Fileselector sort method -======================== +------------------------ .. data:: ELM_FILESELECTOR_SORT_BY_FILENAME_ASC @@ -135,6 +144,13 @@ Fileselector sort method .. versionadded:: 1.9 + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.fileselector + :parts: 2 + """ diff --git a/efl/elementary/fileselector_button.pyx b/efl/elementary/fileselector_button.pyx index a566b98..70aa397 100644 --- a/efl/elementary/fileselector_button.pyx +++ b/efl/elementary/fileselector_button.pyx @@ -18,10 +18,14 @@ """ +:mod:`fileselector_button` Module +################################# + .. image:: /images/fileselector-button-preview.png + Widget description ------------------- +================== This is a button that, when clicked, creates an Elementary window (or inner window) with a :py:class:`~efl.elementary.fileselector.Fileselector` @@ -34,30 +38,36 @@ This widget encapsulates operations on its internal file selector on its own API. There is less control over its file selector than that one would have instantiating one directly. -The following styles are available for this button: + +Available styles +================ - ``default`` - ``anchor`` - ``hoversel_vertical`` - ``hoversel_vertical_entry`` -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.button.Button`: + +Emitted signals +=============== - ``file,chosen`` - the user has selected a path which comes as the ``event_info`` data - ``language,changed`` - the program's language changed -Default text parts of the fileselector_button widget that you can use for -are: + +Layout text parts +================= - ``default`` - Label of the fileselector_button -Default content parts of the fileselector_button widget that you can use -for are: + +Layout content parts +==================== - ``icon`` - Icon of the fileselector_button + Fileselector Interface ====================== @@ -72,6 +82,14 @@ using multiple inheritance, for example:: def __init__(self, canvas, *args, **kwargs): FileselectorButton.__init__(self, canvas) + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.fileselector_button + :parts: 2 + + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/fileselector_entry.pyx b/efl/elementary/fileselector_entry.pyx index e9678b3..eb872ca 100644 --- a/efl/elementary/fileselector_entry.pyx +++ b/efl/elementary/fileselector_entry.pyx @@ -18,10 +18,14 @@ """ +:mod:`fileselector_entry` Module +################################ + .. image:: /images/fileselector-entry-preview.png + Widget description ------------------- +================== This is an entry made to be filled with or display a file system path string. @@ -41,7 +45,9 @@ This widget encapsulates operations on its internal file selector on its own API. There is less control over its file selector than that one would have instantiating one directly. -Smart callbacks one can register to: + +Emitted signals +=============== - ``changed`` - The text within the entry was changed - ``activated`` - The entry has had editing finished and @@ -64,16 +70,19 @@ Smart callbacks one can register to: comes as the ``event_info`` data. - ``language,changed`` - the program's language changed -Default text parts of the fileselector_button widget that you can use for -are: + +Layout text parts +================= - ``default`` - Label of the fileselector_button -Default content parts of the fileselector_entry widget that you can use for -are: + +Layout content parts +==================== - ``button icon`` - Button icon of the fileselector_entry + Fileselector Interface ====================== @@ -88,6 +97,13 @@ using multiple inheritance, for example:: def __init__(self, canvas, *args, **kwargs): FileselectorButton.__init__(self, canvas) + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.fileselector_entry + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/flip.pyx b/efl/elementary/flip.pyx index 72234c9..52782ca 100644 --- a/efl/elementary/flip.pyx +++ b/efl/elementary/flip.pyx @@ -18,10 +18,14 @@ """ +:mod:`flip` Module +################## + .. image:: /images/flip-preview.png + Widget description ------------------- +================== This widget holds two content :py:class:`efl.evas.Object`: one on the front and one on the back. It allows you to flip from front to back @@ -33,24 +37,28 @@ and then call :py:meth:`Flip.go` you would see whatever is below the flip. For a list of supported animations see :py:meth:`Flip.go`. -Signals that you can add callbacks for are: + +Emitted signals +=============== - ``animate,begin`` - when a flip animation was started - ``animate,done`` - when a flip animation is finished -Default content parts of the flip widget that you can use for are: + +Layout content parts +==================== - ``front`` - A front content of the flip - ``back`` - A back content of the flip Enumerations ------------- +============ .. _Elm_Flip_Direction: Flip directions -=============== +--------------- .. data:: ELM_FLIP_DIRECTION_UP @@ -75,7 +83,7 @@ Flip directions .. _Elm_Flip_Interaction: Flip interaction modes -====================== +---------------------- .. data:: ELM_FLIP_INTERACTION_NONE @@ -97,9 +105,7 @@ Flip interaction modes .. _Elm_Flip_Mode: Flip types -========== - -.. rubric:: Flip rotation types +---------- .. data:: ELM_FLIP_ROTATE_Y_CENTER_AXIS @@ -125,9 +131,6 @@ Flip types middle of its height, the other content is shown as the other side of the flip. - -.. rubric:: Flip cube types - .. data:: ELM_FLIP_CUBE_LEFT Rotate the currently visible content to the left as if the flip was a @@ -148,9 +151,6 @@ Flip types Rotate the currently visible content down as if the flip was a cube, the other content is show as the upper face of the cube. - -.. rubric:: Flip page types - .. data:: ELM_FLIP_PAGE_LEFT Move the currently visible content to the left as if the flip was a @@ -171,6 +171,14 @@ Flip types Move the currently visible content down as if the flip was a book, the other content is shown as the page below that. + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.flip + :parts: 2 + + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/flipselector.pyx b/efl/elementary/flipselector.pyx index a87329b..342bffb 100644 --- a/efl/elementary/flipselector.pyx +++ b/efl/elementary/flipselector.pyx @@ -18,11 +18,14 @@ """ -Widget description ------------------- +:mod:`flipselector` Module +########################## .. image:: /images/flipselector-preview.png - :align: left + + +Widget description +================== A flip selector is a widget to show a set of *text* items, one at a time, with the same sheet switching style as the :py:class:`~efl.elementary.clock.Clock` @@ -35,8 +38,9 @@ the user. The interval between flips will keep growing in time, so that it helps the user to reach an item which is distant from the current selection. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``selected`` - when the widget's selected text item is changed - ``overflowed`` - when the widget's current selection is changed @@ -46,14 +50,19 @@ This widget emits the following signals, besides the ones sent from - ``focused`` - When the flipselector has received focus. (since 1.8) - ``unfocused`` - When the flipselector has lost focus. (since 1.8) -Available styles for it: -- ``default`` - -Default text parts of the flipselector items that you can use for are: +Layout text parts +================= - ``default`` - label of the flipselector item + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.flipselector + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/frame.pyx b/efl/elementary/frame.pyx index 7e5c6f7..6a17b2a 100644 --- a/efl/elementary/frame.pyx +++ b/efl/elementary/frame.pyx @@ -18,15 +18,20 @@ """ +:mod:`frame` Module +################### + .. image:: /images/frame-preview.png + Widget description ------------------- +================== Frame is a widget that holds some content and has a title. -The default look is a frame with a title, but Frame supports multiple -styles: + +Available styles +================ - default - pad_small @@ -38,19 +43,31 @@ styles: Out of all these styles only default shows the title. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``clicked`` - The user has clicked the frame's label -Default content parts of the frame widget that you can use for are: + +Layout content parts +==================== - ``default`` - A content of the frame -Default text parts of the frame widget that you can use for are: + +Layout text parts +================= - ``default`` - Label of the frame + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.frame + :parts: 2 + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/general.pyx b/efl/elementary/general.pyx index 19addcc..6294a2d 100644 --- a/efl/elementary/general.pyx +++ b/efl/elementary/general.pyx @@ -18,6 +18,10 @@ """ +:mod:`general` Module +##################### + + .. _General: General @@ -48,7 +52,6 @@ Different profiles may have pre-set values for finger sizes. Enumerations ============ - .. _Elm_Policy: Policy types @@ -233,6 +236,12 @@ Glob matching bitfiled flags .. versionadded:: 1.11 +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.general + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String, PyMem_Malloc, Py_DECREF, Py_INCREF diff --git a/efl/elementary/gengrid.pyx b/efl/elementary/gengrid.pyx index ff4d26f..2c3e66e 100644 --- a/efl/elementary/gengrid.pyx +++ b/efl/elementary/gengrid.pyx @@ -18,10 +18,14 @@ """ +:mod:`gengrid` Module +##################### + .. image:: /images/gengrid-preview.png + Widget description ------------------- +================== This widget aims to position objects in a grid layout while actually creating and rendering only the visible ones, using the same idea as the @@ -33,6 +37,7 @@ clicking on items to select them and clicking on the grid's viewport and swiping to pan the whole view) or via the keyboard, navigating through item with the arrow keys. + Scrollable Interface ==================== @@ -47,6 +52,7 @@ using multiple inheritance, for example:: def __init__(self, canvas, *args, **kwargs): Genlist.__init__(self, canvas) + Gengrid layouts =============== @@ -63,6 +69,7 @@ placed in **rows**, from left to right and, when the space for a row is filled, another one is started below, thus expanding the grid vertically (and making for vertical scrolling). + Gengrid items ============= @@ -85,6 +92,7 @@ by default - "default", but this can be extended by system or application custom themes/overlays/extensions (see :py:class:`~efl.elementary.theme.Theme` for more details). + Gengrid item classes ==================== @@ -135,6 +143,7 @@ following members: to the item (e.g. its data parameter on creation) can be deleted. See :py:meth:`GengridItem.delete`. + Usage hints =========== @@ -171,10 +180,9 @@ augmentation per application with elm_theme_extension_add(). If you absolutely must have a specific style that overrides any theme the user or system sets up you can use elm_theme_overlay_add() to add such a file. -Gengrid smart events -==================== -Smart events that you can add callbacks for are: +Emitted signals +=============== - ``activated`` - The user has double-clicked or pressed (enter|return|spacebar) on an item. The ``event_info`` parameter @@ -258,13 +266,14 @@ Smart events that you can add callbacks for are: - ``item,reorder,anim,stop`` - This is called when a gengrid item movement just stopped in reorder mode. The parameter is the item that was moved. (since 1.10) + Enumerations ------------- +============ .. _Elm_Gengrid_Item_Scrollto_Type: Items' scroll to types -====================== +---------------------- .. data:: ELM_GENLIST_ITEM_SCROLLTO_NONE @@ -286,7 +295,7 @@ Items' scroll to types .. _Elm_Gengrid_Object_Multi_Select_Mode: Multi-select mode -================= +----------------- .. data:: ELM_OBJECT_MULTI_SELECT_MODE_DEFAULT @@ -310,7 +319,7 @@ Multi-select mode .. _Elm_Gengrid_Reorder_Type: Reorder type -============ +------------ .. data:: ELM_GENGRID_REORDER_TYPE_NORMAL @@ -324,6 +333,13 @@ Reorder type .. versionadded:: 1.11 + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.gengrid + :parts: 2 + """ diff --git a/efl/elementary/genlist.pyx b/efl/elementary/genlist.pyx index 4366ce4..4215622 100644 --- a/efl/elementary/genlist.pyx +++ b/efl/elementary/genlist.pyx @@ -17,10 +17,14 @@ """ +:mod:`genlist` Module +##################### + .. image:: /images/genlist-preview.png + Widget description ------------------- +================== This widget aims to have more expansive list than the simple list in Elementary that could have more flexible items and allow many more @@ -34,6 +38,7 @@ Genlist has a fairly large API, mostly because it's relatively complex, trying to be both expansive, powerful and efficient. First we will begin an overview on the theory behind genlist. + Genlist item classes - creating items ===================================== @@ -89,7 +94,9 @@ parameter described below. A brief description of these functions follows: so any data attached to the item (e.g. its data parameter on creation) can be deleted. See :py:meth:`GenlistItemClass.delete`. -Available item styles: + +Available item styles +===================== - ``default`` - ``default_style`` The text part is a textblock @@ -102,6 +109,7 @@ Available item styles: - ``full`` Only one object, elm.swallow.content, which consumes whole area of the genlist item (since: 1.7) + Structure of items ================== @@ -123,6 +131,7 @@ by default - "default", but this can be extended by system or application custom themes/overlays/extensions (see :py:mod:`themes`) for more details). + Editing and Navigating ====================== @@ -164,6 +173,7 @@ the items are flattened in the list, so :py:attr:`GenlistItem.parent` will let you know which item is the parent (and thus know how to skip them if wanted). + Multi-selection =============== @@ -175,6 +185,7 @@ list is multi-select then :py:attr:`Genlist.selected_items` will return a list (that is only valid as long as no items are modified (added, deleted, selected or unselected)). + Usage hints =========== @@ -222,6 +233,7 @@ absolutely must have a specific style that overrides any theme the user or system sets up you can use :py:meth:`efl.elementary.theme.Theme.overlay_add` to add such a file. + Scrollable Interface ==================== @@ -236,6 +248,7 @@ using multiple inheritance, for example:: def __init__(self, canvas, *args, **kwargs): Genlist.__init__(self, canvas) + Implementation ============== @@ -267,10 +280,9 @@ requested (allowing for efficient building of a very deep tree that could even be used for file-management). See the above smart signal callbacks for details. -Genlist smart events -==================== -Signals that you can add callbacks for are: +Emitted signals +=============== - ``activated`` - The user has double-clicked or pressed (enter|return|spacebar) on an item. The ``event_info`` parameter is the @@ -379,12 +391,12 @@ Signals that you can add callbacks for are: Enumerations ------------- +============ .. _Elm_Genlist_Item_Type: Genlist item types -================== +------------------ .. data:: ELM_GENLIST_ITEM_NONE @@ -402,7 +414,7 @@ Genlist item types .. _Elm_Genlist_Item_Field_Type: Genlist items' field types -========================== +-------------------------- .. data:: ELM_GENLIST_ITEM_FIELD_ALL @@ -424,7 +436,7 @@ Genlist items' field types .. _Elm_Genlist_Item_Scrollto_Type: Genlist items' scroll-to types -============================== +------------------------------ .. data:: ELM_GENLIST_ITEM_SCROLLTO_NONE @@ -446,7 +458,7 @@ Genlist items' scroll-to types .. _Elm_Genlist_List_Mode: List sizing -=========== +----------- .. data:: ELM_LIST_COMPRESS @@ -488,7 +500,7 @@ List sizing .. _Elm_Genlist_Object_Select_Mode: Selection modes -=============== +--------------- .. data:: ELM_OBJECT_SELECT_MODE_DEFAULT @@ -507,6 +519,12 @@ Selection modes No select mode with no finger size rule +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.genlist + :parts: 2 + """ diff --git a/efl/elementary/gesture_layer.pyx b/efl/elementary/gesture_layer.pyx index 25679d2..ed49b74 100644 --- a/efl/elementary/gesture_layer.pyx +++ b/efl/elementary/gesture_layer.pyx @@ -18,10 +18,14 @@ """ +:mod:`gesture_layer` Module +########################### + .. image:: /images/gesturelayer-preview.png + Widget description ------------------- +================== Use the GestureLayer to detect gestures. The advantage is that you don't have to implement gesture detection, just set callbacks for gesture states. @@ -86,12 +90,12 @@ touch-surface and ends when no fingers touches surface (a *UP* event). Enumerations ------------- +============ .. _Elm_Gesture_State: Gesture states -============== +-------------- .. data:: ELM_GESTURE_STATE_UNDEFINED @@ -117,7 +121,7 @@ Gesture states .. _Elm_Gesture_Type: Gesture types -============= +------------- .. data:: ELM_GESTURE_N_TAPS @@ -155,6 +159,13 @@ Gesture types Rotate + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.gesture_layer + :parts: 2 + """ from cpython cimport Py_INCREF diff --git a/efl/elementary/glview.pyx b/efl/elementary/glview.pyx index e4166cb..a65945a 100644 --- a/efl/elementary/glview.pyx +++ b/efl/elementary/glview.pyx @@ -32,12 +32,12 @@ This widget emits the following signals, besides the ones sent from Enumerations ------------- +============ .. _Elm_GLView_Mode: GLView Mode -^^^^^^^^^^^ +----------- Defines mode of GLView @@ -65,7 +65,7 @@ Defines mode of GLView .. _Elm_GLView_Resize_Policy: GLView Resize Policy -^^^^^^^^^^^^^^^^^^^^ +-------------------- Defines a policy for the glview resizing. @@ -90,7 +90,7 @@ scaled. .. _Elm_GLView_Render_Policy: GLView Render Policy -^^^^^^^^^^^^^^^^^^^^ +-------------------- Defines a policy for gl rendering. diff --git a/efl/elementary/grid.pyx b/efl/elementary/grid.pyx index 0950114..c29c8d3 100644 --- a/efl/elementary/grid.pyx +++ b/efl/elementary/grid.pyx @@ -18,10 +18,14 @@ """ +:mod:`grid` Module +################## + .. image:: /images/grid-preview.png + Widget description ------------------- +================== A grid layout widget. @@ -34,6 +38,13 @@ widgets size itself. The default is 100 x 100, so that means the position and sizes of children will effectively be percentages (0 to 100) of the width or height of the grid widget. + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.grid + :parts: 2 + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/hover.pyx b/efl/elementary/hover.pyx index 09e53da..dc196b1 100644 --- a/efl/elementary/hover.pyx +++ b/efl/elementary/hover.pyx @@ -18,11 +18,14 @@ """ -Widget description ------------------- +:mod:`hover` Module +################### .. image:: /images/hover-preview.png - :align: left + + +Widget description +================== A Hover object will hover over its ``parent`` object at the ``target`` location. @@ -35,15 +38,18 @@ clicked that **doesn't** cause the hover to be dismissed. A Hover object has two parents. One parent that owns it during creation and the other parent being the one over which the hover object spans. -Elementary has the following styles for the hover widget: + +Available styles +================ - default - popout - menu - hoversel_vertical -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``clicked`` - the user clicked the empty space in the hover to dismiss. @@ -54,7 +60,9 @@ This widget emits the following signals, besides the ones sent from - ``focused`` - When the hover has received focus. (since 1.8) - ``unfocused`` - When the hover has lost focus. (since 1.8) -Default content parts of the hover widget that you can use for are: + +Layout content parts +==================== - ``left`` - ``top-left`` @@ -87,12 +95,12 @@ deleted, and vice-versa. Enumerations ------------- +============ .. _Elm_Hover_Axis: Hover axis -========== +---------- .. data:: ELM_HOVER_AXIS_NONE @@ -110,6 +118,13 @@ Hover axis Both + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.hover + :parts: 2 + """ from efl.eo cimport _object_mapping_register, object_from_instance diff --git a/efl/elementary/hoversel.pyx b/efl/elementary/hoversel.pyx index 28d4632..87dcec3 100644 --- a/efl/elementary/hoversel.pyx +++ b/efl/elementary/hoversel.pyx @@ -18,11 +18,14 @@ """ -Widget description ------------------- +:mod:`hoversel` Module +###################### .. image:: /images/hoversel-preview.png - :align: left + + +Widget description +================== A hoversel is a button that pops up a list of items (automatically choosing the direction to display) that have a label and, optionally, an @@ -32,8 +35,9 @@ It is a convenience widget to avoid the need to do all the piecing together yourself. It is intended for a small number of items in the hoversel menu (no more than 8), though is capable of many more. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.button.Button`: + +Emitted signals +=============== - ``clicked`` - the user clicked the hoversel button and popped up the sel @@ -44,22 +48,26 @@ This widget emits the following signals, besides the ones sent from - ``item,focused`` - the hoversel item has received focus. (since 1.10) - ``item,unfocused`` - the hoversel item has lost focus. (since 1.10) -Default content parts of the hoversel widget that you can use for are: + +Layout content parts +==================== - ``icon`` - An icon of the hoversel -Default text parts of the hoversel widget that you can use for are: + +Layout text parts +================= - ``default`` - Label of the hoversel Enumerations ------------- +============ .. _Elm_Hoversel_Icon_Type: Icon types -========== +---------- .. data:: ELM_ICON_NONE @@ -73,6 +81,13 @@ Icon types Icon is set with standards names + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.hoversel + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/icon.pyx b/efl/elementary/icon.pyx index a648658..ccf8179 100644 --- a/efl/elementary/icon.pyx +++ b/efl/elementary/icon.pyx @@ -18,10 +18,14 @@ """ +:mod:`icon` Module +################## + .. image:: /images/icon-preview.png + Widget description ------------------- +================== An icon object is used to display standard icon images ("delete", "edit", "arrows", etc.) or images coming from a custom file (PNG, JPG, @@ -136,20 +140,21 @@ And these are names for some media player specific icons: - ``media_player/rewind`` - ``media_player/stop`` -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.image.Image`: + +Emitted signals +=============== - ``thumb,done`` - Setting :py:attr:`~Icon.thumb` has completed with success - ``thumb,error`` - Setting :py:attr:`~Icon.thumb` has failed Enumerations ------------- +============ .. _Elm_Icon_Lookup_Order: Icon lookup modes -================= +----------------- .. data:: ELM_ICON_LOOKUP_FDO_THEME @@ -171,7 +176,7 @@ Icon lookup modes .. _Elm_Icon_Type: Icon type -========= +--------- .. data:: ELM_ICON_NONE @@ -185,6 +190,13 @@ Icon type Icon is set with standards name + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.icon + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/image.pyx b/efl/elementary/image.pyx index d07fc7e..b2eca9f 100644 --- a/efl/elementary/image.pyx +++ b/efl/elementary/image.pyx @@ -18,12 +18,15 @@ """ -Widget description ------------------- +:mod:`image` Module +################### .. image:: /images/image-preview.png +Widget description +================== + An Elementary image object allows one to load and display an image file on it, be it from a disk file or from a memory region. @@ -41,7 +44,9 @@ One can tune various properties of the image, like: An image object may also be made valid source and destination for drag and drop actions by setting :py:attr:`~Image.editable`. -Signals that you can add callbacks for are: + +Emitted signals +=============== - ``drop`` - This is called when a user has dropped an image typed object onto the object in question -- the @@ -52,13 +57,14 @@ Signals that you can add callbacks for are: - ``download,end`` - remote url download has finished - ``download,error`` - remote url download has finished with errors + Enumerations ------------- +============ .. _Elm_Image_Orient: Image manipulation types -======================== +------------------------ .. data:: ELM_IMAGE_ORIENT_NONE @@ -96,6 +102,13 @@ Image manipulation types Flip the image along the y = x line (top-left to bottom-right) + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.image + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/index.pyx b/efl/elementary/index.pyx index fc43d21..f19e17b 100644 --- a/efl/elementary/index.pyx +++ b/efl/elementary/index.pyx @@ -18,10 +18,14 @@ """ +:mod:`index` Module +################### + .. image:: /images/index-preview.png + Widget description ------------------- +================== An index widget gives you an index for fast access to whichever group of other UI items one might have. @@ -41,8 +45,9 @@ with :py:class:`~efl.elementary.list.List`, :py:class:`~efl.elementary.genlist.Genlist` or :py:class:`~efl.elementary.gengrid.Gengrid`. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``changed`` - When the selected index item changes. ``event_info`` is the selected item's data. @@ -63,6 +68,13 @@ The ``delay,changed`` event has a delay on change before the event is actually reported and moreover just the last event happening on those time frames will actually be reported. + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.index + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/innerwindow.pyx b/efl/elementary/innerwindow.pyx index 6d80c28..65be64e 100644 --- a/efl/elementary/innerwindow.pyx +++ b/efl/elementary/innerwindow.pyx @@ -17,11 +17,14 @@ """ -Widget description ------------------- +:mod:`innerwindow` Module +######################### .. image:: /images/innerwindow-preview.png - :align: left + + +Widget description +================== An inwin is a window inside a window that is useful for a quick popup. It does not hover. @@ -33,16 +36,25 @@ to show what's behind it without destroying it. If this is done, the :py:meth:`~InnerWindow.activate` function can be used to bring it back to full visibility again. -There are three styles available in the default theme. These are: -- default: The inwin is sized to take over most of the window it's +Available styles +================ + +- ``default`` The inwin is sized to take over most of the window it's placed in. -- minimal: The size of the inwin will be the minimum necessary to show +- ``minimal`` The size of the inwin will be the minimum necessary to show its contents. -- minimal_vertical: Horizontally, the inwin takes as much space as +- ``minimal_vertical`` Horizontally, the inwin takes as much space as possible, but it's sized vertically the most it needs to fit its contents. + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.innerwindow + :parts: 2 + """ from efl.eo cimport _object_mapping_register, object_from_instance diff --git a/efl/elementary/label.pyx b/efl/elementary/label.pyx index 58ec7ef..7db55cb 100644 --- a/efl/elementary/label.pyx +++ b/efl/elementary/label.pyx @@ -18,16 +18,24 @@ """ +:mod:`label` Module +################### + .. image:: /images/label-preview.png + Widget description ------------------- +================== Widget to display text, with simple html-like markup. The Label widget **doesn't** allow text to overflow its boundaries, if the text doesn't fit the geometry of the label it will be ellipsized or be -cut. Elementary provides several styles for this widget: +cut. + + +Available styles +================ - default - No animation - marker - Centers the text in the label and makes it bold by default @@ -44,20 +52,21 @@ cut. Elementary provides several styles for this widget: Custom themes can of course invent new markup tags and style them any way they like. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``language,changed`` - The program's language changed. - ``slide,end`` - The slide is end. Enumerations ------------- +============ .. _Elm_Label_Wrap_Type: Wrap modes -========== +---------- .. data:: ELM_WRAP_NONE @@ -79,7 +88,7 @@ Wrap modes .. _Elm_Label_Slide_Mode: Slide modes -=========== +----------- .. data:: ELM_LABEL_SLIDE_MODE_NONE @@ -93,6 +102,13 @@ Slide modes The label will always slide. + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.label + :parts: 2 + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/layout.pyx b/efl/elementary/layout.pyx index dbdab28..3837185 100644 --- a/efl/elementary/layout.pyx +++ b/efl/elementary/layout.pyx @@ -17,10 +17,14 @@ """ +:mod:`layout` Module +#################### + .. image:: /images/layout-preview.png + Widget description ------------------- +================== This is a container widget that takes a standard Edje design file and wraps it very thinly in a widget. @@ -113,6 +117,10 @@ some basic functionality depending on the theme used. Most of them already send some signals, some already provide a toolbar or back and next buttons. + +Available styles +================ + These are available predefined theme layouts. All of them have class = *layout*, group = *application*, and style = one of the following options: @@ -130,11 +138,20 @@ These are available predefined theme layouts. All of them have class = - ``toolbar-table`` - application with toolbar and main content area as a table -This widget emits the following signals: + +Emitted signals +=============== - ``theme,changed`` - The theme was changed. - ``language,changed`` - the program's language changed + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.layout + :parts: 2 + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/layout_class.pyx b/efl/elementary/layout_class.pyx index edbd313..e9abeb5 100644 --- a/efl/elementary/layout_class.pyx +++ b/efl/elementary/layout_class.pyx @@ -15,6 +15,46 @@ # You should have received a copy of the GNU Lesser General Public License # along with this Python-EFL. If not, see . +""" + +:mod:`layout_class` Module +########################## + +Description +=========== + +Elementary, besides having the :py:class:`~efl.elementary.layout.Layout` +widget, exposes its foundation -- the Elementary Layout Class -- in +order to create other widgets which are, basically, a certain layout +with some more logic on top. + +The idea is to make the creation of that widgets as easy as possible, +factorizing code on this common base. For example, a button is a layout +(that looks like push button) that happens to react on clicks and keyboard +events in a special manner, calling its user back on those events. That's no +surprise, then, that the :py:class:`~efl.elementary.button.Button` +implementation relies on LayoutClass, if you go to check it. + +Container parts, here, map directly to Edje parts from the layout's Edje +group. Besides that, there's a whole infrastructure around Edje files: + +- interfacing by signals, +- setting/retrieving text part values, +- dealing with table and box parts directly, +- etc. + +Finally, layout objects will do **part aliasing** for you, if you set +it up properly. For that, take a look at +Elm_Layout_Part_Alias_Description, where it's explained in detail. + + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.layout_class + :parts: 2 + +""" from cpython cimport PyUnicode_AsUTF8String @@ -36,31 +76,10 @@ cdef void layout_signal_callback(void *data, Evas_Object *obj, traceback.print_exc() cdef class LayoutClass(Object): - """ + """LayoutClass(...) - Elementary, besides having the :py:class:`~efl.elementary.layout.Layout` - widget, exposes its foundation -- the Elementary Layout Class -- in - order to create other widgets which are, basically, a certain layout - with some more logic on top. - - The idea is to make the creation of that widgets as easy as possible, - factorizing code on this common base. For example, a button is a layout - (that looks like push button) that happens to react on clicks and keyboard - events in a special manner, calling its user back on those events. That's no - surprise, then, that the :py:class:`efl.elementary.button.Button` - implementation relies on LayoutClass, if you go to check it. - - Container parts, here, map directly to Edje parts from the layout's Edje - group. Besides that, there's a whole infrastructure around Edje files: - - - interfacing by signals, - - setting/retrieving text part values, - - dealing with table and box parts directly, - - etc. - - Finally, layout objects will do **part aliasing** for you, if you set - it up properly. For that, take a look at - Elm_Layout_Part_Alias_Description, where it's explained in detail. + This is the base class for the :class:`~efl.elementary.layout.Layout` + widget and all the other widgets that inherit from it. """ diff --git a/efl/elementary/list.pyx b/efl/elementary/list.pyx index afdbd4a..1d7a08c 100644 --- a/efl/elementary/list.pyx +++ b/efl/elementary/list.pyx @@ -18,10 +18,14 @@ """ +:mod:`list` Module +################## + .. image:: /images/list-preview.png + Widget description ------------------- +================== A list widget is a container whose children are displayed vertically or horizontally, in order, and can be selected. @@ -31,13 +35,15 @@ modes of items displaying. A list is a very simple type of list widget. For more robust lists, :py:class:`~efl.elementary.genlist.Genlist` should probably be used. -Smart callbacks one can listen to: + +Emitted signals +=============== - ``activated`` - The user has double-clicked or pressed - (enter|return|spacebar) on an item. The ``event_info`` parameter - is the item that was activated. + (enter|return|spacebar) on an item. The ``event_info`` parameter + is the item that was activated. - ``clicked,double`` - The user has double-clicked an item. - The ``event_info`` parameter is the item that was double-clicked. + The ``event_info`` parameter is the item that was double-clicked. - ``clicked,right`` - The user has right-clicked an item. The ``event_info`` parameter is the item that was right-clicked. (since: 1.13) - ``selected`` - when the user selected an item @@ -61,19 +67,26 @@ Smart callbacks one can listen to: - ``item,focused`` - When the list item has received focus. (since 1.10) - ``item,unfocused`` - When the list item has lost focus. (since 1.10) -Available styles for it: + +Available styles +================ - ``default`` -Default content parts of the list items that you can use for are: + +Layout content parts +==================== - ``start`` - A start position object in the list item - ``end`` - A end position object in the list item -Default text parts of the list items that you can use for are: + +Layout text parts +================= - ``default`` - label in the list item + Scrollable Interface ==================== @@ -88,13 +101,14 @@ using multiple inheritance, for example:: def __init__(self, canvas, *args, **kwargs): Genlist.__init__(self, canvas) + Enumerations ------------- +============ .. _Elm_List_Mode: List sizing modes -================= +----------------- .. data:: ELM_LIST_COMPRESS @@ -136,7 +150,7 @@ List sizing modes .. _Elm_List_Object_Select_Mode: Selection modes -=============== +--------------- .. data:: ELM_OBJECT_SELECT_MODE_DEFAULT @@ -160,6 +174,12 @@ Selection modes No select mode with no finger size rule +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.list + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/map.pyx b/efl/elementary/map.pyx index ca4a3c0..f24aebd 100644 --- a/efl/elementary/map.pyx +++ b/efl/elementary/map.pyx @@ -18,11 +18,15 @@ """ +:mod:`map` Module +################# + .. image:: /images/map-preview.png :width: 100% + Widget description ------------------- +================== The *Map* is a widget specifically for displaying a geographic map. It uses `OpenStreetMap `_ as map tile provider, @@ -39,8 +43,8 @@ It supports some basic but yet nice features: - names/coordinates conversion (and viceversa) -Signals you can listen to -========================= +Emitted signals +=============== - ``clicked`` - Called when a user has clicked the map without dragging around. - ``clicked,double`` - Called when a user has double-clicked the map. @@ -70,6 +74,7 @@ Signals you can listen to - ``focused`` - When the map has received focus. (since 1.8) - ``unfocused`` - When the map has lost focus. (since 1.8) + Scrollable Interface ==================== @@ -84,13 +89,14 @@ using multiple inheritance, for example:: def __init__(self, canvas, *args, **kwargs): Genlist.__init__(self, canvas) + Enumerations ------------- +============ .. _Elm_Map_Overlay_Type: Map overlay types -================= +----------------- .. data:: ELM_MAP_OVERLAY_TYPE_NONE @@ -136,7 +142,7 @@ Map overlay types .. _Elm_Map_Route_Method: Map route methods -================= +----------------- .. data:: ELM_MAP_ROUTE_METHOD_FASTEST @@ -150,7 +156,7 @@ Map route methods .. _Elm_Map_Route_Type: Map route types -=============== +--------------- .. data:: ELM_MAP_ROUTE_TYPE_MOTOCAR @@ -168,7 +174,7 @@ Map route types .. _Elm_Map_Source_Type: Map source types -================ +---------------- .. data:: ELM_MAP_SOURCE_TYPE_TILE @@ -186,7 +192,7 @@ Map source types .. _Elm_Map_Zoom_Mode: Map zoom modes -============== +-------------- .. data:: ELM_MAP_ZOOM_MODE_MANUAL @@ -203,6 +209,13 @@ Map zoom modes Zoom until map fills scroll, ensuring no pixels are left unfilled. + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.map + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String, Py_INCREF, Py_DECREF diff --git a/efl/elementary/mapbuf.pyx b/efl/elementary/mapbuf.pyx index 941c04f..a504a72 100644 --- a/efl/elementary/mapbuf.pyx +++ b/efl/elementary/mapbuf.pyx @@ -17,11 +17,14 @@ """ -Widget description ------------------- +:mod:`mapbuf` Module +#################### .. image:: /images/mapbuf-preview.png - :align: left + + +Widget description +================== This holds one content object and uses an Evas Map of transformation points to be later used with this content. So the content will be @@ -30,10 +33,19 @@ when you have a complex interface, with a lot of elements, and will need to resize or move it frequently (the content object and its children). -Default content parts of the mapbuf widget that you can use are: + +Layout content parts +==================== - ``default`` - The main content of the mapbuf + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.mapbuf + :parts: 2 + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/menu.pyx b/efl/elementary/menu.pyx index a3dc528..b0f93eb 100644 --- a/efl/elementary/menu.pyx +++ b/efl/elementary/menu.pyx @@ -18,10 +18,14 @@ """ +:mod:`menu` Module +################## + .. image:: /images/menu-preview.png + Widget description ------------------- +================== A menu is a list of items displayed above its parent. @@ -29,19 +33,32 @@ When the menu is showing its parent is darkened. Each item can have a sub-menu. The menu object can be used to display a menu on a right click event, in a toolbar, anywhere. -Signals that you can add callbacks for are: + +Emitted signals +=============== - ``clicked`` - the user clicked the empty space in the menu to dismiss. - ``dismissed`` - the user clicked the empty space in the menu to dismiss (since 1.8) -Default content parts of the menu items that you can use for are: + +Layout content parts +==================== - ``default`` - A main content of the menu item -Default text parts of the menu items that you can use for are: + +Layout text parts +================= - ``default`` - label in the menu item + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.menu + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/multibuttonentry.pyx b/efl/elementary/multibuttonentry.pyx index 195de8b..aab9ad5 100644 --- a/efl/elementary/multibuttonentry.pyx +++ b/efl/elementary/multibuttonentry.pyx @@ -17,10 +17,14 @@ """ +:mod:`multibuttonentry` Module +############################## + .. image:: /images/multibuttonentry-preview.png + Widget description ------------------- +================== A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons. Each text button is inserted by pressing the @@ -33,8 +37,9 @@ Typical use case of multibuttonentry is, composing emails/messages to a group of addresses, each of which is an item that can be clicked for further actions. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``item,selected`` - this is called when an item is selected by api, user interaction, and etc. this is also called when a @@ -55,14 +60,19 @@ This widget emits the following signals, besides the ones sent from - ``expand,state,changed`` - when shrink mode state of multi-button entry is changed. -Default text parts of the multibuttonentry widget that you can use for are: +Layout text parts +================= - ``default`` - A label of the multibuttonentry - -Default text parts of the multibuttonentry items that you can use for are: - - ``default`` - A label of the multibuttonentry item + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.multibuttonentry + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String, Py_INCREF diff --git a/efl/elementary/naviframe.pyx b/efl/elementary/naviframe.pyx index ce7260b..bc79209 100644 --- a/efl/elementary/naviframe.pyx +++ b/efl/elementary/naviframe.pyx @@ -17,10 +17,14 @@ """ +:mod:`naviframe` Module +####################### + .. image:: /images/naviframe-preview.png + Widget description ------------------- +================== Naviframe stands for navigation frame. It's a views manager for applications. @@ -40,17 +44,18 @@ Naviframe views hold spaces to various elements, which are: - title icon and - content area. -Becase this widget is a layout, one places content on those areas by using -:py:func:`~efl.elementary.object.Object.part_content_set` on the right swallow -part names expected for each, which are: + +Layout content parts +==================== - ``default`` - The main content of the current page - ``icon`` - An icon in the title area of the current page - ``prev_btn`` - A button of the current page to go to the previous page - ``next_btn`` - A button of the current page to go to the next page -For text, :py:func:`~efl.elementary.object.Object.part_text_set` will work here -on: + +Layout text parts +================= - ``default`` - Title label in the title area of the current page - ``subtitle`` - Sub-title label in the title area of the current page @@ -58,6 +63,10 @@ on: Most of those content objects can be passed at the time of an item creation (see :py:meth:`~NaviframeItem.push_to`). + +Available styles +================ + Naviframe items can have different styles, which affect the transition between views, for example. On the default theme, two of them are supported: @@ -67,8 +76,8 @@ them are supported: and is overlapped by the new -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: +Emitted signals +=============== - ``transition,finished`` - When the transition is finished in changing the item - ``title,transition,finished`` - When the title area's transition is finished @@ -91,6 +100,13 @@ What happens is that the topmost item of a naviframe will be the widget's target layout, when accessed directly. Items lying below the top one can be interacted with this way. + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.naviframe + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/need.pyx b/efl/elementary/need.pyx index bb73e62..c0a2486 100644 --- a/efl/elementary/need.pyx +++ b/efl/elementary/need.pyx @@ -15,8 +15,22 @@ # You should have received a copy of the GNU Lesser General Public License # along with this Python-EFL. If not, see . +""" + +:mod:`need` Module +################## + +Description +=========== + +This functions are used to tell elementary of optionals modules usage. + +""" + + from efl.utils.deprecated cimport DEPRECATED + def need_efreet(): """Request that your elementary application needs Efreet diff --git a/efl/elementary/notify.pyx b/efl/elementary/notify.pyx index 75f5402..ba74d45 100644 --- a/efl/elementary/notify.pyx +++ b/efl/elementary/notify.pyx @@ -17,10 +17,14 @@ """ +:mod:`notify` Module +#################### + .. image:: /images/notify-preview.png + Widget description ------------------- +================== Display a container in a particular region of the parent. @@ -28,23 +32,27 @@ A timeout can be set to automatically hide the notify. This is so that, after an :py:meth:`~efl.evas.Object.show` on a notify object, if a timeout was set on it, it will **automatically** get hidden after that time. -Signals that you can add callbacks for are: + +Emitted signals +=============== - ``timeout`` - when timeout happens on notify and it's hidden - ``block,clicked`` - when a click outside of the notify happens -Default content parts of the notify widget that you can use are: + +Layout content parts +==================== - ``default`` - The main content of the notify Enumerations ------------- +============ .. _ELM_NOTIFY_ALIGN_FILL: ELM_NOTIFY_ALIGN_FILL -===================== +--------------------- .. data:: ELM_NOTIFY_ALIGN_FILL @@ -52,6 +60,13 @@ ELM_NOTIFY_ALIGN_FILL .. versionadded:: 1.8 + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.notify + :parts: 2 + """ from efl.eo cimport _object_mapping_register, object_from_instance diff --git a/efl/elementary/object.pyx b/efl/elementary/object.pyx index 80a6f47..464b390 100644 --- a/efl/elementary/object.pyx +++ b/efl/elementary/object.pyx @@ -18,8 +18,12 @@ """ +:mod:`object` Module +#################### + + Copy and Paste --------------- +============== Implements the following functionality @@ -63,12 +67,12 @@ More information is on Enumerations ------------- +============ .. _Elm_Object_Focus_Direction: Focus direction -=============== +--------------- .. data:: ELM_FOCUS_PREVIOUS @@ -102,10 +106,11 @@ Focus direction .. versionadded:: 1.8.1 + .. _Elm_Focus_Move_Policy: Focus move policy -================= +----------------- .. data:: ELM_FOCUS_MOVE_POLICY_CLICK @@ -119,10 +124,11 @@ Focus move policy .. versionadded:: 1.10 + .. _Elm_Focus_Autoscroll_Mode: Focus autoscroll mode -===================== +--------------------- .. data:: ELM_FOCUS_AUTOSCROLL_MODE_SHOW @@ -143,10 +149,11 @@ Focus autoscroll mode .. versionadded:: 1.10 + .. _Elm_Input_Event_Type: Input event types -================= +----------------- .. data:: EVAS_CALLBACK_KEY_DOWN .. data:: EVAS_CALLBACK_KEY_UP @@ -156,7 +163,7 @@ Input event types .. _Elm_Object_Sel_Type: Selection type -============== +-------------- Defines the types of selection property names. @@ -182,7 +189,7 @@ Defines the types of selection property names. .. _Elm_Object_Sel_Format: Selection format -================ +---------------- Defines the types of content. @@ -218,7 +225,7 @@ Defines the types of content. .. _Elm_Object_Xdnd_Action: XDND action -=========== +----------- Defines the kind of action associated with the drop data if for XDND @@ -257,6 +264,12 @@ Defines the kind of action associated with the drop data if for XDND Describe the data +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.object + :parts: 2 + """ from cpython cimport PyObject, Py_INCREF, Py_DECREF, PyObject_GetAttr, \ @@ -365,6 +378,7 @@ cdef void _event_data_del_cb(void *data, Evas_Object *o, # Py_DECREF(data) +# TODO: why the hell we redefine Canvas here?? cdef class Canvas(evasCanvas): def __init__(self): pass diff --git a/efl/elementary/object_item.pyx b/efl/elementary/object_item.pyx index 924b220..99bb770 100644 --- a/efl/elementary/object_item.pyx +++ b/efl/elementary/object_item.pyx @@ -15,6 +15,20 @@ # You should have received a copy of the GNU Lesser General Public License # along with this Python-EFL. If not, see . +""" + +:mod:`object_item` Module +######################### + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.object_item + :parts: 2 + +""" + + from cpython cimport PyUnicode_AsUTF8String, Py_DECREF, Py_INCREF from libc.stdint cimport uintptr_t @@ -100,7 +114,8 @@ cdef void _object_item_callback2(void *data, Evas_Object *obj, void *event_info) cdef class ObjectItem(object): """ - A generic item for the widgets. + A generic item for the widgets. This is the base class for all the other + widget items. .. py:attribute:: data diff --git a/efl/elementary/panel.pyx b/efl/elementary/panel.pyx index 83f5676..9a421c2 100644 --- a/efl/elementary/panel.pyx +++ b/efl/elementary/panel.pyx @@ -18,40 +18,40 @@ """ +:mod:`panel` Module +################### + .. image:: /images/panel-preview.png + Widget description ------------------- +================== A panel is a type of animated container that contains subobjects. It can be expanded or contracted by clicking the button on it's edge. -Orientations are as follows: -- ELM_PANEL_ORIENT_TOP -- ELM_PANEL_ORIENT_LEFT -- ELM_PANEL_ORIENT_RIGHT -- ELM_PANEL_ORIENT_BOTTOM - -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: +Emitted signals +=============== - ``focused`` - When the panel has received focus. (since 1.8) - ``unfocused`` - When the panel has lost focus. (since 1.8) -Default content parts of the panel widget that you can use for are: + +Layout content parts +==================== - ``default`` - A content of the panel Enumerations ------------- +============ .. _Elm_Panel_Orient: Panel orientation types -======================= +----------------------- .. data:: ELM_PANEL_ORIENT_TOP @@ -69,6 +69,13 @@ Panel orientation types Panel (dis)appears from the right + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.panel + :parts: 2 + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/panes.pyx b/efl/elementary/panes.pyx index 13d7a8d..0ad549f 100644 --- a/efl/elementary/panes.pyx +++ b/efl/elementary/panes.pyx @@ -17,11 +17,14 @@ """ -Widget description ------------------- +:mod:`panes` Module +################### .. image:: /images/panes-preview.png - :align: left + + +Widget description +================== The panes widget adds a draggable bar between two contents. When dragged this bar will resize contents' size. @@ -29,19 +32,18 @@ dragged this bar will resize contents' size. Panes can be displayed vertically or horizontally, and contents size proportion can be customized (homogeneous by default). -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``press`` - The panes has been pressed (button wasn't released yet). - ``unpressed`` - The panes was released after being pressed. - ``clicked`` - The panes has been clicked. - ``clicked,double`` - The panes has been double clicked. -Available styles for it: -- ``default`` - -Default content parts of the panes widget that you can use are: +Layout content parts +==================== - ``left`` - A leftside content of the panes - ``right`` - A rightside content of the panes @@ -50,6 +52,13 @@ Default content parts of the panes widget that you can use are: If panes are displayed vertically, left content will be displayed on top. + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.panes + :parts: 2 + """ from efl.eo cimport _object_mapping_register diff --git a/efl/elementary/photo.pyx b/efl/elementary/photo.pyx index 458a548..12af484 100644 --- a/efl/elementary/photo.pyx +++ b/efl/elementary/photo.pyx @@ -17,10 +17,14 @@ """ +:mod:`photo` Module +################### + .. image:: /images/photo-preview.png + Widget description ------------------- +================== An Elementary photo widget is intended for displaying a photo, for ex., a person's image (contact). @@ -32,13 +36,22 @@ This widget relies on an internal :py:class:`~efl.elementary.icon.Icon`, so that the APIs of these two widgets are similar (drag and drop is also possible here, for example). -Signals that you can add callbacks for are: + +Emitted signals +=============== - ``clicked`` - This is called when a user has clicked the photo - ``drag,start`` - One has started dragging the inner image out of the photo's frame - ``drag,end`` - One has dropped the dragged image somewhere + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.photo + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/photocam.pyx b/efl/elementary/photocam.pyx index db749dc..3ae016c 100644 --- a/efl/elementary/photocam.pyx +++ b/efl/elementary/photocam.pyx @@ -18,8 +18,12 @@ """ +:mod:`photocam` Module +###################### + + Widget description ------------------- +================== This is a widget specifically for displaying high-resolution digital camera photos giving speedy feedback (fast load), low memory footprint @@ -27,7 +31,9 @@ and zooming and panning as well as fitting logic. It is entirely focused on jpeg images, and takes advantage of properties of the jpeg format (via evas loader features in the jpeg loader). -Signals that you can add callbacks for are: + +Emitted signals +=============== - ``clicked`` - This is called when a user has clicked the photo without dragging around. @@ -57,6 +63,7 @@ Signals that you can add callbacks for are: - ``focused`` - When the photocam has received focus. (since 1.8) - ``unfocused`` - When the photocam has lost focus. (since 1.8) + Scrollable Interface ==================== @@ -71,13 +78,14 @@ using multiple inheritance, for example:: def __init__(self, canvas, *args, **kwargs): Genlist.__init__(self, canvas) + Enumerations ------------- +============ .. _Elm_Photocam_Zoom_Mode: Photocam zoom modes -=================== +------------------- .. data:: ELM_PHOTOCAM_ZOOM_MODE_MANUAL @@ -95,6 +103,13 @@ Photocam zoom modes Zoom in until photo fits in photocam + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.photocam + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/plug.pyx b/efl/elementary/plug.pyx index d30f545..33ee94f 100644 --- a/efl/elementary/plug.pyx +++ b/efl/elementary/plug.pyx @@ -18,10 +18,19 @@ """ +:mod:`plug` Module +################## + + +Widget Description +================== + An object that allows one to show an image which other process created. It can be used anywhere like any other elementary widget. -This widget emits the following signals: + +Emitted signals +=============== - ``clicked`` - the user clicked the image (press/release). - ``image,deleted`` - the server side was deleted. @@ -29,7 +38,6 @@ This widget emits the following signals: of the callback will be ``Evas_Coord_Size`` (two integers). .. note:: - the event "image,resized" will be sent whenever the server resized its image and this **always** happen on the first time. Then it can be used to track when the server-side image @@ -37,6 +45,13 @@ This widget emits the following signals: image buffer through shared memory and resized the evas object). + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.plug + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/popup.pyx b/efl/elementary/popup.pyx index 4a15cf5..b097cbc 100644 --- a/efl/elementary/popup.pyx +++ b/efl/elementary/popup.pyx @@ -18,10 +18,14 @@ """ +:mod:`popup` Module +################### + .. image:: /images/popup-preview.png + Widget description ------------------- +================== This widget is an enhancement of :py:class:`~efl.elementary.notify.Notify`. In addition to Content area, there are two optional sections namely Title @@ -77,7 +81,9 @@ after use. To control the maximum height of the internal scroller for item, we use the height of the action area which is passed by theme based on the number of buttons currently set to popup. -Signals that you can add callbacks for are: + +Emitted signals +=============== - ``timeout`` - when ever popup is closed as a result of timeout. - ``block,clicked`` - when ever user taps on Blocked Event area. @@ -87,39 +93,33 @@ Signals that you can add callbacks for are: - ``item,focused`` - the popup item has received focus. (since 1.10) - ``item,unfocused`` - the popup item has lost focus. (since 1.10) -Styles available for Popup -- ``default`` - -Default contents parts of the popup items that you can use are: - -- ``default`` -Item's icon - -Default text parts of the popup items that you can use are: - -- ``default`` - Item's label - -Default contents parts of the popup widget that you can use for are: +Layout content parts +==================== - ``default`` - The content of the popup - ``title,icon`` - Title area's icon - ``button1`` - 1st button of the action area - ``button2`` - 2nd button of the action area - ``button3`` - 3rd button of the action area +- ``default`` - Item's icon -Default text parts of the popup widget that you can use for are: + +Layout text parts +================= - ``title,text`` - This operates on Title area's label - ``default`` - content-text set in the content area of the widget +- ``default`` - Item's label Enumerations ------------- +============ .. _Elm_Popup_Orient: Popup orientation types -======================= +----------------------- .. data:: ELM_POPUP_ORIENT_TOP @@ -161,7 +161,7 @@ Popup orientation types .. Elm_Wrap_Type: Wrap modes -========== +---------- .. data:: ELM_WRAP_NONE @@ -179,6 +179,13 @@ Wrap modes Word wrap, and if that fails, char wrap. + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.popup + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/progressbar.pyx b/efl/elementary/progressbar.pyx index ad7c3a1..0f14f9c 100644 --- a/efl/elementary/progressbar.pyx +++ b/efl/elementary/progressbar.pyx @@ -18,11 +18,14 @@ """ -Widget description ------------------- +:mod:`progressbar` Module +######################### .. image:: /images/progressbar-preview.png - :align: left + + +Widget description +================== The progress bar is a widget for visually representing the progress status of a given job/task. @@ -72,6 +75,13 @@ Default part names for the "recording" style: - ``elm.cur.progressbar`` - The "main" indicator bar - ``elm.cur.progressbar1`` - The "secondary" indicator bar + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.progressbar + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/radio.pyx b/efl/elementary/radio.pyx index aa056c9..504993e 100644 --- a/efl/elementary/radio.pyx +++ b/efl/elementary/radio.pyx @@ -17,11 +17,14 @@ """ -Widget description ------------------- +:mod:`radio` Module +################### .. image:: /images/radio-preview.png - :align: left + + +Widget description +================== Radio is a widget that allows for one or more options to be displayed and have the user choose only one of them. @@ -45,22 +48,34 @@ represented by the property :py:attr:`~Radio.value` on any group member. For convenience the radio objects are also able to directly set an integer(int) to the value that is selected. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``changed`` - This is called whenever the user changes the state of one of the radio objects within the group of radio objects that work together. - ``focused`` - When the radio has received focus. (since 1.8) - ``unfocused`` - When the radio has lost focus. (since 1.8) -Default text parts of the radio widget that you can use for are: + +Layout text parts +================= - ``default`` - Label of the radio -Default content parts of the radio widget that you can use for are: + +Layout content parts +==================== - ``icon`` - An icon of the radio + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.radio + :parts: 2 + """ from efl.eo cimport _object_mapping_register, object_from_instance diff --git a/efl/elementary/scroller.pyx b/efl/elementary/scroller.pyx index 5560bf3..b2cf152 100644 --- a/efl/elementary/scroller.pyx +++ b/efl/elementary/scroller.pyx @@ -18,10 +18,14 @@ """ +:mod:`scroller` Module +###################### + .. image:: /images/scroller-preview.png + Widget description ------------------- +================== A scroller holds a single object and "scrolls it around". @@ -34,8 +38,15 @@ of the scroller. This widget inherits from :py:class:`~efl.elementary.layout_class.LayoutClass`, so that all the functions acting on it also work for scroller objects. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: +.. note:: When Elementary is in embedded mode the scrollbars will not be + draggable, they appear merely as indicators of how much has been + scrolled. + +.. note:: When Elementary is in desktop mode the thumbscroll(a.k.a. + fingerscroll) won't work. + +Emitted signals +=============== - ``edge,left`` - the left edge of the content has been reached - ``edge,right`` - the right edge of the content has been reached @@ -60,28 +71,23 @@ This widget emits the following signals, besides the ones sent from - ``focused`` - When the scroller has received focus. (since 1.8) - ``unfocused`` - When the scroller has lost focus. (since 1.8) -Default content parts of the scroller widget that you can use for are: - -- ``default`` - A content of the scroller - .. note:: The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by user intervention. -.. note:: When Elementary is in embedded mode the scrollbars will not be - draggable, they appear merely as indicators of how much has been - scrolled. -.. note:: When Elementary is in desktop mode the thumbscroll(a.k.a. - fingerscroll) won't work. +Layout content parts +==================== + +- ``default`` - A content of the scroller Enumerations ------------- +============ .. _Elm_Scroller_Policy: Scrollbar visibility -==================== +-------------------- .. data:: ELM_SCROLLER_POLICY_AUTO @@ -99,7 +105,7 @@ Scrollbar visibility .. _Elm_Scroller_Single_Direction: Single direction -================ +---------------- Type that controls how the content is scrolled. @@ -119,7 +125,7 @@ Type that controls how the content is scrolled. .. _Elm_Scroller_Movement_Block: Movement block -============== +-------------- Type that blocks the scroll movement in one or more direction. @@ -138,6 +144,12 @@ Type that blocks the scroll movement in one or more direction. Block horizontal movements +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.scroller + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/segment_control.pyx b/efl/elementary/segment_control.pyx index 0d398f8..ec14639 100644 --- a/efl/elementary/segment_control.pyx +++ b/efl/elementary/segment_control.pyx @@ -17,10 +17,14 @@ """ +:mod:`segment_control` Module +############################# + .. image:: /images/segmentcontrol-preview.png + Widget description ------------------- +================== Segment control widget is a horizontal control made of multiple segment items, each segment item functioning similar to discrete two @@ -32,25 +36,33 @@ items added. Only one segment item can be at selected state. A segment item can display combination of Text and any Evas_Object like Images or other widget. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``changed`` - When the user clicks on a segment item which is not previously selected and get selected. The event_info parameter is the segment item. -Available styles for it: -- ``default`` - -Default content parts of the segment control items that you can use for are: +Layout content parts +==================== - ``icon`` - An icon in a segment control item -Default text parts of the segment control items that you can use for are: + +Layout text parts +================= - ``default`` - Title label in a segment control item + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.segment_control + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/separator.pyx b/efl/elementary/separator.pyx index 1de78b6..8bb452e 100644 --- a/efl/elementary/separator.pyx +++ b/efl/elementary/separator.pyx @@ -17,18 +17,25 @@ """ -Widget description ------------------- +:mod:`separator` Module +####################### .. image:: /images/separator-preview.png - :align: left + + +Widget description +================== Separator is a very thin object used to separate other objects. A separator can be vertical or horizontal. -This widget emits the signals coming from -:py:class:`~efl.elementary.layout_class.LayoutClass`. + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.separator + :parts: 2 """ diff --git a/efl/elementary/slider.pyx b/efl/elementary/slider.pyx index 25d0b4b..c3d06ea 100644 --- a/efl/elementary/slider.pyx +++ b/efl/elementary/slider.pyx @@ -17,10 +17,14 @@ """ +:mod:`slider` Module +#################### + .. image:: /images/slider-preview.png + Widget description ------------------- +================== The slider adds a draggable "slider" widget for selecting the value of something within a range. @@ -43,8 +47,9 @@ slider is its length (horizontally or vertically). This will be scaled by the object or applications scaling factor. At any point code can query the slider for its value with :py:attr:`Slider.value`. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``changed`` - Whenever the slider value is changed by the user. - ``slider,drag,start`` - dragging the slider indicator around has @@ -58,19 +63,26 @@ This widget emits the following signals, besides the ones sent from - ``focused`` - When the slider has received focus. (since 1.8) - ``unfocused`` - When the slider has lost focus. (since 1.8) -Available styles for it: -- ``default`` - -Default content parts of the slider widget that you can use for are: +Layout content parts +==================== - ``icon`` - An icon of the slider - ``end`` - A end part content of the slider -Default text parts of the slider widget that you can use for are: + +Layout text parts +================= - ``default`` - Label of the slider + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.slider + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/slideshow.pyx b/efl/elementary/slideshow.pyx index 95179f6..a698951 100644 --- a/efl/elementary/slideshow.pyx +++ b/efl/elementary/slideshow.pyx @@ -18,10 +18,14 @@ """ +:mod:`slideshow` Module +####################### + .. image:: /images/slideshow-preview.png + Widget description ------------------- +================== This widget, as the name indicates, is a pre-made image slideshow panel, with API functions acting on (child) image @@ -66,8 +70,9 @@ viewport. The user is able to set the numbers of items to be cached **before** and **after** the current item, in the widget's item list. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``changed`` - when the slideshow switches its view to a new item. event_info parameter in callback contains the current visible item @@ -76,6 +81,13 @@ This widget emits the following signals, besides the ones sent from - ``focused`` - When the slideshow has received focus. (since 1.8) - ``unfocused`` - When the slideshow has lost focus. (since 1.8) + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.slideshow + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String, Py_INCREF diff --git a/efl/elementary/spinner.pyx b/efl/elementary/spinner.pyx index 20b0e43..86a6877 100644 --- a/efl/elementary/spinner.pyx +++ b/efl/elementary/spinner.pyx @@ -17,11 +17,14 @@ """ -Widget description ------------------- +:mod:`spinner` Module +##################### .. image:: /images/spinner-preview.png - :align: left + + +Widget description +================== A spinner is a widget which allows the user to increase or decrease numeric values using arrow buttons, or edit values directly, clicking @@ -36,8 +39,9 @@ point values and thus accepts a printf-style format string, like It also allows specific values to be replaced by pre-defined labels. -This widget emits the following signals, besides the ones sent from -:py:class:`~efl.elementary.layout_class.LayoutClass`: + +Emitted signals +=============== - ``changed`` - Whenever the spinner value is changed. - ``delay,changed`` - A short time after the value is changed by @@ -48,11 +52,20 @@ This widget emits the following signals, besides the ones sent from - ``focused`` - When the spinner has received focus. (since 1.8) - ``unfocused`` - When the spinner has lost focus. (since 1.8) -Available styles for it: + +Available styles +================ - ``default``: Default style - ``vertical``: up/down buttons at the right side and text left aligned. + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.spinner + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/table.pyx b/efl/elementary/table.pyx index 60d1a01..064b793 100644 --- a/efl/elementary/table.pyx +++ b/efl/elementary/table.pyx @@ -17,11 +17,14 @@ """ -Widget description ------------------- +:mod:`table` Module +################### .. image:: /images/table-preview.png - :align: left + + +Widget description +================== A container widget to arrange other widgets in a table where items can span multiple columns or rows - even overlap (and then be raised or @@ -36,8 +39,15 @@ The most common way to use a table is:: table.show() table.padding = (space_between_columns, space_between_rows) table.pack(table_content_object, x_coord, y_coord, colspan, rowspan) - table.pack(table_content_object, next_x_coord, next_y_coord, colspan, rowspan) - table.pack(table_content_object, other_x_coord, other_y_coord, colspan, rowspan) + table.pack(table_content_object, x_coord, y_coord, colspan, rowspan) + table.pack(table_content_object, x_coord, y_coord, colspan, rowspan) + + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.table + :parts: 2 """ diff --git a/efl/elementary/theme.pyx b/efl/elementary/theme.pyx index 572b3ba..253531b 100644 --- a/efl/elementary/theme.pyx +++ b/efl/elementary/theme.pyx @@ -17,8 +17,12 @@ """ -Widget description ------------------- +:mod:`theme` Module +################### + + +Description +=========== Elementary uses Edje to theme its widgets, naturally. But for the most part this is hidden behind a simpler interface that lets the user set @@ -83,6 +87,13 @@ overlays. Don't use this unless you really know what you are doing. Remember to :py:func:`Theme.free` the instance when you're done with it! + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.theme + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/thumb.pyx b/efl/elementary/thumb.pyx index 467e3a4..450d2c5 100644 --- a/efl/elementary/thumb.pyx +++ b/efl/elementary/thumb.pyx @@ -17,10 +17,14 @@ """ +:mod:`thumb` Module +################### + .. image:: /images/thumb-preview.png + Widget description ------------------- +================== A thumbnail object is used for displaying the thumbnail of an image or video. You must have compiled Elementary with ``Ethumb_Client`` @@ -39,7 +43,9 @@ Generated thumbnails are stored under ``$HOME/.thumbnails/``. Check Ethumb's documentation to change this path, and to see other configuration options. -This widget emits the following signals: + +Emitted signals +=============== - ``clicked`` - This is called when a user has clicked the thumbnail object without dragging it around. @@ -52,19 +58,21 @@ This widget emits the following signals: - ``generate,error`` - The thumbnail generation failed. - ``load,error`` - The thumbnail image loading failed. -Available styles: + +Available styles +================ - ``default`` - ``noframe`` Enumerations ------------- +============ .. _Elm_Thumb_Animation_Setting: Thumb animation mode -==================== +-------------------- .. data:: ELM_THUMB_ANIMATION_START @@ -82,7 +90,7 @@ Thumb animation mode .. _Ethumb_Thumb_FDO_Size: Thumb FDO size -============== +-------------- .. data:: ETHUMB_THUMB_NORMAL @@ -96,7 +104,7 @@ Thumb FDO size .. _Ethumb_Thumb_Format: Thumb format -============ +------------ .. data:: ETHUMB_THUMB_FDO @@ -114,7 +122,7 @@ Thumb format .. _Ethumb_Thumb_Aspect: Thumb aspect -============ +------------ .. data:: ETHUMB_THUMB_KEEP_ASPECT @@ -132,7 +140,7 @@ Thumb aspect .. _Ethumb_Thumb_Orientation: Thumb orientation -================= +----------------- .. data:: ETHUMB_THUMB_ORIENT_NONE @@ -171,6 +179,12 @@ Thumb orientation use orientation from metadata (EXIF-only currently) +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.thumb + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/toolbar.pyx b/efl/elementary/toolbar.pyx index 22006a7..5f9e139 100644 --- a/efl/elementary/toolbar.pyx +++ b/efl/elementary/toolbar.pyx @@ -18,10 +18,14 @@ """ +:mod:`toolbar` Module +##################### + .. image:: /images/toolbar-preview.png + Widget description ------------------- +================== A toolbar is a widget that displays a list of items inside a box. It can be scrollable, show a menu with items that don't fit to toolbar size @@ -31,7 +35,9 @@ Only one item can be selected at a time. Items can have multiple states, or show menus when selected by the user. -Smart callbacks one can listen to: + +Emitted signals +=============== - ``clicked`` - when the user clicks on a toolbar item and becomes selected. - ``longpressed`` - when the toolbar is pressed for a certain amount of time. @@ -41,15 +47,20 @@ Smart callbacks one can listen to: - ``item,focused`` - When the toolbar item has received focus. (since 1.10) - ``item,unfocused`` - When the toolbar item has lost focus. (since 1.10) -Available styles for it: + +Available styles +================ - ``default`` - ``transparent`` - no background or shadow, just show the content -Default text parts of the toolbar items that you can use for are: + +Layout text parts +================= - ``default`` - label of the toolbar item + Scrollable Interface ==================== @@ -64,13 +75,14 @@ using multiple inheritance, for example:: def __init__(self, canvas, *args, **kwargs): Genlist.__init__(self, canvas) + Enumerations ------------- +============ .. _Elm_Toolbar_Icon_Lookup_Order: Icon lookup modes -================= +----------------- .. data:: ELM_ICON_LOOKUP_FDO_THEME @@ -92,7 +104,7 @@ Icon lookup modes .. _Elm_Toolbar_Object_Select_Mode: Selection modes -=============== +--------------- .. data:: ELM_OBJECT_SELECT_MODE_DEFAULT @@ -114,7 +126,7 @@ Selection modes .. _Elm_Toolbar_Shrink_Mode: Toolbar shrink modes -==================== +-------------------- .. data:: ELM_TOOLBAR_SHRINK_NONE @@ -140,7 +152,7 @@ Toolbar shrink modes .. _Elm_Toolbar_Item_Scrollto_Type: Toolbar item scrollto types -=========================== +--------------------------- Where to position the item in the toolbar. @@ -164,6 +176,13 @@ Where to position the item in the toolbar. To the last of viewport + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.toolbar + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String, Py_INCREF, Py_DECREF diff --git a/efl/elementary/transit.pyx b/efl/elementary/transit.pyx index 7a59fb7..afe4a2b 100644 --- a/efl/elementary/transit.pyx +++ b/efl/elementary/transit.pyx @@ -18,10 +18,13 @@ """ -Widget description ------------------- +:mod:`transit` Module +##################### +Widget description +================== + Transit is designed to apply various animated transition effects to ``Evas_Object``, such like translation, rotation, etc. For using these effects, create a :py:class:`Transit` and add the desired transition effects. @@ -70,12 +73,12 @@ It's also possible to make a transition chain with Enumerations ------------- +============ .. _Elm_Transit_Effect_Flip_Axis: Flip effects -============ +------------ .. data:: ELM_TRANSIT_EFFECT_FLIP_AXIS_X @@ -89,7 +92,7 @@ Flip effects .. _Elm_Transit_Effect_Wipe_Dir: Wipe effects -============ +------------ .. data:: ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT @@ -111,7 +114,7 @@ Wipe effects .. _Elm_Transit_Effect_Wipe_Type: Wipe types -========== +---------- .. data:: ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE @@ -125,7 +128,7 @@ Wipe types .. _Elm_Transit_Tween_Mode: Tween modes -=========== +----------- .. data:: ELM_TRANSIT_TWEEN_MODE_LINEAR @@ -170,6 +173,13 @@ Tween modes .. versionadded:: 1.13 + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.transit + :parts: 2 + """ from libc.stdlib cimport free diff --git a/efl/elementary/video.pyx b/efl/elementary/video.pyx index 642a291..07a9760 100644 --- a/efl/elementary/video.pyx +++ b/efl/elementary/video.pyx @@ -17,10 +17,13 @@ """ -Widget description ------------------- +:mod:`video` Module +################### +Widget description +================== + Display a video by using Emotion. It embeds the video inside an Edje object, so you can do some @@ -33,6 +36,13 @@ These widgets emit the following signals, besides the ones sent from - ``focused`` - When the widget has received focus. (since 1.8) - ``unfocused`` - When the widget has lost focus. (since 1.8) + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.video + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/web.pyx b/efl/elementary/web.pyx index d97b5f6..b46bf1e 100644 --- a/efl/elementary/web.pyx +++ b/efl/elementary/web.pyx @@ -18,11 +18,20 @@ """ +:mod:`web` Module +################# + + +Widget description +================== + A web widget is used for displaying web pages (HTML/CSS/JS) using WebKit-EFL. You must have compiled Elementary with ewebkit support. -Signals that you can add callbacks for are: + +Emitted signals +=============== - ``download,request``: A file download has been requested. Event info is a WebDownload instance @@ -88,18 +97,14 @@ Signals that you can add callbacks for are: - ``focused`` : When the web has received focus. (since 1.8) - ``unfocused`` : When the web has lost focus. (since 1.8) -available styles: - -- ``default`` - Enumerations ------------- +============ .. _Elm_Web_Window_Feature: Web window features -=================== +------------------- .. data:: ELM_WEB_WINDOW_FEATURE_TOOLBAR @@ -129,7 +134,7 @@ Web window features .. _Elm_Web_Zoom_Mode: Web zoom modes -============== +-------------- .. data:: ELM_WEB_ZOOM_MODE_MANUAL @@ -143,6 +148,13 @@ Web zoom modes Zoom until content fills web object. + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.web + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String diff --git a/efl/elementary/window.pyx b/efl/elementary/window.pyx index 50ed1e1..27698b9 100644 --- a/efl/elementary/window.pyx +++ b/efl/elementary/window.pyx @@ -18,8 +18,12 @@ """ +:mod:`window` Module +#################### + + Widget description ------------------- +================== The window class of Elementary. @@ -77,7 +81,9 @@ fixed to "out001.png" Some examples of using the shot engine:: ELM_ENGINE="shot:delay=2.0" elementary_test ELM_ENGINE="shot:" elementary_test -Signals that you can add callbacks for are: + +Emitted signals +=============== - ``delete,request``: the user requested to close the window. See :py:attr:`~Window.autodel`. @@ -103,12 +109,12 @@ Signals that you can add callbacks for are: Enumerations ------------- +============ .. _Elm_Win_Type: Window types -============ +------------ .. data:: ELM_WIN_UNKNOWN @@ -214,7 +220,7 @@ Window types .. _Elm_Win_Indicator_Mode: Indicator states -================ +---------------- .. data:: ELM_WIN_INDICATOR_UNKNOWN @@ -232,7 +238,7 @@ Indicator states .. _Elm_Win_Indicator_Opacity_Mode: Indicator opacity -================= +----------------- .. data:: ELM_WIN_INDICATOR_OPACITY_UNKNOWN @@ -254,7 +260,7 @@ Indicator opacity .. _Elm_Win_Keyboard_Mode: Keyboard virtual keyboard modes -=============================== +------------------------------- .. data:: ELM_WIN_KEYBOARD_UNKNOWN @@ -324,7 +330,7 @@ Keyboard virtual keyboard modes .. _Elm_Illume_Command: Illume commands -=============== +--------------- Available commands that can be sent to the Illume manager. @@ -348,6 +354,12 @@ Illume manager to perform different actions. Closes the currently active window +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.elementary.window + :parts: 2 + """ from cpython cimport PyUnicode_AsUTF8String @@ -364,6 +376,7 @@ from efl.utils.conversions cimport python_list_strings_to_array_of_strings, \ array_of_ints_to_python_list + cdef class Window(Object): """ diff --git a/efl/emotion/efl.emotion.pyx b/efl/emotion/efl.emotion.pyx index ba3f1c5..d319b00 100644 --- a/efl/emotion/efl.emotion.pyx +++ b/efl/emotion/efl.emotion.pyx @@ -15,6 +15,98 @@ # You should have received a copy of the GNU Lesser General Public License # along with this Python-EFL. If not, see . +""" + +:mod:`emotion` Module +##################### + + +What is Emotion? +================ + +Emotion is a media object library for Evas and Ecore. + +Emotion is a library that allows playing audio and video files, using one of +its backends (gstreamer, xine, vlc or generic shm player). + +It is integrated into Ecore through its mainloop, and is transparent to the +user of the library how the decoding of audio and video is being done. Once +the objects are created, the user can set callbacks to the specific events +and set options to this object, all in the main loop (no threads are needed). + +Emotion is also integrated with Evas. The emotion object returned by +emotion_object_add() is an Evas smart object, so it can be manipulated with +default Evas object functions. Callbacks can be added to the signals emitted +by this object with evas_object_smart_callback_add(). + +The Emotion library uses Evas smart objects to allow you to manipulate the +created object as any other Evas object, and to connect to its signals, +handling them when needed. It's also possible to swallow Emotion objects +inside Edje themes, and expect it to behave as a normal image or rectangle +when regarding to its dimensions. + + +How to use the Emotion object +============================= + +Emotion provides an Evas smart object that allows to play, control and +display a video or audio file. The API is synchronous but not everything +happens immediately. There are also some signals to report changed states. + +Basically, once the object is created and initialized, a file will be set to +it, and then it can be resized, moved, and controlled by other Evas object +functions. + +However, the decoding of the music and video occurs not in the Ecore main +loop, but usually in another thread (this depends on the module being used). +The synchronization between this other thread and the main loop not visible +to the end user of the library. The user can just register callbacks to the +available signals to receive information about the changed states, and can +call other functions from the API to request more changes on the current +loaded file. + +There will be a delay between an API being called and it being really +executed, since this request will be done in the main thread, and it needs to +be sent to the decoding thread. For this reason, always call functions like +emotion_object_size_get() or emotion_object_length_get() after some signal +being sent, like "playback_started" or "open_done". + + +Emitted signals +=============== + +The :py:class:`Emotion` object has a number of signals that can be listened +to using evas' smart callbacks mechanism. The following is a list of +interesting signals: + +- ``playback_started`` Emitted when the playback starts +- ``playback_finished`` Emitted when the playback finishes +- ``frame_decode`` Emitted every time a frame is decoded +- ``frame_resize`` Emitted when the frame change its size +- ``open_done`` Emitted when the media file is opened +- ``position_update`` Emitted when emotion_object_position_set is called +- ``audio_level_change`` Emitted when the volume change it's value +- ``decode_stop`` Emitted after the last frame is decoded +- ``length_change`` Emitted if the media change it's size +- ``channels_change`` Emitted when the number of channels change +- ``title_change`` Emitted when the title change (?) +- ``progress_change`` +- ``ref_change`` +- ``button_num_change`` +- ``button_change`` +- ``position_save,succeed`` +- ``position_save,failed`` +- ``position_load,succeed`` +- ``position_load,failed`` + + +Inheritance diagram +=================== + +.. inheritance-diagram:: efl.emotion + :parts: 2 + +""" from cpython cimport PyUnicode_AsUTF8String from libc.stdint cimport uintptr_t @@ -117,7 +209,7 @@ cdef class Emotion(evasObject): :keyword module_params: Extra parameters, module specific :keyword \**kwargs: All the remaining keyword arguments are interpreted as properties of the instance - + """ self._set_obj(emotion_object_add(canvas.obj))