enlightenment/python-efl
enlightenment
/
python-efl
7
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Documentation: Fix remaining issues from Elm merge

This commit is contained in:
Kai Huuhko 2015-04-19 22:35:44 +03:00
parent e4d3924317
commit 380d998cd2
79 changed files with 467 additions and 421 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/elementary/actionslider.rst
View File

@ -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

6
doc/elementary/background.rst
View File

@ -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

6
doc/elementary/box.rst
View File

@ -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

6
doc/elementary/bubble.rst
View File

@ -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

6
doc/elementary/button.rst
View File

@ -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

9
doc/elementary/calendar.rst
View File

@ -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

6
doc/elementary/check.rst
View File

@ -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

6
doc/elementary/clock.rst
View File

@ -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

10
doc/elementary/colorselector.rst
View File

@ -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

7
doc/elementary/configuration.rst
View File

@ -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

6
doc/elementary/conformant.rst
View File

@ -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

10
doc/elementary/ctxpopup.rst
View File

@ -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

7
doc/elementary/datetime.rst
View File

@ -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

6
doc/elementary/dayselector.rst
View File

@ -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

10
doc/elementary/diskselector.rst
View File

@ -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

116
doc/elementary/elementary.rst
View File

@ -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 </evas/evas>`, :doc:`Edje </edje/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

35
doc/elementary/entry.rst
View File

@ -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

6
doc/elementary/fileselector.rst
View File

@ -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

6
doc/elementary/fileselector_button.rst
View File

@ -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

6
doc/elementary/fileselector_entry.rst
View File

@ -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

6
doc/elementary/flip.rst
View File

@ -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

10
doc/elementary/flipselector.rst
View File

@ -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

6
doc/elementary/frame.rst
View File

@ -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

21
doc/elementary/gengrid.rst
View File

@ -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

77
doc/elementary/genlist.rst
View File

@ -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

6
doc/elementary/gesture_layer.rst
View File

@ -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

8
doc/elementary/grid.rst
View File

@ -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

6
doc/elementary/hover.rst
View File

@ -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

31
doc/elementary/hoversel.rst
View File

@ -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

6
doc/elementary/icon.rst
View File

@ -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

6
doc/elementary/image.rst
View File

@ -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

9
doc/elementary/index.rst
View File

@ -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

6
doc/elementary/innerwindow.rst
View File

@ -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

28
doc/elementary/label.rst
View File

@ -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

8
doc/elementary/layout.rst
View File

@ -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

37
doc/elementary/list.rst
View File

@ -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

6
doc/elementary/map.rst
View File

@ -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

6
doc/elementary/mapbuf.rst
View File

@ -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

10
doc/elementary/menu.rst
View File

@ -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

6
doc/elementary/multibuttonentry.rst
View File

@ -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

9
doc/elementary/naviframe.rst
View File

@ -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

2
doc/elementary/need.rst
View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.elementary
Need
####

6
doc/elementary/notify.rst
View File

@ -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

34
doc/elementary/object.rst
View File

@ -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

8
doc/elementary/object_item.rst
View File

@ -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

6
doc/elementary/panel.rst
View File

@ -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

6
doc/elementary/panes.rst
View File

@ -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

6
doc/elementary/photo.rst
View File

@ -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

6
doc/elementary/photocam.rst
View File

@ -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

6
doc/elementary/plug.rst
View File

@ -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

31
doc/elementary/popup.rst
View File

@ -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

6
doc/elementary/progressbar.rst
View File

@ -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

6
doc/elementary/radio.rst
View File

@ -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

6
doc/elementary/scroller.rst
View File

@ -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

6
doc/elementary/segment_control.rst
View File

@ -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

6
doc/elementary/separator.rst
View File

@ -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

6
doc/elementary/slider.rst
View File

@ -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

6
doc/elementary/slideshow.rst
View File

@ -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

6
doc/elementary/spinner.rst
View File

@ -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

7
doc/elementary/systray.rst
View File

@ -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

8
doc/elementary/table.rst
View File

@ -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

6
doc/elementary/theme.rst
View File

@ -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

6
doc/elementary/thumb.rst
View File

@ -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

55
doc/elementary/toolbar.rst
View File

@ -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

6
doc/elementary/transit.rst
View File

@ -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

9
doc/elementary/video.rst
View File

@ -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

6
doc/elementary/web.rst
View File

@ -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

11
doc/elementary/window.rst
View File

@ -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

2
efl/elementary/__init__.pyx
View File

@ -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

2
efl/elementary/entry.pxi
View File

@ -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):

2
efl/elementary/genlist_item.pxi
View File

@ -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):

2
efl/elementary/genlist_widget.pxi
View File

@ -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):

2
efl/elementary/hoversel.pxi
View File

@ -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

2
efl/elementary/label.pxi
View File

@ -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):

2
efl/elementary/list.pxi
View File

@ -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):

2
efl/elementary/popup.pxi
View File

@ -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):

4
efl/elementary/toolbar.pxi
View File

@ -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):

7
efl/evas/efl.evas_object_image.pxi
View File

@ -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, <Evas_Image_Orient>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()

4
efl/evas/efl.evas_object_table.pxi
View File

@ -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))