diff --git a/doc/elementary/actionslider.rst b/doc/elementary/actionslider.rst index 4619a9e..d701f8a 100644 --- a/doc/elementary/actionslider.rst +++ b/doc/elementary/actionslider.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Actionslider ############ @@ -76,8 +78,8 @@ Actionslider positions Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Actionslider +.. inheritance-diagram:: Actionslider :parts: 2 -.. autoclass:: efl.elementary.Actionslider +.. autoclass:: Actionslider diff --git a/doc/elementary/background.rst b/doc/elementary/background.rst index a6b1803..e02534a 100644 --- a/doc/elementary/background.rst +++ b/doc/elementary/background.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Background ########## @@ -49,8 +51,8 @@ Background display modes Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Background +.. inheritance-diagram:: Background :parts: 2 -.. autoclass:: efl.elementary.Background +.. autoclass:: Background diff --git a/doc/elementary/box.rst b/doc/elementary/box.rst index dd58ad3..a02358e 100644 --- a/doc/elementary/box.rst +++ b/doc/elementary/box.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Box ### @@ -110,7 +112,7 @@ Box layout modes Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Box +.. inheritance-diagram:: Box :parts: 2 -.. autoclass:: efl.elementary.Box +.. autoclass:: Box diff --git a/doc/elementary/bubble.rst b/doc/elementary/bubble.rst index baaf69d..d66826a 100644 --- a/doc/elementary/bubble.rst +++ b/doc/elementary/bubble.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Bubble ###### @@ -80,7 +82,7 @@ Bubble arrow positions Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Bubble +.. inheritance-diagram:: Bubble :parts: 2 -.. autoclass:: efl.elementary.Bubble +.. autoclass:: Bubble diff --git a/doc/elementary/button.rst b/doc/elementary/button.rst index 680266f..becdc6b 100644 --- a/doc/elementary/button.rst +++ b/doc/elementary/button.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Button ###### @@ -55,9 +57,9 @@ Emitted signals Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Button +.. inheritance-diagram:: Button :parts: 2 -.. autoclass:: efl.elementary.Button +.. autoclass:: Button diff --git a/doc/elementary/calendar.rst b/doc/elementary/calendar.rst index 10026b7..5278f3d 100644 --- a/doc/elementary/calendar.rst +++ b/doc/elementary/calendar.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Calendar ######## @@ -153,8 +155,11 @@ Days Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Calendar +.. inheritance-diagram:: + Calendar + CalendarMark :parts: 2 -.. autoclass:: efl.elementary.Calendar +.. autoclass:: Calendar +.. autoclass:: CalendarMark diff --git a/doc/elementary/check.rst b/doc/elementary/check.rst index 5b37007..62a714a 100644 --- a/doc/elementary/check.rst +++ b/doc/elementary/check.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Check ##### @@ -40,8 +42,8 @@ Layout text parts Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Check +.. inheritance-diagram:: Check :parts: 2 -.. autoclass:: efl.elementary.Check +.. autoclass:: Check diff --git a/doc/elementary/clock.rst b/doc/elementary/clock.rst index 010fa61..d0a896a 100644 --- a/doc/elementary/clock.rst +++ b/doc/elementary/clock.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Clock ##### @@ -85,8 +87,8 @@ Clock edit modes Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Clock +.. inheritance-diagram:: Clock :parts: 2 -.. autoclass:: efl.elementary.Clock +.. autoclass:: Clock diff --git a/doc/elementary/colorselector.rst b/doc/elementary/colorselector.rst index b9f1f12..b79c393 100644 --- a/doc/elementary/colorselector.rst +++ b/doc/elementary/colorselector.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Colorselector ############# @@ -54,9 +56,11 @@ Colorselector modes Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Colorselector +.. inheritance-diagram:: + Colorselector + ColorselectorPaletteItem :parts: 2 -.. autoclass:: efl.elementary.Colorselector -.. autoclass:: efl.elementary.ColorselectorPaletteItem +.. autoclass:: Colorselector +.. autoclass:: ColorselectorPaletteItem diff --git a/doc/elementary/configuration.rst b/doc/elementary/configuration.rst index d5fa4b7..8dbd278 100644 --- a/doc/elementary/configuration.rst +++ b/doc/elementary/configuration.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Configuration ############# @@ -154,8 +156,7 @@ Audio Channels Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Configuration +.. inheritance-diagram:: Configuration :parts: 2 - -.. autoclass:: efl.elementary.Configuration +.. autoclass:: Configuration diff --git a/doc/elementary/conformant.rst b/doc/elementary/conformant.rst index a428e8c..19af68c 100644 --- a/doc/elementary/conformant.rst +++ b/doc/elementary/conformant.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Conformant ########## @@ -34,8 +36,8 @@ Layout content parts Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Conformant +.. inheritance-diagram:: Conformant :parts: 2 -.. autoclass:: efl.elementary.Conformant +.. autoclass:: Conformant diff --git a/doc/elementary/ctxpopup.rst b/doc/elementary/ctxpopup.rst index bfad5bc..a9dc880 100644 --- a/doc/elementary/ctxpopup.rst +++ b/doc/elementary/ctxpopup.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Ctxpopup ######## @@ -74,9 +76,11 @@ Ctxpopup arrow directions Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Ctxpopup +.. inheritance-diagram:: + Ctxpopup + CtxpopupItem :parts: 2 -.. autoclass:: efl.elementary.Ctxpopup -.. autoclass:: efl.elementary.CtxpopupItem +.. autoclass:: Ctxpopup +.. autoclass:: CtxpopupItem diff --git a/doc/elementary/datetime.rst b/doc/elementary/datetime.rst index 145d704..c271396 100644 --- a/doc/elementary/datetime.rst +++ b/doc/elementary/datetime.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Datetime ######## @@ -211,8 +213,7 @@ Datetime fields Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Datetime +.. inheritance-diagram:: Datetime :parts: 2 - -.. autoclass:: efl.elementary.Datetime +.. autoclass:: Datetime diff --git a/doc/elementary/dayselector.rst b/doc/elementary/dayselector.rst index 4a2d523..7eb0ac8 100644 --- a/doc/elementary/dayselector.rst +++ b/doc/elementary/dayselector.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Dayselector ########### @@ -91,7 +93,7 @@ Dayselector days Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Dayselector +.. inheritance-diagram:: Dayselector :parts: 2 -.. autoclass:: efl.elementary.Dayselector +.. autoclass:: Dayselector diff --git a/doc/elementary/diskselector.rst b/doc/elementary/diskselector.rst index 2b4581d..76ec557 100644 --- a/doc/elementary/diskselector.rst +++ b/doc/elementary/diskselector.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Diskselector ############ @@ -60,9 +62,11 @@ using multiple inheritance, for example:: Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Diskselector +.. inheritance-diagram:: + Diskselector + DiskselectorItem :parts: 2 -.. autoclass:: efl.elementary.Diskselector -.. autoclass:: efl.elementary.DiskselectorItem +.. autoclass:: Diskselector +.. autoclass:: DiskselectorItem diff --git a/doc/elementary/elementary.rst b/doc/elementary/elementary.rst index 28697f5..197ca59 100644 --- a/doc/elementary/elementary.rst +++ b/doc/elementary/elementary.rst @@ -1,11 +1,7 @@ .. module:: efl.elementary -Elementary -########## - - What is elementary? -=================== +******************* Elementary is a the high level toolkit based on the underlying efl technologies (:doc:`Evas `, :doc:`Edje `, @@ -17,10 +13,10 @@ of flexibility. Callbacks -========= +********* Widget callbacks ----------------- +================ Widget callbacks are set with callback_*_add methods which take a callable, and optional args, kwargs as data. @@ -35,7 +31,7 @@ or:: Event callbacks ---------------- +=============== Event callbacks have signature of:: @@ -43,27 +39,14 @@ Event callbacks have signature of:: A sample Python Elementary program -================================== +********************************** .. literalinclude:: ../../examples/elementary/test_win_dialog.py :language: python API Reference -============= - -.. _Fingers: - -Fingers -======= - -Elementary is designed to be finger-friendly for touchscreens, -and so in addition to scaling for display resolution, it can -also scale based on finger "resolution" (or size). You can then -customize the granularity of the areas meant to receive clicks -on touchscreens. - -Different profiles may have pre-set values for finger sizes. +************* Enumerations @@ -297,38 +280,103 @@ Here are documented functions which init/shutdown the library, that apply to generic Elementary objects, that deal with configuration, et cetera. +.. autoclass:: EthumbConnect +.. autoclass:: ConfigAllChanged +.. autoclass:: PolicyChanged +.. autoclass:: ProcessBackground +.. autoclass:: ProcessForeground + +.. autofunction:: on_ethumb_connect +.. autofunction:: on_config_all_changed +.. autofunction:: on_policy_changed +.. autofunction:: on_process_background +.. autofunction:: on_process_foreground + .. autofunction:: init .. autofunction:: shutdown .. autofunction:: run .. autofunction:: exit -.. autofunction:: on_ethumb_connect -.. autofunction:: on_config_all_changed -.. autofunction:: on_policy_changed - -.. autofunction:: on_process_background -.. autofunction:: on_process_background - -.. autofunction:: on_sys_notify_notification_closed -.. autofunction:: on_sys_notify_action_invoked - .. autofunction:: policy_set .. autofunction:: policy_get +.. autofunction:: language_set .. autofunction:: process_state_get + + +.. _Fingers: + +Fingers +======= + +Elementary is designed to be finger-friendly for touchscreens, +and so in addition to scaling for display resolution, it can +also scale based on finger "resolution" (or size). You can then +customize the granularity of the areas meant to receive clicks +on touchscreens. + +Different profiles may have pre-set values for finger sizes. + .. autofunction:: coords_finger_size_adjust -.. autofunction:: language_set + +.. _Caches: + +Caches +====== + +These are functions which let one fine-tune some cache values for +Elementary applications, thus allowing for performance adjustments. + .. autofunction:: cache_all_flush + + +.. _Fonts: + +Fonts +===== + +These are functions dealing with font rendering, selection and the +like for Elementary applications. One might fetch which system +fonts are there to use and set custom fonts for individual classes +of UI items containing text (text classes). + .. autofunction:: font_properties_get .. autofunction:: font_properties_free .. autofunction:: font_fontconfig_name_get + +.. autoclass:: FontProperties + + +.. _Debug: + +Debug +===== + +Don't use them unless you are sure. + .. autofunction:: object_tree_dump .. autofunction:: object_tree_dot_dump + +.. _Sys_Notify: + +Sys Notify +========== + .. autofunction:: sys_notify_close .. autofunction:: sys_notify_send +.. autofunction:: on_sys_notify_notification_closed +.. autofunction:: on_sys_notify_action_invoked + +.. autoclass:: SysNotifyNotificationClosed +.. autoclass:: SysNotifyActionInvoked + + +Widgets +======= + .. toctree:: * :glob: :maxdepth: 1 diff --git a/doc/elementary/entry.rst b/doc/elementary/entry.rst index b279d00..f25708f 100644 --- a/doc/elementary/entry.rst +++ b/doc/elementary/entry.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Entry ##### @@ -16,7 +18,7 @@ resizing the parent window as needed. This can be changed with the property They can also be single line or multi line (the default) and when set to multi line mode they support text wrapping in any of the modes -indicated by :ref:`Elm_Entry_Wrap_Type`. +indicated by :ref:`Elm_Wrap_Type`. Other features include password mode, filtering of inserted text with :py:meth:`~efl.elementary.entry.Entry.markup_filter_append` and related @@ -540,7 +542,7 @@ Text format UTF-8 with markup -.. _Elm_Entry_Wrap_Type: +.. _Elm_Wrap_Type: Wrap mode --------- @@ -562,29 +564,18 @@ Wrap mode Word wrap, and if that fails, char wrap -.. _Elm_Entry_Icon_Type: - -Icon types ----------- - -.. data:: ELM_ICON_NONE - - No icon - -.. data:: ELM_ICON_FILE - - Icon is a file - -.. data:: ELM_ICON_STANDARD - - Icon is set with standards names - - Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Entry +.. inheritance-diagram:: Entry :parts: 2 +.. autofunction:: markup_to_utf8 +.. autofunction:: utf8_to_markup -.. autoclass:: efl.elementary.Entry +.. autoclass:: Entry +.. autoclass:: EntryContextMenuItem +.. autoclass:: FilterLimitSize +.. autoclass:: FilterAcceptSet +.. autoclass:: EntryAnchorInfo +.. autoclass:: EntryAnchorHoverInfo diff --git a/doc/elementary/fileselector.rst b/doc/elementary/fileselector.rst index bf3d2e9..96da8c2 100644 --- a/doc/elementary/fileselector.rst +++ b/doc/elementary/fileselector.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Fileselector ############ @@ -128,8 +130,8 @@ Fileselector sort method Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Fileselector +.. inheritance-diagram:: Fileselector :parts: 2 -.. autoclass:: efl.elementary.Fileselector +.. autoclass:: Fileselector diff --git a/doc/elementary/fileselector_button.rst b/doc/elementary/fileselector_button.rst index 179ee66..fd06331 100644 --- a/doc/elementary/fileselector_button.rst +++ b/doc/elementary/fileselector_button.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Fileselector Button ################### @@ -66,8 +68,8 @@ using multiple inheritance, for example:: Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.FileselectorButton +.. inheritance-diagram:: FileselectorButton :parts: 2 -.. autoclass:: efl.elementary.FileselectorButton +.. autoclass:: FileselectorButton diff --git a/doc/elementary/fileselector_entry.rst b/doc/elementary/fileselector_entry.rst index 14344b1..b916ab4 100644 --- a/doc/elementary/fileselector_entry.rst +++ b/doc/elementary/fileselector_entry.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Fileselector Entry ################## @@ -81,8 +83,8 @@ using multiple inheritance, for example:: Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.FileselectorEntry +.. inheritance-diagram:: FileselectorEntry :parts: 2 -.. autoclass:: efl.elementary.FileselectorEntry +.. autoclass:: FileselectorEntry diff --git a/doc/elementary/flip.rst b/doc/elementary/flip.rst index 08c87a4..0e3ae83 100644 --- a/doc/elementary/flip.rst +++ b/doc/elementary/flip.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Flip #### @@ -155,8 +157,8 @@ Flip types Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Flip +.. inheritance-diagram:: Flip :parts: 2 -.. autoclass:: efl.elementary.Flip +.. autoclass:: Flip diff --git a/doc/elementary/flipselector.rst b/doc/elementary/flipselector.rst index dad39c8..aa4e4af 100644 --- a/doc/elementary/flipselector.rst +++ b/doc/elementary/flipselector.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Flipselector ############ @@ -40,9 +42,11 @@ Layout text parts Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.FlipSelector +.. inheritance-diagram:: + FlipSelector + FlipSelectorItem :parts: 2 -.. autoclass:: efl.elementary.FlipSelector -.. autoclass:: efl.elementary.FlipSelectorItem +.. autoclass:: FlipSelector +.. autoclass:: FlipSelectorItem diff --git a/doc/elementary/frame.rst b/doc/elementary/frame.rst index 72ae8e2..ce18e88 100644 --- a/doc/elementary/frame.rst +++ b/doc/elementary/frame.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Frame ##### @@ -45,8 +47,8 @@ Layout text parts Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Frame +.. inheritance-diagram:: Frame :parts: 2 -.. autoclass:: efl.elementary.Frame +.. autoclass:: Frame diff --git a/doc/elementary/gengrid.rst b/doc/elementary/gengrid.rst index b14bdce..294fb9b 100644 --- a/doc/elementary/gengrid.rst +++ b/doc/elementary/gengrid.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Gengrid ####### @@ -253,19 +255,19 @@ Enumerations Items' scroll to types ---------------------- -.. data:: ELM_GENLIST_ITEM_SCROLLTO_NONE +.. data:: ELM_GENGRID_ITEM_SCROLLTO_NONE No scroll to -.. data:: ELM_GENLIST_ITEM_SCROLLTO_IN +.. data:: ELM_GENGRID_ITEM_SCROLLTO_IN Scroll to the nearest viewport -.. data:: ELM_GENLIST_ITEM_SCROLLTO_TOP +.. data:: ELM_GENGRID_ITEM_SCROLLTO_TOP Scroll to the top of viewport -.. data:: ELM_GENLIST_ITEM_SCROLLTO_MIDDLE +.. data:: ELM_GENGRID_ITEM_SCROLLTO_MIDDLE Scroll to the middle of viewport @@ -315,10 +317,13 @@ Reorder type Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Gengrid +.. inheritance-diagram:: + Gengrid + GengridItem + GengridItemClass :parts: 2 -.. autoclass:: efl.elementary.Gengrid -.. autoclass:: efl.elementary.GengridItem -.. autoclass:: efl.elementary.GengridItemClass +.. autoclass:: Gengrid +.. autoclass:: GengridItem +.. autoclass:: GengridItemClass diff --git a/doc/elementary/genlist.rst b/doc/elementary/genlist.rst index 1034009..493a06c 100644 --- a/doc/elementary/genlist.rst +++ b/doc/elementary/genlist.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Genlist ####### @@ -436,77 +438,16 @@ Genlist items' scroll-to types Scroll to the middle of viewport -.. _Elm_Genlist_List_Mode: - -List sizing ------------ - -.. data:: ELM_LIST_COMPRESS - - The list won't set any of its size hints to inform how a possible container - should resize it. - - Then, if it's not created as a "resize object", it might end with zeroed - dimensions. The list will respect the container's geometry and, if any of - its items won't fit into its transverse axis, one won't be able to scroll it - in that direction. - -.. data:: ELM_LIST_SCROLL - - Default value. - - This is the same as ELM_LIST_COMPRESS, with the exception that if any of - its items won't fit into its transverse axis, one will be able to scroll - it in that direction. - -.. data:: ELM_LIST_LIMIT - - Sets a minimum size hint on the list object, so that containers may - respect it (and resize itself to fit the child properly). - - More specifically, a minimum size hint will be set for its transverse - axis, so that the largest item in that direction fits well. This is - naturally bound by the list object's maximum size hints, set externally. - -.. data:: ELM_LIST_EXPAND - - Besides setting a minimum size on the transverse axis, just like on - ELM_LIST_LIMIT, the list will set a minimum size on the longitudinal - axis, trying to reserve space to all its children to be visible at a time. - - This is naturally bound by the list object's maximum size hints, set - externally. - - -.. _Elm_Genlist_Object_Select_Mode: - -Selection modes ---------------- - -.. data:: ELM_OBJECT_SELECT_MODE_DEFAULT - - Default select mode - -.. data:: ELM_OBJECT_SELECT_MODE_ALWAYS - - Always select mode - -.. data:: ELM_OBJECT_SELECT_MODE_NONE - - No select mode - -.. data:: ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY - - No select mode with no finger size rule - - Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Genlist +.. inheritance-diagram:: + Genlist + GenlistItem + GenlistItemClass :parts: 2 -.. autoclass:: efl.elementary.Genlist -.. autoclass:: efl.elementary.GenlistItem -.. autoclass:: efl.elementary.GenlistItemClass +.. autoclass:: Genlist +.. autoclass:: GenlistItem +.. autoclass:: GenlistItemClass diff --git a/doc/elementary/gesture_layer.rst b/doc/elementary/gesture_layer.rst index 97e6568..40e66ca 100644 --- a/doc/elementary/gesture_layer.rst +++ b/doc/elementary/gesture_layer.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Gesture Layer ############# @@ -143,8 +145,8 @@ Gesture types Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.GestureLayer +.. inheritance-diagram:: GestureLayer :parts: 2 -.. autoclass:: efl.elementary.GestureLayer +.. autoclass:: GestureLayer diff --git a/doc/elementary/grid.rst b/doc/elementary/grid.rst index fd8dfa7..0050997 100644 --- a/doc/elementary/grid.rst +++ b/doc/elementary/grid.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Grid #### @@ -22,8 +24,10 @@ of the width or height of the grid widget. Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Grid +.. inheritance-diagram:: Grid :parts: 2 -.. autoclass:: efl.elementary.Grid +.. autoclass:: Grid +.. autofunction:: grid_pack_set +.. autofunction:: grid_pack_get diff --git a/doc/elementary/hover.rst b/doc/elementary/hover.rst index 5f8e3bf..136fdce 100644 --- a/doc/elementary/hover.rst +++ b/doc/elementary/hover.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Hover ##### @@ -102,8 +104,8 @@ Hover axis Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Hover +.. inheritance-diagram:: Hover :parts: 2 -.. autoclass:: efl.elementary.Hover +.. autoclass:: Hover diff --git a/doc/elementary/hoversel.rst b/doc/elementary/hoversel.rst index a10123d..a4e6578 100644 --- a/doc/elementary/hoversel.rst +++ b/doc/elementary/hoversel.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Hoversel ######## @@ -41,33 +43,14 @@ Layout text parts - ``default`` - Label of the hoversel -Enumerations -============ - -.. _Elm_Hoversel_Icon_Type: - -Icon types ----------- - -.. data:: ELM_ICON_NONE - - No icon - -.. data:: ELM_ICON_FILE - - Icon is a file - -.. data:: ELM_ICON_STANDARD - - Icon is set with standards names - - Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Hoversel +.. inheritance-diagram:: + Hoversel + HoverselItem :parts: 2 -.. autoclass:: efl.elementary.Hoversel -.. autoclass:: efl.elementary.HoverselItem +.. autoclass:: Hoversel +.. autoclass:: HoverselItem diff --git a/doc/elementary/icon.rst b/doc/elementary/icon.rst index f05ebb0..a554e6b 100644 --- a/doc/elementary/icon.rst +++ b/doc/elementary/icon.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Icon #### @@ -174,8 +176,8 @@ Icon type Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Icon +.. inheritance-diagram:: Icon :parts: 2 -.. autoclass:: efl.elementary.Icon +.. autoclass:: Icon diff --git a/doc/elementary/image.rst b/doc/elementary/image.rst index e3ab353..8abb85e 100644 --- a/doc/elementary/image.rst +++ b/doc/elementary/image.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Image ##### @@ -86,8 +88,8 @@ Image manipulation types Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Image +.. inheritance-diagram:: Image :parts: 2 -.. autoclass:: efl.elementary.Image +.. autoclass:: Image diff --git a/doc/elementary/index.rst b/doc/elementary/index.rst index 3985b5a..79dbf0d 100644 --- a/doc/elementary/index.rst +++ b/doc/elementary/index.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Index ##### @@ -52,8 +54,11 @@ actually be reported. Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Index +.. inheritance-diagram:: + Index + IndexItem :parts: 2 -.. autoclass:: efl.elementary.Index +.. autoclass:: Index +.. autoclass:: IndexItem diff --git a/doc/elementary/innerwindow.rst b/doc/elementary/innerwindow.rst index 5e70c6f..6f73100 100644 --- a/doc/elementary/innerwindow.rst +++ b/doc/elementary/innerwindow.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Innerwindow ########### @@ -33,8 +35,8 @@ Available styles Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.InnerWindow +.. inheritance-diagram:: InnerWindow :parts: 2 -.. autoclass:: efl.elementary.InnerWindow +.. autoclass:: InnerWindow diff --git a/doc/elementary/label.rst b/doc/elementary/label.rst index 820c446..dfd17d3 100644 --- a/doc/elementary/label.rst +++ b/doc/elementary/label.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Label ##### @@ -48,28 +50,6 @@ Emitted signals Enumerations ============ -.. _Elm_Label_Wrap_Type: - -Wrap modes ----------- - -.. data:: ELM_WRAP_NONE - - No wrap - -.. data:: ELM_WRAP_CHAR - - Wrap between characters - -.. data:: ELM_WRAP_WORD - - Wrap in allowed wrapping points (as defined in the unicode standard) - -.. data:: ELM_WRAP_MIXED - - Word wrap, and if that fails, char wrap. - - .. _Elm_Label_Slide_Mode: Slide modes @@ -91,8 +71,8 @@ Slide modes Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Label +.. inheritance-diagram:: Label :parts: 2 -.. autoclass:: efl.elementary.Label +.. autoclass:: Label diff --git a/doc/elementary/layout.rst b/doc/elementary/layout.rst index 10ebeb8..6acf0d6 100644 --- a/doc/elementary/layout.rst +++ b/doc/elementary/layout.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Layout ###### @@ -155,9 +157,9 @@ Emitted signals Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Layout +.. inheritance-diagram:: Layout :parts: 2 -.. autoclass:: efl.elementary.Layout -.. autoclass:: efl.elementary.LayoutClass +.. autoclass:: Layout +.. autoclass:: LayoutClass diff --git a/doc/elementary/list.rst b/doc/elementary/list.rst index 9cf38b1..01b29f1 100644 --- a/doc/elementary/list.rst +++ b/doc/elementary/list.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + List #### @@ -122,39 +124,14 @@ List sizing modes externally. -.. _Elm_List_Object_Select_Mode: - -Selection modes ---------------- - -.. data:: ELM_OBJECT_SELECT_MODE_DEFAULT - - Items will only call their selection func and callback when - first becoming selected. Any further clicks will do nothing, - unless you set always select mode. - -.. data:: ELM_OBJECT_SELECT_MODE_ALWAYS - - This means that, even if selected, every click will make the - selected callbacks be called. - -.. data:: ELM_OBJECT_SELECT_MODE_NONE - - This will turn off the ability to select items entirely and - they will neither appear selected nor call selected callback - functions. - -.. data:: ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY - - No select mode with no finger size rule - - Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.List +.. inheritance-diagram:: + List + ListItem :parts: 2 -.. autoclass:: efl.elementary.List -.. autoclass:: efl.elementary.ListItem +.. autoclass:: List +.. autoclass:: ListItem diff --git a/doc/elementary/map.rst b/doc/elementary/map.rst index b9bd72e..3933e45 100644 --- a/doc/elementary/map.rst +++ b/doc/elementary/map.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Map ### @@ -193,8 +195,8 @@ Map zoom modes Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Map +.. inheritance-diagram:: Map :parts: 2 -.. autoclass:: efl.elementary.Map +.. autoclass:: Map diff --git a/doc/elementary/mapbuf.rst b/doc/elementary/mapbuf.rst index 1930e0e..6cde934 100644 --- a/doc/elementary/mapbuf.rst +++ b/doc/elementary/mapbuf.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Mapbuf ###### @@ -24,8 +26,8 @@ Layout content parts Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Mapbuf +.. inheritance-diagram:: Mapbuf :parts: 2 -.. autoclass:: efl.elementary.Mapbuf +.. autoclass:: Mapbuf diff --git a/doc/elementary/menu.rst b/doc/elementary/menu.rst index 183ad4d..e1dfcac 100644 --- a/doc/elementary/menu.rst +++ b/doc/elementary/menu.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Menu #### @@ -36,9 +38,11 @@ Layout text parts Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Menu +.. inheritance-diagram:: + Menu + MenuItem :parts: 2 -.. autoclass:: efl.elementary.Menu -.. autoclass:: efl.elementary.MenuItem +.. autoclass:: Menu +.. autoclass:: MenuItem diff --git a/doc/elementary/multibuttonentry.rst b/doc/elementary/multibuttonentry.rst index 1384856..04e4562 100644 --- a/doc/elementary/multibuttonentry.rst +++ b/doc/elementary/multibuttonentry.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + MultiButtonEntry ################ @@ -51,8 +53,8 @@ Layout text parts Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.MultiButtonEntry +.. inheritance-diagram:: MultiButtonEntry :parts: 2 -.. autoclass:: efl.elementary.MultiButtonEntry +.. autoclass:: MultiButtonEntry diff --git a/doc/elementary/naviframe.rst b/doc/elementary/naviframe.rst index 32233fe..c1dfc3f 100644 --- a/doc/elementary/naviframe.rst +++ b/doc/elementary/naviframe.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Naviframe ######### @@ -85,8 +87,11 @@ the top one can be interacted with this way. Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Naviframe +.. inheritance-diagram:: + Naviframe + NaviframeItem :parts: 2 -.. autoclass:: efl.elementary.Naviframe +.. autoclass:: Naviframe +.. autoclass:: NaviframeItem diff --git a/doc/elementary/need.rst b/doc/elementary/need.rst index c9e2371..16de354 100644 --- a/doc/elementary/need.rst +++ b/doc/elementary/need.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Need #### diff --git a/doc/elementary/notify.rst b/doc/elementary/notify.rst index 97ec6f9..503c4e1 100644 --- a/doc/elementary/notify.rst +++ b/doc/elementary/notify.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Notify ###### @@ -45,8 +47,8 @@ ELM_NOTIFY_ALIGN_FILL Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Notify +.. inheritance-diagram:: Notify :parts: 2 -.. autoclass:: efl.elementary.Notify +.. autoclass:: Notify diff --git a/doc/elementary/object.rst b/doc/elementary/object.rst index 8b73309..8ebeff6 100644 --- a/doc/elementary/object.rst +++ b/doc/elementary/object.rst @@ -1,7 +1,8 @@ +.. currentmodule:: efl.elementary + Object ###### - Copy and Paste ============== @@ -244,11 +245,38 @@ Defines the kind of action associated with the drop data if for XDND Describe the data +.. _Elm_Object_Select_Mode: + +Selection modes +--------------- + +.. data:: ELM_OBJECT_SELECT_MODE_DEFAULT + + Items will only call their selection func and callback when + first becoming selected. Any further clicks will do nothing, + unless you set always select mode. + +.. data:: ELM_OBJECT_SELECT_MODE_ALWAYS + + This means that, even if selected, every click will make the + selected callbacks be called. + +.. data:: ELM_OBJECT_SELECT_MODE_NONE + + This will turn off the ability to select items entirely and + they will neither appear selected nor call selected callback + functions. + +.. data:: ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY + + No select mode with no finger size rule + + Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Object +.. inheritance-diagram:: Object :parts: 2 -.. autoclass:: efl.elementary.Object +.. autoclass:: Object diff --git a/doc/elementary/object_item.rst b/doc/elementary/object_item.rst index 806370e..da53742 100644 --- a/doc/elementary/object_item.rst +++ b/doc/elementary/object_item.rst @@ -1,11 +1,13 @@ +.. currentmodule:: efl.elementary + Object Item -######################### +########### Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.ObjectItem +.. inheritance-diagram:: ObjectItem :parts: 2 -.. autoclass:: efl.elementary.ObjectItem +.. autoclass:: ObjectItem diff --git a/doc/elementary/panel.rst b/doc/elementary/panel.rst index 8583edf..8c2be7a 100644 --- a/doc/elementary/panel.rst +++ b/doc/elementary/panel.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Panel ##### @@ -53,8 +55,8 @@ Panel orientation types Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Panel +.. inheritance-diagram:: Panel :parts: 2 -.. autoclass:: efl.elementary.Panel +.. autoclass:: Panel diff --git a/doc/elementary/panes.rst b/doc/elementary/panes.rst index fdf9bfa..4002fdd 100644 --- a/doc/elementary/panes.rst +++ b/doc/elementary/panes.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Panes ##### @@ -37,8 +39,8 @@ If panes are displayed vertically, left content will be displayed on top. Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Panes +.. inheritance-diagram:: Panes :parts: 2 -.. autoclass:: efl.elementary.Panes +.. autoclass:: Panes diff --git a/doc/elementary/photo.rst b/doc/elementary/photo.rst index 324eb31..08b8752 100644 --- a/doc/elementary/photo.rst +++ b/doc/elementary/photo.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Photo ##### @@ -30,8 +32,8 @@ Emitted signals Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Photo +.. inheritance-diagram:: Photo :parts: 2 -.. autoclass:: efl.elementary.Photo +.. autoclass:: Photo diff --git a/doc/elementary/photocam.rst b/doc/elementary/photocam.rst index baef766..37d6e2e 100644 --- a/doc/elementary/photocam.rst +++ b/doc/elementary/photocam.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Photocam ######## @@ -86,8 +88,8 @@ Photocam zoom modes Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Photocam +.. inheritance-diagram:: Photocam :parts: 2 -.. autoclass:: efl.elementary.Photocam +.. autoclass:: Photocam diff --git a/doc/elementary/plug.rst b/doc/elementary/plug.rst index f7e4169..d69c8aa 100644 --- a/doc/elementary/plug.rst +++ b/doc/elementary/plug.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Plug #### @@ -29,8 +31,8 @@ Emitted signals Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Plug +.. inheritance-diagram:: Plug :parts: 2 -.. autoclass:: efl.elementary.Plug +.. autoclass:: Plug diff --git a/doc/elementary/popup.rst b/doc/elementary/popup.rst index e26bebf..e821740 100644 --- a/doc/elementary/popup.rst +++ b/doc/elementary/popup.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Popup ##### @@ -138,33 +140,14 @@ Popup orientation types Popup should appear in the bottom right of parent -.. Elm_Wrap_Type: - -Wrap modes ----------- - -.. data:: ELM_WRAP_NONE - - No wrap - -.. data:: ELM_WRAP_CHAR - - Wrap between characters - -.. data:: ELM_WRAP_WORD - - Wrap in allowed wrapping points (as defined in the unicode standard) - -.. data:: ELM_WRAP_MIXED - - Word wrap, and if that fails, char wrap. - - Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Popup +.. inheritance-diagram:: + Popup + PopupItem :parts: 2 -.. autoclass:: efl.elementary.Popup +.. autoclass:: Popup +.. autoclass:: PopupItem diff --git a/doc/elementary/progressbar.rst b/doc/elementary/progressbar.rst index 9a446af..dff5271 100644 --- a/doc/elementary/progressbar.rst +++ b/doc/elementary/progressbar.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Progressbar ########### @@ -59,8 +61,8 @@ Default part names for the "recording" style: Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Progressbar +.. inheritance-diagram:: Progressbar :parts: 2 -.. autoclass:: efl.elementary.Progressbar +.. autoclass:: Progressbar diff --git a/doc/elementary/radio.rst b/doc/elementary/radio.rst index b6ac330..853a58e 100644 --- a/doc/elementary/radio.rst +++ b/doc/elementary/radio.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Radio ##### @@ -54,8 +56,8 @@ Layout content parts Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Radio +.. inheritance-diagram:: Radio :parts: 2 -.. autoclass:: efl.elementary.Radio +.. autoclass:: Radio diff --git a/doc/elementary/scroller.rst b/doc/elementary/scroller.rst index 3b06d18..1c2bb62 100644 --- a/doc/elementary/scroller.rst +++ b/doc/elementary/scroller.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Scroller ######## @@ -127,8 +129,8 @@ Type that blocks the scroll movement in one or more direction. Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Scroller +.. inheritance-diagram:: Scroller :parts: 2 -.. autoclass:: efl.elementary.Scroller +.. autoclass:: Scroller diff --git a/doc/elementary/segment_control.rst b/doc/elementary/segment_control.rst index 7ce1851..f507a1d 100644 --- a/doc/elementary/segment_control.rst +++ b/doc/elementary/segment_control.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Segment Control ############### @@ -41,8 +43,8 @@ Layout text parts Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.SegmentControl +.. inheritance-diagram:: SegmentControl :parts: 2 -.. autoclass:: efl.elementary.SegmentControl +.. autoclass:: SegmentControl diff --git a/doc/elementary/separator.rst b/doc/elementary/separator.rst index 4aa0385..afd0217 100644 --- a/doc/elementary/separator.rst +++ b/doc/elementary/separator.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Separator ######### @@ -15,8 +17,8 @@ A separator can be vertical or horizontal. Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Separator +.. inheritance-diagram:: Separator :parts: 2 -.. autoclass:: efl.elementary.Separator +.. autoclass:: Separator diff --git a/doc/elementary/slider.rst b/doc/elementary/slider.rst index 33845df..678f21c 100644 --- a/doc/elementary/slider.rst +++ b/doc/elementary/slider.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Slider ###### @@ -61,8 +63,8 @@ Layout text parts Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Slider +.. inheritance-diagram:: Slider :parts: 2 -.. autoclass:: efl.elementary.Slider +.. autoclass:: Slider diff --git a/doc/elementary/slideshow.rst b/doc/elementary/slideshow.rst index 3916fc1..fd8f625 100644 --- a/doc/elementary/slideshow.rst +++ b/doc/elementary/slideshow.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Slideshow ######### @@ -65,8 +67,8 @@ Emitted signals Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Slideshow +.. inheritance-diagram:: Slideshow :parts: 2 -.. autoclass:: efl.elementary.Slideshow +.. autoclass:: Slideshow diff --git a/doc/elementary/spinner.rst b/doc/elementary/spinner.rst index 665bead..b805974 100644 --- a/doc/elementary/spinner.rst +++ b/doc/elementary/spinner.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Spinner ####### @@ -44,8 +46,8 @@ Available styles Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Spinner +.. inheritance-diagram:: Spinner :parts: 2 -.. autoclass:: efl.elementary.Spinner +.. autoclass:: Spinner diff --git a/doc/elementary/systray.rst b/doc/elementary/systray.rst index 4f5a377..50e7304 100644 --- a/doc/elementary/systray.rst +++ b/doc/elementary/systray.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Systray ####### @@ -49,4 +51,7 @@ Application status information. -.. autoclass:: efl.elementary.Systray +.. autoclass:: Systray +.. autofunction:: on_systray_ready + +.. autoclass:: EventSystrayReady diff --git a/doc/elementary/table.rst b/doc/elementary/table.rst index 85233e7..8f7337e 100644 --- a/doc/elementary/table.rst +++ b/doc/elementary/table.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Table ##### @@ -27,8 +29,10 @@ The most common way to use a table is:: Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Table +.. inheritance-diagram:: Table :parts: 2 -.. autoclass:: efl.elementary.Table +.. autoclass:: Table +.. autofunction:: table_pack_set +.. autofunction:: table_pack_get diff --git a/doc/elementary/theme.rst b/doc/elementary/theme.rst index 0e73b27..7deb36e 100644 --- a/doc/elementary/theme.rst +++ b/doc/elementary/theme.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Theme ##### @@ -72,8 +74,8 @@ overlays. Don't use this unless you really know what you are doing. Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Theme +.. inheritance-diagram:: Theme :parts: 2 -.. autoclass:: efl.elementary.Theme +.. autoclass:: Theme diff --git a/doc/elementary/thumb.rst b/doc/elementary/thumb.rst index 24b8393..b826d71 100644 --- a/doc/elementary/thumb.rst +++ b/doc/elementary/thumb.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Thumb ##### @@ -163,8 +165,8 @@ Thumb orientation Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Thumb +.. inheritance-diagram:: Thumb :parts: 2 -.. autoclass:: efl.elementary.Thumb +.. autoclass:: Thumb diff --git a/doc/elementary/toolbar.rst b/doc/elementary/toolbar.rst index 087a6fc..1dfcd0d 100644 --- a/doc/elementary/toolbar.rst +++ b/doc/elementary/toolbar.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Toolbar ####### @@ -59,50 +61,6 @@ using multiple inheritance, for example:: Enumerations ============ -.. _Elm_Toolbar_Icon_Lookup_Order: - -Icon lookup modes ------------------ - -.. data:: ELM_ICON_LOOKUP_FDO_THEME - - freedesktop, theme - -.. data:: ELM_ICON_LOOKUP_THEME_FDO - - theme, freedesktop - -.. data:: ELM_ICON_LOOKUP_FDO - - freedesktop - -.. data:: ELM_ICON_LOOKUP_THEME - - theme - - -.. _Elm_Toolbar_Object_Select_Mode: - -Selection modes ---------------- - -.. data:: ELM_OBJECT_SELECT_MODE_DEFAULT - - Default select mode - -.. data:: ELM_OBJECT_SELECT_MODE_ALWAYS - - Always select mode - -.. data:: ELM_OBJECT_SELECT_MODE_NONE - - No select mode - -.. data:: ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY - - No select mode with no finger size rule - - .. _Elm_Toolbar_Shrink_Mode: Toolbar shrink modes @@ -160,8 +118,13 @@ Where to position the item in the toolbar. Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Toolbar +.. inheritance-diagram:: + Toolbar + ToolbarItem + ToolbarItemState :parts: 2 -.. autoclass:: efl.elementary.Toolbar +.. autoclass:: Toolbar +.. autoclass:: ToolbarItem +.. autoclass:: ToolbarItemState diff --git a/doc/elementary/transit.rst b/doc/elementary/transit.rst index 785609b..011363b 100644 --- a/doc/elementary/transit.rst +++ b/doc/elementary/transit.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Transit ####### @@ -157,8 +159,8 @@ Tween modes Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Transit +.. inheritance-diagram:: Transit :parts: 2 -.. autoclass:: efl.elementary.Transit +.. autoclass:: Transit diff --git a/doc/elementary/video.rst b/doc/elementary/video.rst index 83bb901..bfaa31f 100644 --- a/doc/elementary/video.rst +++ b/doc/elementary/video.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Video ##### @@ -21,8 +23,11 @@ These widgets emit the following signals, besides the ones sent from Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Video +.. inheritance-diagram:: + Video + Player :parts: 2 -.. autoclass:: efl.elementary.Video +.. autoclass:: Video +.. autoclass:: Player diff --git a/doc/elementary/web.rst b/doc/elementary/web.rst index 4688da6..b909541 100644 --- a/doc/elementary/web.rst +++ b/doc/elementary/web.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Web ### @@ -132,8 +134,8 @@ Web zoom modes Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Web +.. inheritance-diagram:: Web :parts: 2 -.. autoclass:: efl.elementary.Web +.. autoclass:: Web diff --git a/doc/elementary/window.rst b/doc/elementary/window.rst index db5b2dd..1728fb4 100644 --- a/doc/elementary/window.rst +++ b/doc/elementary/window.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.elementary + Window ###### @@ -347,8 +349,13 @@ Illume manager to perform different actions. Inheritance diagram =================== -.. inheritance-diagram:: efl.elementary.Window +.. inheritance-diagram:: + Window + StandardWindow + DialogWindow :parts: 2 -.. autoclass:: efl.elementary.Window +.. autoclass:: Window +.. autoclass:: StandardWindow +.. autoclass:: DialogWindow diff --git a/efl/elementary/__init__.pyx b/efl/elementary/__init__.pyx index 4bc711b..7ece3c5 100644 --- a/efl/elementary/__init__.pyx +++ b/efl/elementary/__init__.pyx @@ -323,7 +323,7 @@ def on_process_background(func, *args, **kwargs): return EventHandler(ELM_EVENT_PROCESS_BACKGROUND, func, *args, **kwargs) -def on_process_background(func, *args, **kwargs): +def on_process_foreground(func, *args, **kwargs): """Use this to set a handler for the process foreground event. Emitted when going from nothing being visible to at least one window being diff --git a/efl/elementary/entry.pxi b/efl/elementary/entry.pxi index 3eaa627..713b40a 100644 --- a/efl/elementary/entry.pxi +++ b/efl/elementary/entry.pxi @@ -597,7 +597,7 @@ cdef class Entry(LayoutClass): Note that this only makes sense for multi-line entries. A widget set to be single line will never wrap. - :type: :ref:`Elm_Entry_Wrap_Type` + :type: :ref:`Elm_Wrap_Type` """ def __get__(self): diff --git a/efl/elementary/genlist_item.pxi b/efl/elementary/genlist_item.pxi index 5efeb09..d74dbb0 100644 --- a/efl/elementary/genlist_item.pxi +++ b/efl/elementary/genlist_item.pxi @@ -602,7 +602,7 @@ cdef class GenlistItem(ObjectItem): property select_mode: """Item's select mode. Possible values are: - :type: :ref:`Elm_Genlist_Object_Select_Mode` + :type: :ref:`Elm_Object_Select_Mode` """ def __set__(self, mode): diff --git a/efl/elementary/genlist_widget.pxi b/efl/elementary/genlist_widget.pxi index cfeaee6..f0260d4 100644 --- a/efl/elementary/genlist_widget.pxi +++ b/efl/elementary/genlist_widget.pxi @@ -615,7 +615,7 @@ cdef class Genlist(Object): select items entirely and they will neither appear selected nor call selected callback functions. - :type: :ref:`Elm_Genlist_Object_Select_Mode` + :type: :ref:`Elm_Object_Select_Mode` """ def __set__(self, mode): diff --git a/efl/elementary/hoversel.pxi b/efl/elementary/hoversel.pxi index 42c380a..b02d770 100644 --- a/efl/elementary/hoversel.pxi +++ b/efl/elementary/hoversel.pxi @@ -42,7 +42,7 @@ cdef class HoverselItem(ObjectItem): standard icon name (None if not desired) :type icon_file: string :param icon_type: The icon type if relevant - :type icon_type: :ref:`Elm_Hoversel_Icon_Type` + :type icon_type: :ref:`Elm_Icon_Type` :param callback: Convenience function to call when this item is selected :type callback: function diff --git a/efl/elementary/label.pxi b/efl/elementary/label.pxi index a39c24a..668632e 100644 --- a/efl/elementary/label.pxi +++ b/efl/elementary/label.pxi @@ -42,7 +42,7 @@ cdef class Label(LayoutClass): By default no wrapping is done. - :type: :ref:`Elm_Label_Wrap_Type` + :type: :ref:`Elm_Wrap_Type` """ def __get__(self): diff --git a/efl/elementary/list.pxi b/efl/elementary/list.pxi index 53d80c7..6735dd8 100644 --- a/efl/elementary/list.pxi +++ b/efl/elementary/list.pxi @@ -514,7 +514,7 @@ cdef class List(Object): property select_mode: """The list select mode. - :type: :ref:`Elm_List_Object_Select_Mode` + :type: :ref:`Elm_Object_Select_Mode` """ def __set__(self, mode): diff --git a/efl/elementary/popup.pxi b/efl/elementary/popup.pxi index 3757965..a65688e 100644 --- a/efl/elementary/popup.pxi +++ b/efl/elementary/popup.pxi @@ -151,7 +151,7 @@ cdef class Popup(LayoutClass): """Sets the wrapping type of content text packed in content area of popup object. - :type: Elm_Wrap_Type + :type: :ref:`Elm_Wrap_Type` """ def __set__(self, wrap): diff --git a/efl/elementary/toolbar.pxi b/efl/elementary/toolbar.pxi index 7fcc76f..3f2e24f 100644 --- a/efl/elementary/toolbar.pxi +++ b/efl/elementary/toolbar.pxi @@ -621,7 +621,7 @@ cdef class Toolbar(LayoutClass): Icons added before calling this function will not be affected. The default lookup order is :attr:`ELM_ICON_LOOKUP_THEME_FDO`. - :type: :ref:`Elm_Toolbar_Icon_Lookup_Order` + :type: :ref:`Elm_Icon_Lookup_Order` """ def __set__(self, order): @@ -904,7 +904,7 @@ cdef class Toolbar(LayoutClass): property select_mode: """The toolbar select mode. - :type: :ref:`Elm_Toolbar_Object_Select_Mode` + :type: :ref:`Elm_Object_Select_Mode` """ def __get__(self): diff --git a/efl/evas/efl.evas_object_image.pxi b/efl/evas/efl.evas_object_image.pxi index 928603b..9594747 100644 --- a/efl/evas/efl.evas_object_image.pxi +++ b/efl/evas/efl.evas_object_image.pxi @@ -135,7 +135,7 @@ cdef class Image(Object): :type file: string or tuple :param \**kwargs: All the remaining keyword arguments are interpreted as properties of the instance - + """ self._set_obj(evas_object_image_add(canvas.obj)) @@ -470,7 +470,6 @@ cdef class Image(Object): of the image. If data is None the current image data will be freed. :param buf: The buffer - :type buf: data """ cdef: @@ -911,7 +910,7 @@ cdef class Image(Object): :type: Evas_Image_Orient .. versionadded:: 1.14 - + """ def __set__(self, value): evas_object_image_orient_set(self.obj, value) @@ -1372,7 +1371,7 @@ cdef class FilledImage(Image): :type canvas: :py:class:`~efl.evas.Canvas` :param \**kwargs: All the remaining keyword arguments are interpreted as properties of the instance - + """ Image.__init__(self, canvas, **kargs) w, h = self.size_get() diff --git a/efl/evas/efl.evas_object_table.pxi b/efl/evas/efl.evas_object_table.pxi index 8dbdaa5..b49f691 100644 --- a/efl/evas/efl.evas_object_table.pxi +++ b/efl/evas/efl.evas_object_table.pxi @@ -45,7 +45,7 @@ cdef class Table(Object): :type canvas: :py:class:`~efl.evas.Canvas` :keyword \**kwargs: All the remaining keyword arguments are interpreted as properties of the instance - + """ self._set_obj(evas_object_table_add(canvas.obj)) self._set_properties_from_keyword_args(kwargs) @@ -55,7 +55,7 @@ cdef class Table(Object): """Create a table that is child of a given parent. :param parent: - :type parent: Object + :type parent: :class:`~efl.evas.Object` """ Object._set_obj(cls, evas_object_table_add_to(parent.obj))