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

Elementary: Documentation fixes

This commit is contained in:
Kai Huuhko 2015-03-05 14:19:48 +02:00
parent 2dcc34230e
commit ded0c5fd06
27 changed files with 254 additions and 232 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
efl/elementary/background.pyx
View File

@ -124,9 +124,9 @@ cdef class Background(LayoutClass):
achieve the :py:class:`efl.elementary.layout_class.LayoutClass`'s file setting
behavior, you'll have to call that method on this object.
:type: string file, *optional* string group
:type: string **file**, *optional* string **group**
:raise: RuntimeError: if setting the file failed.
:raise RuntimeError: if setting the file failed.
"""
def __get__(self):

52
efl/elementary/configuration.pyx
View File

@ -771,7 +771,7 @@ cdef class Configuration(object):
property color_classes_list:
"""Get Elementary's list of supported color classes.
:type: list of tuples (color_class_name, color_class_description)
:type: list of tuples (**color_class_name**, **color_class_description**)
.. versionadded:: 1.10
@ -800,7 +800,10 @@ cdef class Configuration(object):
Return the overlays setted using color_overlay_set()
:type: list of tuples (color_class, (r, g, b, a), (r2, g2, b2, a2), (r3, g3, b3, a3))
:type: list of tuples (**color_class**,
(**r**, **g**, **b**, **a**),
(**r2**, **g2**, **b2**, **a2**),
(**r3**, **g3**, **b3**, **a3**))
.. versionadded:: 1.10
@ -838,19 +841,19 @@ cdef class Configuration(object):
Setting color emits a signal "color_class,set" with source being
the given color class in all edje objects.
:param cc: The color class name
:param r: Object Red value
:param g: Object Green value
:param b: Object Blue value
:param a: Object Alpha value
:param r2: Outline Red value
:param g2: Outline Green value
:param b2: Outline Blue value
:param a2: Outline Alpha value
:param r3: Shadow Red value
:param g3: Shadow Green value
:param b3: Shadow Blue value
:param a3: Shadow Alpha value
:param string cc: The color class name
:param int r: Object Red value
:param int g: Object Green value
:param int b: Object Blue value
:param int a: Object Alpha value
:param int r2: Outline Red value
:param int g2: Outline Green value
:param int b2: Outline Blue value
:param int a2: Outline Alpha value
:param int r3: Shadow Red value
:param int g3: Shadow Green value
:param int b3: Shadow Blue value
:param int a3: Shadow Alpha value
.. versionadded:: 1.10
@ -874,8 +877,8 @@ cdef class Configuration(object):
elm_config_color_overlay_unset(cc)
def color_overlay_apply(self):
"""Apply the changes made with color_overlay_set() and
color_overlay_unset() on the current Elementary window.
"""Apply the changes made with :meth:`color_overlay_set` and
:meth:`color_overlay_unset` on the current Elementary window.
.. versionadded:: 1.10
@ -929,8 +932,8 @@ cdef class Configuration(object):
<const char *>a1 if a1 is not None else NULL)
def font_overlay_apply(self):
"""Apply the changes made with :py:func:`font_overlay_set()` and
:py:func:`font_overlay_unset()` on the current Elementary window.
"""Apply the changes made with :meth:`font_overlay_set` and
:meth:`font_overlay_unset` on the current Elementary window.
This applies all font overlays set to all objects in the UI.
@ -1086,11 +1089,12 @@ cdef class Configuration(object):
"""The focus movement policy.
How the focus is moved to another object. It can be
ELM_FOCUS_MOVE_POLICY_CLICK or ELM_FOCUS_MOVE_POLICY_IN. The first
:attr:`ELM_FOCUS_MOVE_POLICY_CLICK` or
:attr:`ELM_FOCUS_MOVE_POLICY_IN`. The first
means elementary focus is moved on elementary object click. The
second means elementary focus is moved on elementary object mouse in.
:type: Elm_Focus_Move_Policy
:type: :ref:`Elm_Focus_Move_Policy`
.. versionadded:: 1.10
@ -1121,7 +1125,7 @@ cdef class Configuration(object):
elementary will automatically scroll the focused area to the visible
viewport.
:type: Elm_Focus_Autoscroll_Mode
:type: :ref:`Elm_Focus_Autoscroll_Mode`
.. versionadded:: 1.10
@ -1161,7 +1165,7 @@ cdef class Configuration(object):
elm_config_clouseau_enabled_set(enabled)
def indicator_service_get(self, int rotation):
"""indicator_service_get(int rotation) -> unicode
"""
Get the indicator service name according to the rotation degree.
@ -1276,7 +1280,7 @@ cdef class Configuration(object):
:type: :ref:`Elm_Slider_Indicator_Visible_Mode`
.. versionadded:: 1.13
"""
def __get__(self):
return elm_config_slider_indicator_visible_mode_get()

16
efl/elementary/ctxpopup.pyx
View File

@ -117,7 +117,7 @@ cdef class CtxpopupItem(ObjectItem):
.. warning:: Ctxpopup can't hold both an item list and a content at the
same time. When an item is added, any previous content will be
removed.
"""
cdef:
@ -190,7 +190,7 @@ cdef class CtxpopupItem(ObjectItem):
:return: The item added or ``None``, on errors
:rtype: :py:class:`CtxpopupItem`
..versionadded:: 1.11
.. versionadded:: 1.11
"""
cdef Elm_Object_Item *item
@ -216,7 +216,7 @@ cdef class CtxpopupItem(ObjectItem):
:type: :py:class:`CtxpopupItem`
..versionadded:: 1.11
.. versionadded:: 1.11
"""
def __get__(self):
@ -227,7 +227,7 @@ cdef class CtxpopupItem(ObjectItem):
:type: :py:class:`CtxpopupItem`
..versionadded:: 1.11
.. versionadded:: 1.11
"""
def __get__(self):
@ -331,7 +331,7 @@ cdef class Ctxpopup(LayoutClass):
:see: :py:func:`CtxpopupItem.prepend_to`
..versionadded:: 1.11
.. versionadded:: 1.11
"""
cdef:
@ -367,7 +367,7 @@ cdef class Ctxpopup(LayoutClass):
:type: list of :py:class:`CtxpopupItem`
..versionadded:: 1.11
.. versionadded:: 1.11
"""
def __get__(self):
@ -381,7 +381,7 @@ cdef class Ctxpopup(LayoutClass):
:type: :py:class:`CtxpopupItem`
..versionadded:: 1.11
.. versionadded:: 1.11
"""
def __get__(self):
@ -395,7 +395,7 @@ cdef class Ctxpopup(LayoutClass):
:type: :py:class:`CtxpopupItem`
..versionadded:: 1.11
.. versionadded:: 1.11
"""
def __get__(self):

10
efl/elementary/datetime_elm.pyx
View File

@ -458,7 +458,8 @@ cdef class Datetime(Object):
There is no provision to set the limits of AM/PM field.
:param fieldtype: Type of the field. ELM_DATETIME_YEAR etc.
:param fieldtype: Type of the field.
:type fieldtype: :ref:`Elm_Datetime_Field_Type`
"""
cdef int min, max
@ -475,7 +476,8 @@ cdef class Datetime(Object):
There is no provision to set the limits of AM/PM field.
:param Elm_Datetime_Field_Type fieldtype: Type of the field. ELM_DATETIME_YEAR etc.
:param fieldtype: Type of the field.
:type fieldtype: :ref:`Elm_Datetime_Field_Type`
:param int min: Reference to field's minimum value
:param int max: Reference to field's maximum value
@ -537,7 +539,7 @@ cdef class Datetime(Object):
.. seealso:: :py:meth:`field_visible_set`
:param fieldtype: Type of the field. ELM_DATETIME_YEAR etc
:param fieldtype: Type of the field.
:type fieldtype: :ref:`Elm_Datetime_Field_Type`
:return: ``True``, if field can be visible. ``False`` otherwise.
:rtype: bool
@ -559,7 +561,7 @@ cdef class Datetime(Object):
.. seealso:: :py:meth:`field_visible_get`
:param fieldtype: Type of the field. ELM_DATETIME_YEAR etc.
:param fieldtype: Type of the field.
:type fieldtype: :ref:`Elm_Datetime_Field_Type`
:param visible: ``True`` field can be visible, ``False`` otherwise.
:type visible: bool

5
efl/elementary/diskselector.pyx
View File

@ -373,7 +373,7 @@ cdef class Diskselector(Object):
*args, **kwargs):
"""A constructor for :py:class:`DiskselectorItem`
:see: :py:func`DiskselectorItem.append_to`
:see: :func:`DiskselectorItem.append_to`
"""
cdef:
@ -456,7 +456,8 @@ cdef class Diskselector(Object):
def callback_clicked_add(self, func, *args, **kwargs):
"""This is called when a user clicks an item
:since 1.8"""
.. versionadded:: 1.8
"""
self._callback_add_full("clicked", _cb_object_item_conv, func, *args, **kwargs)
def callback_clicked_del(self, func):

35
efl/elementary/entry.pyx
View File

@ -66,15 +66,22 @@ even when writing new themes or extensions it's a good idea to stick to
a sane default, to maintain coherency and avoid application breakages.
Currently defined by the default theme are the following tags:
- <br>: Inserts a line break.
- <ps>: Inserts a paragraph separator. This is preferred over line
breaks.
- <tab>: Inserts a tab.
- <em>...</em>: Emphasis. Sets the *oblique* style for the
enclosed text.
- <b>...</b>: Sets the **bold** style for the enclosed text.
- <link>...</link>: Underlines the enclosed text.
- <hilight>...</hilight>: Highlights the enclosed text.
``<br>``
Inserts a line break.
``<ps>``
Inserts a paragraph separator. This is preferred over line
breaks.
``<tab>``
Inserts a tab.
``<em>...</em>``
Emphasis. Sets the *oblique* style for the
enclosed text.
``<b>...</b>``
Sets the **bold** style for the enclosed text.
``<link>...</link>``
Underlines the enclosed text.
``<hilight>...</hilight>``
Highlights the enclosed text.
Special markups
@ -99,8 +106,8 @@ used to identify the anchor and it can be any valid utf8 string.
When an anchor is clicked, an ``"anchor,clicked"`` signal is emitted with
an :py:class:`EntryAnchorInfo` in the ``event_info`` parameter for the
callback function. The same applies for "anchor,in" (mouse in),
"anchor,out" (mouse out), "anchor,down" (mouse down), and "anchor,up"
callback function. The same applies for ``anchor,in`` (mouse in),
``anchor,out`` (mouse out), ``anchor,down`` (mouse down), and ``anchor,up``
(mouse up) events on an anchor.
@ -108,7 +115,7 @@ Items
-----
Inlined in the text, any other :py:class:`~efl.elementary.object.Object` can
be inserted by using <item> tags this way::
be inserted by using ``<item>`` tags this way::
<item size=16x16 vsize=full href=emoticon/haha></item>
@ -130,13 +137,13 @@ Besides their size, items are specified a ``vsize`` value that affects
how their final size and position are calculated. The possible values
are:
- ascent: Item will be placed within the line's baseline and its
- ``ascent``: Item will be placed within the line's baseline and its
ascent. That is, the height between the line where all characters are
positioned and the highest point in the line. For ``size`` and
``absize`` items, the descent value will be added to the total line
height to make them fit. ``relsize`` items will be adjusted to fit
within this space.
- full: Items will be placed between the descent and ascent, or the
- ``full``: Items will be placed between the descent and ascent, or the
lowest point in the line and its highest.
After the size for an item is calculated, the entry will request an object to

7
efl/elementary/general.pyx
View File

@ -456,7 +456,7 @@ def exit():
.. note::
By using the appropriate #ELM_POLICY_QUIT on your Elementary
By using the appropriate :attr:`ELM_POLICY_QUIT` on your Elementary
applications, you'll be able to get this function called automatically
for you.
@ -468,7 +468,7 @@ def exit():
def policy_set(Elm_Policy policy, value):
"""Set new policy value.
This will emit the ecore event ELM_EVENT_POLICY_CHANGED in the main
This will emit the ecore event ``ELM_EVENT_POLICY_CHANGED`` in the main
loop giving the event information Elm_Event_Policy_Changed with
policy identifier, new and old values.
@ -485,6 +485,7 @@ def policy_set(Elm_Policy policy, value):
value might be enforced).
"""
# TODO: add a function for setting a callback for the event described above
return bool(elm_policy_set(policy, value))
def policy_get(Elm_Policy policy):
@ -508,7 +509,7 @@ def process_state_get():
likely should release resources and not wake up often or process much.
:return: The current process state
:rtype: Elm_Process_State
:rtype: :ref:`Elm_Process_State`
.. versionadded:: 1.12

72
efl/elementary/gengrid.pyx
View File

@ -103,20 +103,19 @@ multiple different items with different classes, states and styles).
Gengrid will call the functions in this struct (methods) when an item is
"realized" (i.e., created dynamically, while the user is scrolling the
grid). All objects will simply be deleted when no longer needed with
evas_object_del(). The #Elm_Gengrid_Item_Class structure contains the
following members:
:meth:`~efl.eo.Eo.delete`. The :class:`GengridItemClass` class contains the
following attributes and methods:
- ``item_style`` - This is a constant string and simply defines the name
of the item style. It **must** be specified and the default should be
``"default".``
``default``.
- ``func.text_get`` - This function is called when an item object is
actually created. The ``data`` parameter will point to the same data
passed to elm_gengrid_item_append() and related item creation
passed to :meth:`~Gengrid.item_append` and related item creation
functions. The ``obj`` parameter is the gengrid object itself, while
the ``part`` one is the name string of one of the existing text parts
in the Edje group implementing the item's theme. This function
**must** return a strdup'()ed string, as the caller will free() it
when done. See :py:meth:`GengridItem.text_get`.
in the Edje group implementing the item's theme.
See :py:meth:`GengridItemClass.text_get`.
- ``func.content_get`` - This function is called when an item object is
actually created. The ``data`` parameter will point to the same data
passed to :py:meth:`GengridItem.append_to` and related item creation
@ -125,7 +124,7 @@ following members:
swallow parts in the Edje group implementing the item's theme. It must
return ``None,`` when no content is desired, or a valid object handle,
otherwise. The object will be deleted by the gengrid on its deletion
or when the item is "unrealized". See :py:meth:`GengridItem.content_get`.
or when the item is "unrealized". See :py:meth:`GengridItemClass.content_get`.
- ``func.state_get`` - This function is called when an item object is
actually created. The ``data`` parameter will point to the same data
passed to :py:meth:`GengridItem.append_to` and related item creation
@ -136,49 +135,52 @@ following members:
its theming Edje object with ``"elm,state,xxx,active"`` and ``"elm"``
as "emission" and "source" arguments, respectively, when the state is
true (the default is false), where ``xxx`` is the name of the (state)
part. See #Elm_Gengrid_Item_State_Get_Cb.
- ``func.del`` - This is called when elm_object_item_del() is called on
an item or elm_gengrid_clear() is called on the gengrid. This is
part. See :py:meth:`GengridItemClass.state_get`.
- ``func.del`` - This is called when
:meth:`efl.elementary.object_item.ObjectItem.delete` is called on
an item or :meth:`~Gengrid.clear` is called on the gengrid. This is
intended for use when gengrid items are deleted, so any data attached
to the item (e.g. its data parameter on creation) can be deleted. See
:py:meth:`GengridItem.delete`.
:py:meth:`GengridItemClass.delete`.
Usage hints
===========
If the user wants to have multiple items selected at the same time,
elm_gengrid_multi_select_set() will permit it. If the gengrid is
single-selection only (the default), then elm_gengrid_select_item_get()
:attr:`~Gengrid.multi_select` will permit it. If the gengrid is
single-selection only (the default), then :attr:`~Gengrid.selected_item`
will return the selected item or ``None``, if none is selected. If the
gengrid is under multi-selection, then elm_gengrid_selected_items_get()
gengrid is under multi-selection, then :attr:`~Gengrid.selected_items`
will return a list (that is only valid as long as no items are modified
(added, deleted, selected or unselected) of child items on a gengrid.
If an item changes (internal (boolean) state, text or content changes),
then use elm_gengrid_item_update() to have gengrid update the item with
then use :meth:`~GengridItem.update` to have gengrid update the item with
the new state. A gengrid will re-"realize" the item, thus calling the
functions in the #Elm_Gengrid_Item_Class set for that item.
functions in the :class:`GengridItemClass` set for that item.
To programmatically (un)select an item, use
elm_gengrid_item_selected_set(). To get its selected state use
elm_gengrid_item_selected_get(). To make an item disabled (unable to be
selected and appear differently) use elm_object_item_disabled_set() to
set this and elm_object_item_disabled_get() to get the disabled state.
To programmatically (un)select an item or get the selected state, use
:attr:`GengridItem.selected`. To make an item disabled (unable to be
selected and appear differently) or get the disabled state
use :attr:`GengridItem.disabled`.
Grid cells will only have their selection smart callbacks called when
firstly getting selected. Any further clicks will do nothing, unless you
enable the "always select mode", with elm_gengrid_select_mode_set() as
ELM_OBJECT_SELECT_MODE_ALWAYS, thus making every click to issue
selection callbacks. elm_gengrid_select_mode_set() as
ELM_OBJECT_SELECT_MODE_NONE will turn off the ability to select items
enable the "always select mode", with :attr:`~Gengrid.select_mode` as
:attr:`ELM_OBJECT_SELECT_MODE_ALWAYS`, thus making every click to issue
selection callbacks. :attr:`~Gengrid.select_mode` as
:attr:`ELM_OBJECT_SELECT_MODE_NONE` will turn off the ability to select items
entirely in the widget and they will neither appear selected nor call
the selection smart callbacks.
Remember that you can create new styles and add your own theme
augmentation per application with elm_theme_extension_add(). If you
augmentation per application with
:meth:`Theme.extension_add<efl.elementary.theme.Theme.extension_add>`. If you
absolutely must have a specific style that overrides any theme the user
or system sets up you can use elm_theme_overlay_add() to add such a file.
or system sets up you can use
:meth:`Theme.extension_add<efl.elementary.theme.Theme.overlay_add>` to add such
a file.
Emitted signals
@ -199,11 +201,7 @@ Emitted signals
``event_info`` parameter is the gengrid item that was unselected.
- ``realized`` - This is called when the item in the gengrid
has its implementing Evas object instantiated, de facto.
``event_info`` is the gengrid item that was created. The object
may be deleted at any time, so it is highly advised to the
caller **not** to use the object returned from
:py:attr:`GengridItem.object`, because it may point to freed
objects.
``event_info`` is the gengrid item that was created.
- ``unrealized`` - This is called when the implementing Evas
object for this item is deleted. ``event_info`` is the gengrid
item that was deleted.
@ -241,20 +239,20 @@ Emitted signals
- ``edge,right`` - This is called when the gengrid is scrolled
until the right edge.
- ``moved`` - This is called when a gengrid item is moved by a user
interaction in a reorder mode. The %c event_info parameter is the item that
interaction in a reorder mode. The ``event_info`` parameter is the item that
was moved.
- ``index,update`` - This is called when a gengrid item index is changed.
Note that this callback is called while each item is being realized.
- ``highlighted`` - an item in the list is highlighted. This is called when
the user presses an item or keyboard selection is done so the item is
physically highlighted. The %c event_info parameter is the item that was
physically highlighted. The ``event_info`` parameter is the item that was
highlighted.
- ``unhighlighted`` - an item in the list is unhighlighted. This is called
when the user releases an item or keyboard selection is moved so the item
is physically unhighlighted. The %c event_info parameter is the item that
is physically unhighlighted. The ``event_info`` parameter is the item that
was unhighlighted.
- ``language,changed`` - This is called when the program's language is
changed. Call the elm_gengrid_realized_items_update() if items text should
changed. Call :meth:`~Gengrid.realized_items_update` if items text should
be translated.
- ``focused`` - When the gengrid has received focus. (since 1.8)
- ``unfocused`` - When the gengrid has lost focus. (since 1.8)

24
efl/elementary/gengrid_widget.pxi
View File

@ -73,11 +73,11 @@ cdef class Gengrid(Object):
return elm_gengrid_multi_select_mode_get(self.obj)
property horizontal:
"""When in "horizontal mode" (``True),`` items will be placed
"""When in "horizontal mode" (``True``), items will be placed
in **columns**, from top to bottom and, when the space for a
column is filled, another one is started on the right, thus
expanding the grid horizontally. When in "vertical mode"
(``False),`` though, items will be placed in **rows**, from left
(``False``), though, items will be placed in **rows**, from left
to right and, when the space for a row is filled, another one is
started below, thus expanding the grid vertically.
@ -245,7 +245,7 @@ cdef class Gengrid(Object):
property realized_items:
"""This returns a tuple of the realized items in the gengrid.
.. seealso:: :py:func:`realized_items_update()`
.. seealso:: :py:func:`realized_items_update`
:type: tuple of :py:class:`GengridItem`
@ -262,7 +262,7 @@ cdef class Gengrid(Object):
the original item data has changed and the changes are desired to be
reflected.
To update just one item, use elm_gengrid_item_update().
To update just one item, use :func:`GengridItem.update`
.. seealso:: :py:attr:`realized_items` :py:func:`GengridItem.update()`
@ -451,7 +451,7 @@ cdef class Gengrid(Object):
:type: :ref:`Elm_Gengrid_Reorder_Type`
.. versionadded:: 1.11
"""
def __set__(self, value):
elm_gengrid_reorder_type_set(self.obj, value)
@ -563,14 +563,14 @@ cdef class Gengrid(Object):
This returns the item at the given coordinates (which are canvas
relative, not object-relative). If an item is at that coordinate,
that item handle is returned, and if @p xposret is not NULL, the
that item handle is returned, and if ``xposret`` is not None, the
integer pointed to is set to a value of -1, 0 or 1, depending if
the coordinate is on the left portion of that item (-1), on the
middle section (0) or on the right part (1).
if @p yposret is not NULL, the
if ``yposret`` is not None, the
integer pointed to is set to a value of -1, 0 or 1, depending if
the coordinate is on the upper portion of that item (-1), on the
middle section (0) or on the lower part (1). If NULL is returned as
middle section (0) or on the lower part (1). If None is returned as
an item (no item found there), then posret may indicate -1 or 1
based if the coordinate is above or below all items respectively in
the gengrid.
@ -956,7 +956,7 @@ cdef class Gengrid(Object):
def callback_highlighted_add(self, func, *args, **kwargs):
"""an item in the list is highlighted. This is called when
the user presses an item or keyboard selection is done so the item is
physically highlighted. The %c event_info parameter is the item that was
physically highlighted. The ``event_info`` parameter is the item that was
highlighted."""
self._callback_add_full("highlighted", _cb_object_item_conv,
func, *args, **kwargs)
@ -967,7 +967,7 @@ cdef class Gengrid(Object):
def callback_unhighlighted_add(self, func, *args, **kwargs):
"""an item in the list is unhighlighted. This is called
when the user releases an item or keyboard selection is moved so the item
is physically unhighlighted. The %c event_info parameter is the item that
is physically unhighlighted. The ``event_info`` parameter is the item that
was unhighlighted."""
self._callback_add_full("unhighlighted", _cb_object_item_conv,
func, *args, **kwargs)
@ -977,8 +977,8 @@ cdef class Gengrid(Object):
def callback_language_changed_add(self, func, *args, **kwargs):
"""This is called when the program's language is
changed. Call the elm_gengrid_realized_items_update() if items text should
be translated."""
changed. Call :meth:`Gengrid.realized_items_update` if items text
should be translated."""
self.callback_add("language,changed", func, *args, **kwargs)
def callback_focused_add(self, func, *args, **kwargs):

28
efl/elementary/genlist.pyx
View File

@ -137,18 +137,18 @@ Editing and Navigating
Items can be added by several calls. All of them return a
:py:class:`GenlistItem` handle that is an internal member inside the genlist.
They all take a data parameter that is meant to be used for a handle to
the applications internal data (eg. the struct with the original item
data). The parent parameter is the parent genlist item this belongs to if
it is a tree or an indexed group, and None if there is no parent. The
flags can be a bitmask of #ELM_GENLIST_ITEM_NONE, #ELM_GENLIST_ITEM_TREE
and #ELM_GENLIST_ITEM_GROUP. If #ELM_GENLIST_ITEM_TREE is set then this
item is displayed as an item that is able to expand and have child items.
If #ELM_GENLIST_ITEM_GROUP is set then this item is group index item that
is displayed at the top until the next group comes. The func parameter is
a convenience callback that is called when the item is selected and the
data parameter will be the func_data parameter, ``obj`` be the genlist
object and event_info will be the genlist item.
They all take a data parameter that is meant to be used for a handle to the
applications internal data (eg. the struct with the original item data). The
parent parameter is the parent genlist item this belongs to if it is a tree or
an indexed group, and None if there is no parent. The flags can be a bitmask of
:attr:`ELM_GENLIST_ITEM_NONE`, :attr:`ELM_GENLIST_ITEM_TREE` and
:attr:`ELM_GENLIST_ITEM_GROUP`. If :attr:`ELM_GENLIST_ITEM_TREE` is set then
this item is displayed as an item that is able to expand and have child items.
If :attr:`ELM_GENLIST_ITEM_GROUP` is set then this item is group index item
that is displayed at the top until the next group comes. The func parameter is
a convenience callback that is called when the item is selected and the data
parameter will be the func_data parameter, ``obj`` be the genlist object and
event_info will be the genlist item.
:py:meth:`GenlistItem.append_to` adds an item to the end of the list, or if
there is a parent, to the end of all the child items of the parent.
@ -378,11 +378,11 @@ Emitted signals
is finished.
- ``highlighted`` - an item in the list is highlighted. This is called when
the user presses an item or keyboard selection is done so the item is
physically highlighted. The %c event_info parameter is the item that was
physically highlighted. The ``event_info`` parameter is the item that was
highlighted.
- ``unhighlighted`` - an item in the list is unhighlighted. This is called
when the user releases an item or keyboard selection is moved so the item
is physically unhighlighted. The %c event_info parameter is the item that
is physically unhighlighted. The ``event_info`` parameter is the item that
was unhighlighted.
- ``focused`` - When the genlist has received focus. (since 1.8)
- ``unfocused`` - When the genlist has lost focus. (since 1.8)

40
efl/elementary/gesture_layer.pyx
View File

@ -32,50 +32,50 @@ have to implement gesture detection, just set callbacks for gesture states.
In order to use Gesture Layer you start with instantiating this class
with a parent object parameter. Next 'activate' gesture layer with a
:py:meth:`GestureLayer.attach` call. Usually with same object as target (2nd
:py:meth:`~GestureLayer.attach` call. Usually with same object as target (2nd
parameter).
Now you need to tell gesture layer what gestures you follow. This is done with
:py:meth:`GestureLayer.cb_set` call. By setting the callback you actually saying
to gesture layer: I would like to know when the gesture ``Elm_Gesture_Type``
switches to state ``Elm_Gesture_State``.
:py:meth:`~GestureLayer.cb_set` call. By setting the callback you actually
saying to gesture layer: I would like to know when the gesture
:ref:`Elm_Gesture_Type` switches to state :ref:`Elm_Gesture_State`.
Next, you need to implement the actual action that follows the input in
your callback.
Note that if you like to stop being reported about a gesture, just set
all callbacks referring this gesture to None. (again with
:py:meth:`GestureLayer.cb_set`)
:py:meth:`~GestureLayer.cb_set`)
The information reported by gesture layer to your callback is depending
on ``Elm_Gesture_Type``:
on :ref:`Elm_Gesture_Type`:
- ``Elm_Gesture_Taps_Info`` is the info reported for tap gestures:
- :class:`GestureTapsInfo` is the info reported for tap gestures:
- ``ELM_GESTURE_N_TAPS``
- ``ELM_GESTURE_N_LONG_TAPS``
- ``ELM_GESTURE_N_DOUBLE_TAPS``
- ``ELM_GESTURE_N_TRIPLE_TAPS``
- :attr:`ELM_GESTURE_N_TAPS`
- :attr:`ELM_GESTURE_N_LONG_TAPS`
- :attr:`ELM_GESTURE_N_DOUBLE_TAPS`
- :attr:`ELM_GESTURE_N_TRIPLE_TAPS`
- ``Elm_Gesture_Momentum_Info`` is info reported for momentum gestures:
- :class:`GestureMomentumInfo` is info reported for momentum gestures:
- ``ELM_GESTURE_MOMENTUM``
- :attr:`ELM_GESTURE_MOMENTUM`
- ``Elm_Gesture_Line_Info`` is the info reported for line gestures
(this also contains ``Elm_Gesture_Momentum_Info`` internal structure):
- :class:`GestureLineInfo` is the info reported for line gestures
(this also contains :class:`GestureMomentumInfo` internal structure):
- ``ELM_GESTURE_N_LINES``
- ``ELM_GESTURE_N_FLICKS``
- :attr:`ELM_GESTURE_N_LINES`
- :attr:`ELM_GESTURE_N_FLICKS`
Note that we consider a flick as a line-gesture that should be completed
in flick-time-limit as defined in
:py:class:`~efl.elementary.configuration.Configuration`.
``Elm_Gesture_Zoom_Info`` is the info reported for ``ELM_GESTURE_ZOOM``
:class:`GestureZoomInfo` is the info reported for :attr:`ELM_GESTURE_ZOOM`
gesture.
``Elm_Gesture_Rotate_Info`` is the info reported for
``ELM_GESTURE_ROTATE`` gesture.
:class:`GestureRotateInfo` is the info reported for
:attr:`ELM_GESTURE_ROTATE` gesture.
Gesture Layer Tweaks:

10
efl/elementary/hover.pyx
View File

@ -197,12 +197,12 @@ cdef class Hover(LayoutClass):
Best is defined here as the location at which there is the most
available space.
If ELM_HOVER_AXIS_HORIZONTAL is chosen the returned position will
necessarily be along the horizontal axis("left" or "right"). If
ELM_HOVER_AXIS_VERTICAL is chosen the returned position will
If :attr:`ELM_HOVER_AXIS_HORIZONTAL` is chosen the returned position
will necessarily be along the horizontal axis("left" or "right"). If
:attr:`ELM_HOVER_AXIS_VERTICAL` is chosen the returned position will
necessarily be along the vertical axis("top" or "bottom"). Choosing
ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and
the returned position may be in either axis.
:attr:`ELM_HOVER_AXIS_BOTH` or :attr:`ELM_HOVER_AXIS_NONE` has the same
effect and the returned position may be in either axis.
.. seealso:: :py:meth:`~efl.elementary.object.Object.part_content_set`

4
efl/elementary/hoversel.pyx
View File

@ -189,7 +189,7 @@ cdef class HoverselItem(ObjectItem):
The icon can be loaded from the standard set, from an image file, or
from an edje file.
:type: (string file, string group, :ref:`Elm_Icon_Type` type)
:type: (string **file**, string **group**, :ref:`Elm_Icon_Type` **type**)
"""
def __set__(self, value):
@ -424,7 +424,7 @@ cdef class Hoversel(Button):
def callback_item_focused_add(self, func, *args, **kwargs):
"""When the hoversel item has received focus.
.. versionadded:: 1.10
"""

8
efl/elementary/image.pyx
View File

@ -240,8 +240,12 @@ cdef class Image(Object):
.. note:: Setting this will trigger the Edje file case based on the
extension of the ``file`` string (expects ``".edj"``, for this
case). If one wants to force this type of file independently of
the extension, :py:attr:`file_edje` must be used, instead.
case).
.. note:: If you use animated gif image and create multiple image
objects with one gif image file, you should set the ``group``
differently for each object, else image objects will share one evas
image cache entry and you will get unwanted frames.
:type: unicode **file** or (unicode **file**, unicode **group**)
:raise RuntimeError: when setting the file fails

49
efl/elementary/label.pyx
View File

@ -37,17 +37,22 @@ cut.
Available styles
================
- default - No animation
- marker - Centers the text in the label and makes it bold by default
- slide_long - The entire text appears from the right of the screen and
slides until it disappears in the left of the screen(reappearing on
the right again).
- slide_short - The text appears in the left of the label and slides to
the right to show the overflow. When all of the text has been shown
the position is reset.
- slide_bounce - The text appears in the left of the label and slides to
the right to show the overflow. When all of the text has been shown
the animation reverses, moving the text to the left.
``default``
No animation
``marker``
Centers the text in the label and makes it bold by default
``slide_long``
The entire text appears from the right of the screen and
slides until it disappears in the left of the screen(reappearing on
the right again).
``slide_short``
The text appears in the left of the label and slides to
the right to show the overflow. When all of the text has been shown
the position is reset.
``slide_bounce``
The text appears in the left of the label and slides to
the right to show the overflow. When all of the text has been shown
the animation reverses, moving the text to the left.
Custom themes can of course invent new markup tags and style them any way
they like.
@ -199,19 +204,20 @@ cdef class Label(LayoutClass):
def ellipsis_get(self):
return elm_label_ellipsis_get(self.obj)
# FIXME: Why was this commented out???
# property slide:
# """
#
#
# .. deprecated:: 1.8
# Use :py:attr:`slide_mode` instead.
#
#
# """
# def __get__(self):
# return self.slide_get()
#
#
# def __set__(self, slide):
# self.slide_set(True if slide else False)
#
#
# @DEPRECATED("1.8", "Use :py:attr:`slide_mode` instead.")
# def slide_set(self, bint slide):
# elm_label_slide_mode_set(self.obj, 2 if slide else 0)
@ -264,19 +270,6 @@ cdef class Label(LayoutClass):
def slide_speed_get(self):
return elm_label_slide_speed_get(self.obj)
# TODO: What the heck does this do?
# property slide_area_limit:
# """
# Slide only if the
# :type: bool
# .. versionadded:: 1.8
# """
# def __set__(self, bint limit):
# elm_label_slide_area_limit_set(self.obj, limit)
property slide_mode:
"""Change the slide mode of the label widget.

3
efl/elementary/layout.pyx
View File

@ -50,7 +50,6 @@ part description where they were added. There are 3 possible types of
parts where a child can be added:
Content (SWALLOW part)
Only one object can be added to the ``SWALLOW`` part (but you still can
have many ``SWALLOW`` parts and one object on each of them). Use the
``Object.content_set/get/unset`` functions to set, retrieve and unset
@ -70,7 +69,6 @@ Content (SWALLOW part)
changed, it will animate move if the part is moving, and so on.
Box (BOX part)
An Edje ``BOX`` part is very similar to the Elementary
:py:class:`~efl.elementary.box.Box` widget. It allows one to add objects to
the box and have them distributed along its area, accordingly to the
@ -94,7 +92,6 @@ Box (BOX part)
The Layout Box can be used through the ``box_`` set of functions.
Table (TABLE part)
Just like the *Box*, the Layout Table is very similar to the Elementary
:py:class:`~efl.elementary.table.Table` widget. It allows one to add objects
to the Table specifying the row and column where the object should be added,

2
efl/elementary/menu.pyx
View File

@ -357,7 +357,7 @@ cdef class Menu(Object):
def move(self, x, y):
"""Move the menu to a new position
Sets the top-left position of the menu to (``x``,``y``).
Sets the top-left position of the menu to (``x``, ``y``).
.. note:: ``x`` and ``y`` coordinates are relative to parent.

3
efl/elementary/need.pyx
View File

@ -76,7 +76,8 @@ def need_sys_notify():
@DEPRECATED("1.8", "Use :py:func:`need_eldbus` for eldbus (v2) support. Old API is deprecated.")
def need_e_dbus():
"""Request that your elementary application needs e_dbus
"""
Request that your elementary application needs e_dbus
This initializes the e_dbus library when called and if support exists
it returns True, otherwise returns False. This must be called

2
efl/elementary/photocam.pyx
View File

@ -376,7 +376,7 @@ cdef class Photocam(Object):
it. It is for inspection only, and hooking callbacks to. Nothing
else. It may be deleted at any time as well.
:type: evasImage
:type: :class:`efl.evas.Image`
"""
def __get__(self):

6
efl/elementary/slider.pyx
View File

@ -32,7 +32,7 @@ something within a range.
A slider can be horizontal or vertical. It can contain an Icon and has a
primary label as well as a units label (that is formatted with floating
point values and thus accepts a printf-style format string, like
"%1.2f units". There is also an indicator string that may be somewhere
``"%1.2f units"``. There is also an indicator string that may be somewhere
else (like on the slider itself) that also accepts a format string like
units. Label, Icon Unit and Indicator strings/objects are optional.
@ -150,7 +150,7 @@ cdef class Slider(LayoutClass):
value, so the label text can display up to 1 floating point value.
Note that this is optional.
Use a format string such as "%1.2f meters" for example, and it will
Use a format string such as ``"%1.2f meters"`` for example, and it will
display values like: "3.14 meters" for a value equal to 3.14159.
Default is unit label disabled.
@ -185,7 +185,7 @@ cdef class Slider(LayoutClass):
floating point value, so the label text can display up to 1 floating
point value. Note that this is optional.
Use a format string such as "%1.2f meters" for example, and it will
Use a format string such as ``"%1.2f meters"`` for example, and it will
display values like: "3.14 meters" for a value equal to 3.14159.
Default is indicator label disabled.

10
efl/elementary/spinner.pyx
View File

@ -31,11 +31,11 @@ numeric values using arrow buttons, or edit values directly, clicking
over it and typing the new value.
By default the spinner will not wrap and has a label
of "%.0f" (just showing the integer value of the double).
of ``"%.0f"`` (just showing the integer value of the double).
A spinner has a label that is formatted with floating
point values and thus accepts a printf-style format string, like
"%1.2f units".
``"%1.2f units"``.
It also allows specific values to be replaced by pre-defined labels.
@ -97,15 +97,15 @@ cdef class Spinner(LayoutClass):
property label_format:
"""The format string of the displayed label.
If set to ``None``, the format is set to "%.0f". If not it sets the
If set to ``None``, the format is set to ``"%.0f"``. If not it sets the
format string for the label text. The label text is provided a
floating point value, so the label text can display up to 1 floating
point value. Note that this is optional.
Use a format string such as "%1.2f meters" for example, and it will
Use a format string such as ``"%1.2f meters"`` for example, and it will
display values like: "3.14 meters" for a value equal to 3.14159.
Default is "%0.f".
Default is ``"%0.f"``.
:type: unicode

15
efl/elementary/systray.pyx
View File

@ -31,7 +31,7 @@ Category of the Status Notifier Item.
-------------------------------------
.. data:: ELM_SYSTRAY_CATEGORY_APP_STATUS
Indicators of application status
.. data:: ELM_SYSTRAY_CATEGORY_COMMUNICATIONS
@ -102,7 +102,7 @@ cdef class Systray(Object):
This is the class that actually implements the widget.
"""
def __init__(self, Eo parent not None, *args, **kwargs):
self._set_obj(eo_add(elm_systray_class_get(), parent.obj))
self._set_properties_from_keyword_args(kwargs)
@ -142,7 +142,7 @@ cdef class Systray(Object):
The category of the Status Notifier Item.
:type: string
:type: :ref:`Elm_Systray_Category`
"""
def __set__(self, Elm_Systray_Category value):
@ -193,9 +193,9 @@ cdef class Systray(Object):
return _ctouni(value)
property menu:
"""The object path of the D-Bus Menu to be shown when the Status Notifier Item is activated by the user.
"""The D-Bus Menu to be shown when the Status Notifier Item is activated by the user.
:type: Eo
:type: :class:`~efl.elementary.menu.Menu`
"""
def __set__(self, Eo value):
eo_do(self.obj, elm_obj_systray_menu_set(value.obj))
@ -245,7 +245,7 @@ cdef class Systray(Object):
property status:
"""The status of the Status Notifier Item.
:type: Elm_Systray_Status
:type: :ref:`Elm_Systray_Status`
"""
def __set__(self, Elm_Systray_Status value):
eo_do(self.obj, elm_obj_systray_status_set(value))
@ -325,7 +325,8 @@ cdef class Systray(Object):
"""Register this Status Notifier Item in the System Tray Watcher.
This function should only be called after the event
#ELM_EVENT_SYSTRAY_READY is emitted.
``ELM_EVENT_SYSTRAY_READY``, for which you can set a callback with
:func:`on_systray_ready`, is emitted.
"""
cdef Eina_Bool value = 0

2
efl/elementary/table.pyx
View File

@ -120,7 +120,7 @@ cdef class Table(Object):
Default value is (0.5, 0.5)
:type: (double, double)
:type: (float **horizontal**, float **vertical**)
.. versionadded:: 1.13

6
efl/elementary/thumb.pyx
View File

@ -271,7 +271,7 @@ cdef class Thumb(Object):
.. seealso:: :py:attr:`file`
:type: (string path, string eet_key)
:type: (string **path**, string **eet_key**)
"""
def __get__(self):
@ -351,7 +351,7 @@ cdef class Thumb(Object):
The size for the thumb object.
:type: (int tw, int th)
:type: (int **tw**, int **th**)
.. versionadded:: 1.8
@ -370,7 +370,7 @@ cdef class Thumb(Object):
Set the crop alignment for the thumb object.
:type: (double cropx, double cropy)
:type: (float **cropx**, float **cropy**)
.. versionadded:: 1.8

23
efl/elementary/toolbar.pyx
View File

@ -480,11 +480,11 @@ cdef class ToolbarItem(ObjectItem):
"""The priority of a toolbar item.
This is used only when the toolbar shrink mode is set to
ELM_TOOLBAR_SHRINK_MENU or ELM_TOOLBAR_SHRINK_HIDE. When space is
less than required, items with low priority will be removed from the
toolbar and added to a dynamically-created menu, while items with
higher priority will remain on the toolbar, with the same order they
were added.
:attr:`ELM_TOOLBAR_SHRINK_MENU` or :attr:`ELM_TOOLBAR_SHRINK_HIDE`.
When space is less than required, items with low priority will be
removed from the toolbar and added to a dynamically-created menu, while
items with higher priority will remain on the toolbar, with the same
order they were added.
:type: int
@ -807,7 +807,7 @@ cdef class Toolbar(LayoutClass):
"""Icon lookup order, for toolbar items' icons.
Icons added before calling this function will not be affected.
The default lookup order is ELM_ICON_LOOKUP_THEME_FDO.
The default lookup order is :attr:`ELM_ICON_LOOKUP_THEME_FDO`.
:type: :ref:`Elm_Toolbar_Icon_Lookup_Order`
@ -936,11 +936,11 @@ cdef class Toolbar(LayoutClass):
property shrink_mode:
"""The shrink state of toolbar.
The toolbar won't scroll if ELM_TOOLBAR_SHRINK_NONE, but will
The toolbar won't scroll if :attr:`ELM_TOOLBAR_SHRINK_NONE`, but will
enforce a minimum size so all the items will fit, won't scroll and
won't show the items that don't fit if ELM_TOOLBAR_SHRINK_HIDE, will
scroll if ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to pop
up excess elements with ELM_TOOLBAR_SHRINK_MENU.
won't show the items that don't fit if :attr:`ELM_TOOLBAR_SHRINK_HIDE`,
will scroll if :attr:`ELM_TOOLBAR_SHRINK_SCROLL`, and will create a
button to pop up excess elements with :attr:`ELM_TOOLBAR_SHRINK_MENU`.
:type: :ref:`Elm_Toolbar_Shrink_Mode`
@ -963,7 +963,8 @@ cdef class Toolbar(LayoutClass):
This will expand the transverse length of the item according the
transverse length of the toolbar. The default is what the transverse
length of the item is set according its min value (this property is False).
length of the item is set according its min value (this property is
False).
.. versionadded:: 1.8

8
efl/elementary/video.pyx
View File

@ -77,9 +77,9 @@ cdef class Video(LayoutClass):
Setting this property will explicitly define a file or URI as a source
for the video of the Elm_Video object.
Local files can be specified using file:// or by using full file
paths. URI could be remote source of video, like http:// or
local source like WebCam (v4l2://). (You can use Emotion API to
Local files can be specified using ``file://`` or by using full file
paths. URI could be remote source of video, like ``http://`` or
local source like WebCam (``v4l2://``). (You can use Emotion API to
request and list the available Webcam on your system).
:type: string
@ -105,7 +105,7 @@ cdef class Video(LayoutClass):
property emotion:
"""The underlying Emotion object.
:type: emotion.Object
:type: :class:`efl.emotion.Object`
"""
def __get__(self):

42
efl/elementary/window.pyx
View File

@ -44,19 +44,30 @@ to indicate if you want accelerations and which kind to use. see
:py:attr:`~efl.elementary.configuration.Configuration.accel_preference` for
details on this environment variable values.
- ``x11, x, software-x11, software_x11`` Software rendering in X11
- ``gl, opengl, opengl-x11, opengl_x11`` OpenGL or OpenGL-ES2 rendering in X11
- ``shot:...`` Virtual screenshot renderer - renders to output file and exits
- ``fb, software-fb, software_fb`` Linux framebuffer direct software rendering
- ``sdl, software-sdl, software_sdl`` SDL software rendering to SDL buffer
- ``gl-sdl, gl_sdl, opengl-sdl, opengl_sdl`` OpenGL or OpenGL-ES2 using SDL
- ``gdi, software-gdi, software_gdi`` Windows WIN32 rendering via GDI with
software
- ``ews`` rendering to EWS (Ecore + Evas Single Process Windowing System)
- ``gl-cocoa, gl_cocoa, opengl-cocoa, opengl_cocoa`` OpenGL rendering in Cocoa
- ``wayland_shm`` Wayland client SHM rendering
- ``wayland_egl`` Wayland client OpenGL/EGL rendering
- ``drm`` Linux drm/kms etc. direct display
``x11``, ``x``, ``software-x11``, ``software_x11``
Software rendering in X11
``gl``, ``opengl``, ``opengl-x11``, ``opengl_x11``
OpenGL or OpenGL-ES2 rendering in X11
``shot:...``
Virtual screenshot renderer - renders to output file and exits
``fb``, ``software-fb``, ``software_fb``
Linux framebuffer direct software rendering
``sdl``, ``software-sdl``, ``software_sdl``
SDL software rendering to SDL buffer
``gl-sdl``, ``gl_sdl``, ``opengl-sdl``, ``opengl_sdl``
OpenGL or OpenGL-ES2 using SDL
``gdi``, ``software-gdi``, ``software_gdi``
Windows WIN32 rendering via GDI with software
``ews``
rendering to EWS (Ecore + Evas Single Process Windowing System)
``gl-cocoa``, ``gl_cocoa``, ``opengl-cocoa``, ``opengl_cocoa``
OpenGL rendering in Cocoa
``wayland_shm``
Wayland client SHM rendering
``wayland_egl``
Wayland client OpenGL/EGL rendering
``drm``
Linux drm/kms etc. direct display
All engines use a simple string to select the engine to render, EXCEPT
the "shot" engine. This actually encodes the output of the virtual
@ -423,7 +434,7 @@ cdef class Window(Object):
:py:attr:`~efl.evas.Object.size_hint_weight` set to EVAS_HINT_EXPAND.
Also notice that the window can get resized to the current size of the
object if the EVAS_HINT_EXPAND is set **after** the call to
object if the :attr:`EVAS_HINT_EXPAND` is set **after** the call to
resize_object_add(). So if the object should get resized to the
size of the window, set this hint **before** adding it as a resize object
(this happens because the size of the window and the object are evaluated
@ -469,11 +480,12 @@ cdef class Window(Object):
def title_get(self):
return _ctouni(elm_win_title_get(self.obj))
# TODO: Add a property for this and move docs there
def type_get(self):
"""Get the type of a window.
:return: The type of the window
:return type: Elm_Win_Type
:return type: :ref:`Elm_Win_Type`
.. versionadded: 1.9