Python-EFL: trivial docs change, be consistent with header types, no code changes

2013-05-01 14:34:45 +02:00 · 2013-05-01 14:34:45 +02:00 · 01663ecd99
parent f4fe41073f
commit 01663ecd99
64 changed files with 234 additions and 59 deletions
--- a/doc/index.rst
+++ b/doc/index.rst
@ -34,6 +34,7 @@ Elementary
 ----------

 .. toctree:: elementary/elementary
+   :maxdepth: 3


 Acknowledgements
--- a/efl/elementary/actionslider.pyx
+++ b/efl/elementary/actionslider.pyx
@ -19,7 +19,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -57,6 +58,8 @@ Default text parts of the actionslider widget that you can use for are:
 - **center** - A center label of the actionslider


+Enumerations
+------------

 .. _Elm_Actionslider_Pos:

--- a/efl/elementary/background.pyx
+++ b/efl/elementary/background.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -37,6 +38,9 @@ Default content parts of the bg widget that you can use for are:
 - **overlay** - overlay of the bg


+Enumerations
+------------
+
 .. _Elm_Bg_Option:

 .. rubric:: Background display modes
--- a/efl/elementary/box.pyx
+++ b/efl/elementary/box.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -78,6 +79,9 @@ children of the box.
 .. note:: Objects should not be added to box objects using _add() calls.


+Enumerations
+------------
+
 .. rubric:: Box layout modes

 .. data:: ELM_BOX_LAYOUT_HORIZONTAL
--- a/efl/elementary/bubble.pyx
+++ b/efl/elementary/bubble.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -61,6 +62,8 @@ Default text parts of the button widget that you can use for are:
 - **info** - info of the bubble


+Enumerations
+------------

 .. rubric:: Bubble arrow positions

--- a/efl/elementary/button.pyx
+++ b/efl/elementary/button.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/calendar_elm.pyx
+++ b/efl/elementary/calendar_elm.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -41,6 +42,9 @@ This widget emits the following signals, besides the ones sent from
 - ``changed`` - emitted when the date in the calendar is changed.


+Enumerations
+------------
+
 .. _Elm_Calendar_Mark_Repeat_Type:

 .. rubric:: Calendar mark repeat types
--- a/efl/elementary/check.pyx
+++ b/efl/elementary/check.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/clock.pyx
+++ b/efl/elementary/clock.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -54,6 +55,9 @@ This widget emits the following signals, besides the ones sent from
 - ``changed`` - the clock's user changed the time


+Enumerations
+------------
+
 .. rubric:: Clock edit modes

 .. data:: ELM_CLOCK_EDIT_DEFAULT
--- a/efl/elementary/colorselector.pyx
+++ b/efl/elementary/colorselector.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -43,6 +44,9 @@ This widget emits the following signals, besides the ones sent from
    color item.


+Enumerations
+------------
+
 .. rubric:: Colorselector modes

 .. data:: ELM_COLORSELECTOR_PALETTE
--- a/efl/elementary/configuration.pyx
+++ b/efl/elementary/configuration.pyx
@ -18,6 +18,9 @@

 """

+Enumerations
+------------
+
 .. _Elm_Softcursor_Mode:

 .. rubric:: Elm_Softcursor_Mode
--- a/efl/elementary/conformant.pyx
+++ b/efl/elementary/conformant.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/ctxpopup.pyx
+++ b/efl/elementary/ctxpopup.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -51,6 +52,9 @@ Default text parts of the ctxpopup items that you can use for are:
 .. note:: Ctxpopup is a specialization of :py:class:`elementary.hover.Hover`.


+Enumerations
+------------
+
 .. rubric:: Ctxpopup arrow directions

 .. data:: ELM_CTXPOPUP_DIRECTION_DOWN
--- a/efl/elementary/datetime_elm.pyx
+++ b/efl/elementary/datetime_elm.pyx
@ -18,8 +18,8 @@

 """

-.. rubric:: Widget description
-
+Widget description
+------------------

 Datetime widget is used to display and input date & time values.

@ -212,6 +212,9 @@ This widget emits the following signals, besides the ones sent from
    signal is sent.


+Enumerations
+------------
+
 .. rubric:: Datetime fields

 .. data:: ELM_DATETIME_YEAR
--- a/efl/elementary/dayselector.pyx
+++ b/efl/elementary/dayselector.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -69,6 +70,9 @@ Available styles for dayselector are:
 - default


+Enumerations
+------------
+
 .. _Elm_Dayselector_Day:

 .. rubric:: Dayselector days
--- a/efl/elementary/diskselector.pyx
+++ b/efl/elementary/diskselector.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/entry.pyx
+++ b/efl/elementary/entry.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -238,6 +239,9 @@ Default text parts of the entry that you can use for are:
 - "default" - text of the entry


+Enumerations
+------------
+
 .. _Elm_Autocapital_Type:

 .. rubric:: Autocapitalization types
--- a/efl/elementary/fileselector.pyx
+++ b/efl/elementary/fileselector.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -59,6 +60,9 @@ This widget emits the following signals, besides the ones sent from
  buttons (*event_info* is the selection's path)


+Enumerations
+------------
+
 .. rubric:: Fileselector modes

 .. data:: ELM_FILESELECTOR_LIST
--- a/efl/elementary/fileselector_button.pyx
+++ b/efl/elementary/fileselector_button.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -58,6 +59,9 @@ for are:
 - "icon" - Icon of the fileselector_button


+Enumerations
+------------
+
 .. rubric:: Fileselector modes

 .. data:: ELM_FILESELECTOR_LIST
--- a/efl/elementary/fileselector_entry.pyx
+++ b/efl/elementary/fileselector_entry.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

 .. image:: /images/fileselector-entry-preview.png

@ -72,6 +73,9 @@ are:
 - "button icon" - Button icon of the fileselector_entry


+Enumerations
+------------
+
 .. rubric:: Fileselector modes

 .. data:: ELM_FILESELECTOR_LIST
--- a/efl/elementary/flipselector.pyx
+++ b/efl/elementary/flipselector.pyx
@ -17,7 +17,9 @@
 #

 """
-.. rubric:: Widget description
+
+Widget description
+------------------

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

--- a/efl/elementary/frame.pyx
+++ b/efl/elementary/frame.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/general.pyx
+++ b/efl/elementary/general.pyx
@ -18,6 +18,9 @@

 """

+Enumerations
+------------
+
 .. _Elm_Policy:

 .. rubric:: Policy types
--- a/efl/elementary/gengrid.pyx
+++ b/efl/elementary/gengrid.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -213,6 +214,9 @@ Smart events that you can add callbacks for are:
  until the right edge.


+Enumerations
+------------
+
 .. rubric:: Items' scroll to types

 .. data:: ELM_GENLIST_ITEM_SCROLLTO_NONE
--- a/efl/elementary/genlist.pyx
+++ b/efl/elementary/genlist.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -342,6 +343,9 @@ Signals that you can add callbacks for are:
  is finished.


+Enumerations
+------------
+
 .. rubric:: Genlist item types

 .. data:: ELM_GENLIST_ITEM_NONE
--- a/efl/elementary/gesture_layer.pyx
+++ b/efl/elementary/gesture_layer.pyx
@ -17,7 +17,9 @@
 #

 """
-.. rubric:: Widget description
+
+Widget description
+------------------

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

@ -84,6 +86,9 @@ behavior so gesture starts when user touches (a *DOWN* event)
 touch-surface and ends when no fingers touches surface (a *UP* event).


+Enumerations
+------------
+
 .. _Elm_Gesture_State:

 .. rubric:: Gesture states
--- a/efl/elementary/grid.pyx
+++ b/efl/elementary/grid.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/hover.pyx
+++ b/efl/elementary/hover.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -81,6 +82,9 @@ deleted, and vice-versa.
    will be displayed


+Enumerations
+------------
+
 .. data:: ELM_HOVER_AXIS_NONE

    No preferred orientation
--- a/efl/elementary/hoversel.pyx
+++ b/efl/elementary/hoversel.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -49,6 +50,9 @@ Default text parts of the hoversel widget that you can use for are:
 - "default" - Label of the hoversel


+Enumerations
+------------
+
 .. _Elm_Icon_Type:

 .. rubric:: Icon types
--- a/efl/elementary/icon.pyx
+++ b/efl/elementary/icon.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -97,6 +98,9 @@ This widget emits the following signals, besides the ones sent from
 - ``"thumb,error"`` - Setting :py:attr:`thumb` has failed


+Enumerations
+------------
+
 .. rubric:: Icon lookup modes

 .. data:: ELM_ICON_LOOKUP_FDO_THEME
--- a/efl/elementary/index.pyx
+++ b/efl/elementary/index.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/innerwindow.pyx
+++ b/efl/elementary/innerwindow.pyx
@ -16,7 +16,9 @@
 # along with this Python-EFL.  If not, see <http://www.gnu.org/licenses/>.

 """
-.. rubric:: Widget description
+
+Widget description
+------------------

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

--- a/efl/elementary/label.pyx
+++ b/efl/elementary/label.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -50,6 +51,9 @@ This widget emits the following signals, besides the ones sent from
 - *"language,changed"*: The program's language changed.


+Enumerations
+------------
+
 .. _Elm_Wrap_Type:

 .. rubric:: Wrap modes
--- a/efl/elementary/layout.pyx
+++ b/efl/elementary/layout.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/list.pyx
+++ b/efl/elementary/list.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -61,6 +62,9 @@ Default text parts of the list items that you can use for are:
 - "default" - label in the list item


+Enumerations
+------------
+
 .. _Elm_List_Mode:

 .. rubric:: List sizing modes
--- a/efl/elementary/map.pyx
+++ b/efl/elementary/map.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

 .. image:: /images/map-preview.png
    :width: 100%
@ -68,6 +69,9 @@ It supports some basic but yet nice features:
 - "language,changed" - the program's language changed


+Enumerations
+------------
+
 .. rubric:: Map overlay types

 .. data:: ELM_MAP_OVERLAY_TYPE_NONE
--- a/efl/elementary/mapbuf.pyx
+++ b/efl/elementary/mapbuf.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/menu.pyx
+++ b/efl/elementary/menu.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/multibuttonentry.pyx
+++ b/efl/elementary/multibuttonentry.pyx
@ -16,7 +16,9 @@
 # along with this Python-EFL.  If not, see <http://www.gnu.org/licenses/>.

 """
-.. rubric:: Widget description
+
+Widget description
+------------------

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

--- a/efl/elementary/naviframe.pyx
+++ b/efl/elementary/naviframe.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/notify.pyx
+++ b/efl/elementary/notify.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -38,6 +39,9 @@ Default content parts of the notify widget that you can use are:
 - ``"default"`` - The main content of the notify


+Enumerations
+------------
+
 .. _Elm_Notify_Orient:

 .. rubric:: Notify orientation types
--- a/efl/elementary/object.pyx
+++ b/efl/elementary/object.pyx
@ -55,6 +55,10 @@ More information is on
 - X11R6 Inter-Client Communication Conventions Manual, section 2


+
+Enumerations
+------------
+
 .. _Elm_Focus_Direction:

 .. rubric:: Focus direction
--- a/efl/elementary/panel.pyx
+++ b/efl/elementary/panel.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -38,6 +39,9 @@ Default content parts of the panel widget that you can use for are:
 - "default" - A content of the panel


+Enumerations
+------------
+
 .. rubric:: Panel orientation types

 .. data:: ELM_PANEL_ORIENT_TOP
--- a/efl/elementary/panes.pyx
+++ b/efl/elementary/panes.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/photo.pyx
+++ b/efl/elementary/photo.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/photocam.pyx
+++ b/efl/elementary/photocam.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------


 This is a widget specifically for displaying high-resolution digital
@ -52,6 +53,9 @@ Signals that you can add callbacks for are:
 - "scroll,drag,stop" - dragging the contents around has stopped


+Enumerations
+------------
+
 .. rubric:: Photocam zoom modes

 .. data:: ELM_PHOTOCAM_ZOOM_MODE_MANUAL
--- a/efl/elementary/popup.pyx
+++ b/efl/elementary/popup.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -100,6 +101,9 @@ Default text parts of the popup widget that you can use for are:
 - "default" - content-text set in the content area of the widget


+Enumerations
+------------
+
 .. rubric:: Popup orientation types

 .. data:: ELM_POPUP_ORIENT_TOP
--- a/efl/elementary/progressbar.pyx
+++ b/efl/elementary/progressbar.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/radio.pyx
+++ b/efl/elementary/radio.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/scroller.pyx
+++ b/efl/elementary/scroller.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -71,6 +72,10 @@ Default content parts of the scroller widget that you can use for are:
 .. note:: When Elementary is in desktop mode the thumbscroll(a.k.a.
    fingerscroll) won't work.

+
+Enumerations
+------------
+
 .. rubric:: Scrollbar visibility

 .. data:: ELM_SCROLLER_POLICY_AUTO
--- a/efl/elementary/segment_control.pyx
+++ b/efl/elementary/segment_control.pyx
@ -16,7 +16,9 @@
 # along with this Python-EFL.  If not, see <http://www.gnu.org/licenses/>.

 """
-.. rubric:: Widget description
+
+Widget description
+------------------

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

--- a/efl/elementary/separator.pyx
+++ b/efl/elementary/separator.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/slider.pyx
+++ b/efl/elementary/slider.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/slideshow.pyx
+++ b/efl/elementary/slideshow.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/spinner.pyx
+++ b/efl/elementary/spinner.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/store.pyx
+++ b/efl/elementary/store.pyx
@ -70,6 +70,9 @@ is called in the mainloop and is expected to take minimal or almost no time
 to simply free up memory resources.


+Enumerations
+------------
+
 .. _Elm_Store_Item_Mapping_Type:

 .. rubric:: Store item mapping types
--- a/efl/elementary/table.pyx
+++ b/efl/elementary/table.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

--- a/efl/elementary/theme.pyx
+++ b/efl/elementary/theme.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget 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
--- a/efl/elementary/thumb.pyx
+++ b/efl/elementary/thumb.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -59,6 +60,9 @@ Available styles:
 - ``"noframe"``


+Enumerations
+------------
+
 .. rubric:: Thumb animation modes

 .. data:: ELM_THUMB_ANIMATION_START
--- a/efl/elementary/toolbar.pyx
+++ b/efl/elementary/toolbar.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------

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

@ -47,6 +48,9 @@ Default text parts of the toolbar items that you can use for are:
 - "default" - label of the toolbar item


+Enumerations
+------------
+
 .. _Elm_Icon_Lookup_Order:

 .. rubric:: Icon lookup modes
--- a/efl/elementary/transit.pyx
+++ b/efl/elementary/transit.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------


 Transit is designed to apply various animated transition effects to
@ -65,6 +66,9 @@ It's also possible to make a transition chain with :py:func:`chain_transit_add`.
    manipulated inside the theme.


+Enumerations
+------------
+
 .. _Elm_Transit_Effect_Flip_Axis:

 .. rubric:: Flip effects
--- a/efl/elementary/video.pyx
+++ b/efl/elementary/video.pyx
@ -17,7 +17,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------


 Display a video by using Emotion.
--- a/efl/elementary/web.pyx
+++ b/efl/elementary/web.pyx
@ -18,6 +18,9 @@

 """

+Enumerations
+------------
+
 .. rubric:: Web window features

 .. data:: ELM_WEB_WINDOW_FEATURE_TOOLBAR
--- a/efl/elementary/window.pyx
+++ b/efl/elementary/window.pyx
@ -18,7 +18,8 @@

 """

-.. rubric:: Widget description
+Widget description
+------------------


 The window class of Elementary.
@ -104,6 +105,10 @@ Signals that you can add callbacks for are:
 - "rotation,changed": window rotation has been changed
 - "profile,changed": profile of the window has been changed

+
+Enumerations
+------------
+
 .. _Elm_Win_Type:

 .. rubric:: Window types