Documentation: Fixed invalid references and other misc. issues.

This commit is contained in:
Kai Huuhko 2013-12-03 21:56:47 +02:00
parent b6e9552735
commit 4c9ab89426
53 changed files with 252 additions and 182 deletions

View File

@ -122,6 +122,8 @@ pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# Setting this True will show missing references as warnings.
#nitpicky = True
# -- Options for HTML output ---------------------------------------------------

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.ecore
:class:`efl.ecore.Animator` Class
=================================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.ecore
:class:`efl.ecore.Exe` Class
==============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.ecore
:class:`efl.ecore.FdHandler` Class
==================================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.ecore
:class:`efl.ecore.FileDownload` Class
=====================================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.ecore
:class:`efl.ecore.FileMonitor` Class
=====================================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.ecore
:class:`efl.ecore.IdleEnterer` Class
====================================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.ecore
:class:`efl.ecore.IdleExiter` Class
===================================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.ecore
:class:`efl.ecore.Idler` Class
==============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.ecore
:class:`efl.ecore.Poller` Class
===============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.ecore
:class:`efl.ecore.Timer` Class
==============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.edje
:class:`efl.edje.Edje` Class
==============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.emotion
:class:`efl.emotion.Emotion` Class
==================================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Canvas` Class
==============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Grid` Class
============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Map` Class
============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Box` Class
===========================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Image` Class
=============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Line` Class
============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Polygon` Class
===============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Rectangle` Class
=================================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.SmartObject` Class
===================================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Text` Class
============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Textblock` Class
=================================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Object` Class
==============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Rect` Class
============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Table` Class
=============================

View File

@ -1,3 +1,5 @@
.. currentmodule:: efl.evas
:class:`efl.evas.Textgrid` Class
================================

View File

@ -181,7 +181,7 @@ cdef class Exe(object):
*flags*, that will make Ecore monitor process' stdout and stderr,
emitting events on main loop.
To write use :py:func:`send`. To read listen to ``ECORE_EXE_EVENT_DATA``
To write use :py:meth:`send`. To read listen to ``ECORE_EXE_EVENT_DATA``
or ``ECORE_EXE_EVENT_ERROR`` events (see below). Ecore may
buffer read and error data until a newline character if asked for
with the *flags*. All data will be included in the events
@ -382,14 +382,14 @@ cdef class Exe(object):
by this function, this just stops monitoring the stdout/stderr
and emitting related events.
To finish the process call ``terminate()`` or ``kill()``.
To finish the process call :py:meth:`terminate` or :py:meth:`kill`.
"""
if self.exe == NULL:
raise ValueError("%s already deleted" % self.__class__.__name__)
ecore_exe_free(self.exe)
def free(self):
"Alias for ``delete()`` to keep compatibility with C-api."
"Alias for :py:meth:`delete` to keep compatibility with C-api."
self.delete()
def send(self, buf, long size=0):
@ -574,7 +574,7 @@ cdef class Exe(object):
def pause(self):
"""Send pause signal (SIGSTOP) to executed process.
In order to resume application execution, use :py:func:`continue_()`
In order to resume application execution, use :py:meth:`continue_`
"""
ecore_exe_pause(self.exe)
@ -585,7 +585,7 @@ cdef class Exe(object):
def continue_(self):
"""Send contine signal (SIGCONT) to executed process.
This resumes application previously paused with :py:func:`pause`
This resumes application previously paused with :py:meth:`pause`
"""
ecore_exe_continue(self.exe)

View File

@ -30,26 +30,26 @@ that defines the details of this arrangement.
By default, the box will use an internal function to set the layout to
a single row, either vertical or horizontal. This layout is affected
by a number of parameters, such as the homogeneous flag set by
:py:attr:`homogeneous`, the values given by :py:attr:`padding` and
:py:attr:`align` and the hints set to each object in the box.
:py:attr:`~Box.homogeneous`, the values given by :py:attr:`~Box.padding` and
:py:attr:`~Box.align` and the hints set to each object in the box.
For this default layout, it's possible to change the orientation with
:py:attr:`horizontal`. The box will start in the vertical orientation,
:py:attr:`~Box.horizontal`. The box will start in the vertical orientation,
placing its elements ordered from top to bottom. When horizontal is set,
the order will go from left to right. If the box is set to be
homogeneous, every object in it will be assigned the same space, that
of the largest object. Padding can be used to set some spacing between
the cell given to each object. The alignment of the box, set with
:py:attr:`align`, determines how the bounding box of all the elements
:py:attr:`~Box.align`, determines how the bounding box of all the elements
will be placed within the space given to the box widget itself.
The size hints of each object also affect how they are placed and sized
within the box. :py:attr:`size_hint_min` will give the minimum
within the box. :py:attr:`~efl.evas.Object.size_hint_min` will give the minimum
size the object can have, and the box will use it as the basis for all
latter calculations. Elementary widgets set their own minimum size as
needed, so there's rarely any need to use it manually.
:py:attr:`size_hint_weight`, when not in homogeneous mode, is
:py:attr:`~efl.evas.Object.size_hint_weight`, when not in homogeneous mode, is
used to tell whether the object will be allocated the minimum size it
needs or if the space given to it should be expanded. It's important
to realize that expanding the size given to the object is not the same
@ -61,7 +61,7 @@ not be expanded. To take as much space possible, set the weight to
Besides how much space each object is allocated, it's possible to control
how the widget will be placed within that space using
:py:attr:`size_hint_align`. By default, this value will be 0.5
:py:attr:`~efl.evas.Object.size_hint_align`. By default, this value will be 0.5
for both axis, meaning the object will be centered, but any value from
0.0 (left or top, for the ``x`` and ``y`` axis, respectively) to 1.0
(right or bottom) can be used. The special value *EVAS_HINT_FILL*, which
@ -72,7 +72,7 @@ In addition, customized functions to define the layout can be set, which
allow the application developer to organize the objects within the box
in any number of ways.
The special :py:func:`layout_transition()` function can be used
The special :py:meth:`Box.layout_transition` function can be used
to switch from one layout to another, animating the motion of the
children of the box.
@ -184,7 +184,7 @@ cdef class Box(Object):
"""By default, the box will be in vertical mode and non-homogeneous.
:param parent: The parent object
:type parent: :py:class:`efl.elementary.object.Object`
:type parent: :py:class:`~efl.elementary.object.Object`
:return: The new object or None if it cannot be created
:rtype: :py:class:`Box`
@ -248,7 +248,7 @@ cdef class Box(Object):
respectively.
:param subobj: The object to add to the box
:type subobj: :py:class:`Object <efl.evas.Object>`
:type subobj: :py:class:`~efl.evas.Object`
"""
elm_box_pack_start(self.obj, obj.obj)
@ -265,7 +265,7 @@ cdef class Box(Object):
respectively.
:param subobj: The object to add to the box
:type subobj: :py:class:`Object <efl.evas.Object>`
:type subobj: :py:class:`~efl.evas.Object`
"""
elm_box_pack_end(self.obj, obj.obj)
@ -281,9 +281,9 @@ cdef class Box(Object):
above it depending on orientation.
:param subobj: The object to add to the box
:type subobj: :py:class:`Object <efl.evas.Object>`
:type subobj: :py:class:`~efl.evas.Object`
:param before: The object before which to add it
:type before: :py:class:`Object <efl.evas.Object>`
:type before: :py:class:`~efl.evas.Object`
"""
elm_box_pack_before(self.obj, obj.obj, before.obj)
@ -299,9 +299,9 @@ cdef class Box(Object):
below it depending on orientation.
:param subobj: The object to add to the box
:type subobj: :py:class:`Object <efl.evas.Object>`
:type subobj: :py:class:`~efl.evas.Object`
:param after: The object after which to add it
:type after: :py:class:`Object <efl.evas.Object>`
:type after: :py:class:`~efl.evas.Object`
"""
elm_box_pack_after(self.obj, obj.obj, after.obj)
@ -326,7 +326,7 @@ cdef class Box(Object):
deleting it.
:param subobj: The object to unpack
:type subobj: :py:class:`Object <efl.evas.Object>`
:type subobj: :py:class:`~efl.evas.Object`
"""
elm_box_unpack(self.obj, obj.obj)
@ -352,7 +352,7 @@ cdef class Box(Object):
<efl.evas.Object>`. The order of the list corresponds to the
packing order the box uses.
:type: list of :py:class:`Objects <efl.evas.Object>`
:type: list of :py:class:`~efl.evas.Object`
"""
def __get__(self):

View File

@ -27,7 +27,7 @@ This is a push-button. Press it and run some function. It can contain
a simple label and icon object and it also has an autorepeat feature.
This widget emits the following signals, besides the ones sent from
:py:class:`elementary.layout.Layout`:
:py:class:`~efl.elementary.layout_class.LayoutClass`:
- ``clicked``: the user clicked the button (press/release).
- ``repeated``: the user pressed the button without releasing it.
@ -43,14 +43,14 @@ available:
- anchor: Like default, but the button fades away when the mouse is not
over it, leaving only the text or icon.
- hoversel_vertical: Internally used by
:py:class:`elementary.hoversel.Hoversel` to give a continuous look
:py:class:`~efl.elementary.hoversel.Hoversel` to give a continuous look
across its options.
- hoversel_vertical_entry: Another internal for
:py:class:`elementary.hoversel.Hoversel`.
:py:class:`~efl.elementary.hoversel.Hoversel`.
- naviframe: Internally used by
:py:class:`elementary.naviframe.Naviframe` for its back button.
:py:class:`~efl.elementary.naviframe.Naviframe` for its back button.
- colorselector: Internally used by
:py:class:`elementary.colorselector.Colorselector` for its left and
:py:class:`~efl.elementary.colorselector.Colorselector` for its left and
right buttons.
Default content parts of the button widget that you can use for are:

View File

@ -250,7 +250,7 @@ cdef class CalendarMark(object):
:type mark_time: datetime.date
:param repeat: Repeat the event following this periodicity. Can be a unique
mark (that don't repeat), daily, weekly, monthly or annually.
:type repeat: :ref:Elm_Calendar_Mark_Repeat_Type`
:type repeat: :ref:`Elm_Calendar_Mark_Repeat_Type`
:return: The created mark or ``None`` upon failure.
:rtype: :py:class:`CalendarMark`
@ -274,10 +274,10 @@ cdef class CalendarMark(object):
Delete a mark from the calendar.
If deleting all calendar marks is required, :py:func:`marks_clear()`
If deleting all calendar marks is required, ``del`` :py:attr:`marks`
should be used instead of getting marks list and deleting each one.
.. seealso:: :py:func:`mark_add()`
.. seealso:: :py:meth:`Calendar.mark_add`
:param mark: The mark to be deleted.
:type mark: :py:class:`CalendarMark`
@ -430,7 +430,7 @@ cdef class Calendar(LayoutClass):
:type mark_time: datetime.date
:param repeat: Repeat the event following this periodicity. Can be a unique
mark (that don't repeat), daily, weekly, monthly or annually.
:type repeat: :ref:`Calendar repeat type <Elm_Calendar_Mark_Repeat_Type>`
:type repeat: :ref:`Elm_Calendar_Mark_Repeat_Type`
:return: The created mark or ``None`` upon failure.
:rtype: :py:class:`CalendarMark`
@ -476,10 +476,7 @@ cdef class Calendar(LayoutClass):
When the month is changed, i.e. user selects next or previous month,
marks will be drawn.
.. seealso::
:py:func:`mark_add()`
:py:func:`mark_del()`
:py:func:`marks_clear()`
:seealso: :py:class:`CalendarMark`
"""
elm_calendar_marks_draw(self.obj)

View File

@ -28,11 +28,10 @@ The check widget allows for toggling a value between true and false.
Check objects are a lot like radio objects in layout and functionality,
except they do not work as a group, but independently, and only toggle
the value of a boolean between false and true. :py:attr:`state` sets the
boolean state and :py:attr:`state` returns the current state.
the value of a boolean :py:attr:`~Check.state` between false and true.
This widget emits the following signals, besides the ones sent from
:py:class:`efl.elementary.layout_class.LayoutClass`:
:py:class:`~efl.elementary.layout_class.LayoutClass`:
- ``changed`` - This is called whenever the user changes the state of
the check objects.

View File

@ -50,7 +50,7 @@ The time display is, by default, in military mode (24h), but an am/pm
indicator may be optionally shown, too, when it will switch to 12h.
This widget emits the following signals, besides the ones sent from
:py:class:`elementary.layout.Layout`:
:py:class:`~efl.elementary.layout_class.LayoutClass`:
- ``changed`` - the clock's user changed the time
- ``focused`` - When the clock has received focus. (since 1.8)

View File

@ -32,7 +32,7 @@ The colors can be picked by user from the color set by clicking on
individual color item on the palette or by selecting it from selector.
This widget emits the following signals, besides the ones sent from
:py:class:`elementary.layout.Layout`:
:py:class:`~efl.elementary.layout_class.LayoutClass`:
- ``"changed"`` - When the color value changes on selector
- ``"color,item,selected"`` - When user clicks on color item.
@ -87,10 +87,10 @@ def _cb_object_item_conv(long addr):
cdef class ColorselectorPaletteItem(ObjectItem):
cdef int r, g, b, a
"""An item for the :py:class:`Colorselector` widget."""
cdef int r, g, b, a
def __init__(self, int r, int g, int b, int a, *args, **kwargs):
self.r, self.g, self.b, self.a = r, g, b, a
self.args, self.kwargs = args, kwargs

View File

@ -622,20 +622,21 @@ cdef class Configuration(object):
ret.append((_ctouni(text_class), _ctouni(font), size))
lst = lst.next
return ret
# TODO: Free the list?
# TODO: ElmFontOverlay class?
def font_overlay_set(self, text_class, font, size):
"""font_overlay_set(unicode text_class, unicode font, int size)
Set a font overlay for a given Elementary text class.
*font* has to be in the format returned by font_fontconfig_name_get().
*font* has to be in the format returned by
:py:func:`efl.elementary.general.font_fontconfig_name_get`.
.. seealso::
:py:attr:`font_overlay_list`
:py:func:`font_overlay_unset()`
:py:func:`edje_object_text_class_set()`
:py:func:`font_overlay_unset`
:py:func:`efl.edje.Edje.text_class_set`
:param text_class: Text class name
:type text_class: string
@ -727,7 +728,7 @@ cdef class Configuration(object):
property cache_flush_interval:
"""The globally configured cache flush interval time, in ticks
.. seealso:: :py:func:`cache_all_flush()`
.. seealso:: :py:func:`efl.elementary.general.cache_all_flush`
.. note:: The ``size`` must be greater than 0. if not, the cache flush
will be ignored.
@ -752,7 +753,7 @@ cdef class Configuration(object):
be re-loaded as it is idle and not rendering or doing anything
graphically right now.
.. seealso:: :py:func:`cache_all_flush()`
.. seealso:: :py:func:`efl.elementary.general.cache_all_flush`
:type: bool
@ -829,7 +830,7 @@ cdef class Configuration(object):
Note that it will take effect only to Elementary windows created after
this is set.
.. seealso:: :py:class:`elementary.window.Window`
.. seealso:: :py:class:`~efl.elementary.window.Window`
:type: bool

View File

@ -54,7 +54,9 @@ Default text parts of the ctxpopup items that you can use for are:
- "default" - Title label in the title area
.. note:: Ctxpopup is a specialization of :py:class:`elementary.hover.Hover`.
.. note::
Ctxpopup is a specialization of :py:class:`~efl.elementary.hover.Hover`.
Enumerations
@ -106,6 +108,8 @@ ELM_CTXPOPUP_DIRECTION_UNKNOWN = enums.ELM_CTXPOPUP_DIRECTION_UNKNOWN
cdef class CtxpopupItem(ObjectItem):
"""An item for Ctxpopup widget."""
cdef:
bytes label
evasObject icon
@ -140,7 +144,7 @@ cdef class CtxpopupItem(ObjectItem):
self.kwargs = kargs
def append_to(self, evasObject ctxpopup):
"""item_append(unicode label, evas.Object icon, func, *args, **kwargs) -> CtxpopupItem
"""append_to(Object ctxpopup) -> CtxpopupItem
Add a new item to a ctxpopup object.
@ -148,7 +152,7 @@ cdef class CtxpopupItem(ObjectItem):
same time. When an item is added, any previous content will be
removed.
.. seealso:: :py:attr:`elementary.object.Object.content`
.. seealso:: :py:attr:`~efl.elementary.object.Object.content`
:param ctxpopup: The Ctxpopup widget this item is to be appended on
:type ctxpopup: :py:class:`Ctxpopup`
@ -186,7 +190,7 @@ cdef class Ctxpopup(LayoutClass):
property hover_parent:
"""Ctxpopup hover's parent
:type: :py:class:`evas.object.Object`
:type: :py:class:`~efl.evas.Object`
"""
def __get__(self):

View File

@ -205,7 +205,7 @@ To enable a module, set the ELM_MODULES environment variable as shown:
**export ELM_MODULES="datetime_input_ctxpopup>datetime/api"**
This widget emits the following signals, besides the ones sent from
:py:class:`elementary.layout.Layout`:
:py:class:`~efl.elementary.layout_class.LayoutClass`:
- ``changed`` - whenever Datetime field value is changed, this
signal is sent.
@ -544,7 +544,7 @@ cdef class Datetime(Object):
Whether a field can be visible/not
.. seealso:: :py:func:`field_visible_set()`
.. seealso:: :py:meth:`field_visible_set`
:param fieldtype: Type of the field. ELM_DATETIME_YEAR etc
:type fieldtype: :ref:`Elm_Datetime_Field_Type`
@ -568,7 +568,7 @@ cdef class Datetime(Object):
By default the field visibility is set to True.
.. seealso:: :py:func:`field_visible_get()`
.. seealso:: :py:meth:`field_visible_get`
:param fieldtype: Type of the field. ELM_DATETIME_YEAR etc.
:type fieldtype: :ref:`Elm_Datetime_Field_Type`

View File

@ -32,10 +32,11 @@ Dayselector also provides the functionality to check whether a day is
selected or not.
First day of the week is taken from config settings by default. It can be
altered by using the API :py:attr:`week_start` API.
altered by using the API :py:attr:`~Dayselector.week_start` API.
APIs are provided for setting the duration of weekend
:py:attr:`weekend_start` and :py:attr:`weekend_length` does this job.
:py:attr:`~Dayselector.weekend_start` and :py:attr:`~Dayselector.weekend_length`
does this job.
Two styles of weekdays and weekends are supported in Dayselector.
Application can emit signals on individual check objects for setting the
@ -49,9 +50,9 @@ responsibility to set the styles again by sending corresponding signals.
"day6" indicates the Saturday part name.
Application can change individual day display string by using the API
:py:func:`elementary.object.Object.part_text_set()`.
:py:meth:`efl.elementary.object.Object.part_text_set`.
:py:func:`elementary.object.Object.part_content_set()` API sets the
:py:meth:`efl.elementary.object.Object.part_content_set` API sets the
individual day object only if the passed one is a Check widget.
Check object representing a day can be set/get by the application by using
@ -59,7 +60,7 @@ the elm_object_part_content_set/get APIs thus providing a way to handle
the different check styles for individual days.
This widget emits the following signals, besides the ones sent from
:py:class:`elementary.layout.Layout`:
:py:class:`efl.elementary.layout_class.LayoutClass`:
- ``"dayselector,changed"`` - when the user changes the state of a day.
- ``"language,changed"`` - the program's language changed
@ -202,8 +203,8 @@ cdef class Dayselector(LayoutClass):
.. warning:: It must have 7 elements, or it will access invalid memory.
By default or if set to None, weekdays abbreviations get from system are displayed:
E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
By default or if set to None, weekdays abbreviations get from system are
displayed: E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
The first string should be related to Sunday, the second to Monday...

View File

@ -62,7 +62,7 @@ This widget supports the scrollable interface.
If you wish to control the scolling behaviour using these functions,
inherit both the widget class and the
:py:class:`Scrollable<efl.elementary.scroller.Scrollable>` class
:py:class:`~efl.elementary.scroller.Scrollable` class
using multiple inheritance, for example::
class ScrollableGenlist(Genlist, Scrollable):
@ -101,7 +101,7 @@ cdef class DiskselectorItem(ObjectItem):
to the right.
Items created with this method can be deleted with
:py:func:`elementary.object_item.ObjectItem.delete()`.
:py:meth:`~efl.elementary.object_item.ObjectItem.delete`.
If a function is passed as argument, it will be called every time
this item is selected, i.e., the user stops the diskselector with
@ -134,8 +134,8 @@ cdef class DiskselectorItem(ObjectItem):
:type label: string
:param icon: The icon object to use at left side of the item. An
icon can be any Evas object, but usually it is an
:py:class:`elementary.icon.Icon`.
:type icon: :py:class:`evas.object.Object`
:py:class:`~efl.elementary.icon.Icon`.
:type icon: :py:class:`~efl.evas.Object`
:param func: The function to call when the item is selected.
:type func: function
@ -233,7 +233,7 @@ cdef class DiskselectorItem(ObjectItem):
just after ``item`` and that wasn't deleted.
If it is the last item, ``None`` will be returned.
Last item can be get by elm_diskselector_last_item_get().
Last item can be get by :py:attr:`Diskselector.last_item`.
.. seealso::
:py:func:`Diskselector.item_append()`
@ -326,8 +326,8 @@ cdef class Diskselector(Object):
Remove all diskselector's items.
.. seealso::
:py:func:`elementary.object_item.ObjectItem.delete()`
:py:func:`item_append()`
:py:meth:`~efl.elementary.object_item.ObjectItem.delete()`
:py:meth:`item_append`
"""
elm_diskselector_clear(self.obj)
@ -336,9 +336,9 @@ cdef class Diskselector(Object):
"""Get a list of all the diskselector items.
.. seealso::
:py:func:`item_append()`
:py:func:`elementary.object_item.ObjectItem.delete()`
:py:func:`clear()`
:py:meth:`item_append`
:py:meth:`~efl.elementary.object_item.ObjectItem.delete()`
:py:meth:`clear`
:type: list of :py:class:`DiskselectorItem`
@ -403,7 +403,7 @@ cdef class Diskselector(Object):
The list of items follows append order. So it will return the first
item appended to the widget that wasn't deleted.
.. seealso:: :py:func:`item_append()` :py:attr:`items`
.. seealso:: :py:func:`item_append` :py:attr:`items`
:type: :py:class:`DiskselectorItem`
@ -417,7 +417,7 @@ cdef class Diskselector(Object):
The list of items follows append order. So it will return last first
item appended to the widget that wasn't deleted.
.. seealso:: :py:func:`item_append()` :py:attr:`items`
.. seealso:: :py:func:`item_append` :py:attr:`items`
:type: :py:class:`DiskselectorItem`

View File

@ -24,7 +24,7 @@ Widget description
------------------
This is a button that, when clicked, creates an Elementary window (or
inner window) with a :py:class:`elementary.fileselector.Fileselector`
inner window) with a :py:class:`~efl.elementary.fileselector.Fileselector`
within.
When a file is chosen, the (inner) window is closed and the button emits
@ -42,7 +42,7 @@ The following styles are available for this button:
- ``"hoversel_vertical_entry"``
This widget emits the following signals, besides the ones sent from
:py:class:`elementary.button.Button`:
:py:class:`~efl.elementary.button.Button`:
- ``"file,chosen"`` - the user has selected a path which comes as the
``event_info`` data
@ -166,7 +166,8 @@ cdef class FileselectorButton(Button):
"""Enable/disable a tree view in the given file selector button
widget's internal file selector
This has the same effect as :py:attr:`Fileselector.expandable`,
This has the same effect as
:py:attr:`efl.elementary.fileselector.Fileselector.expandable`,
but now applied to a file selector button's internal file
selector.
@ -193,7 +194,8 @@ cdef class FileselectorButton(Button):
selector is to display folders only or the directory contents,
as well.
This has the same effect as :py:attr:`Fileselector.folder_only`,
This has the same effect as
:py:attr:`efl.elementary.fileselector.Fileselector.folder_only`,
but now applied to a file selector button's internal file
selector.
@ -216,7 +218,8 @@ cdef class FileselectorButton(Button):
in a name for a file, in a given file selector button widget's
internal file selector.
This has the same effect as :py:attr:`Fileselector.is_save`,
This has the same effect as
:py:attr:`efl.elementary.fileselector.Fileselector.is_save`,
but now applied to a file selector button's internal file
selector.
@ -239,7 +242,8 @@ cdef class FileselectorButton(Button):
selector will raise an Elementary "inner window", instead of a
dedicated Elementary window. By default, it won't.
.. seealso:: :py:class:`elementary.innerwindow.InnerWindow` for more
.. seealso::
:py:class:`~efl.elementary.innerwindow.InnerWindow` for more
information on inner windows
:type: bool

View File

@ -181,7 +181,8 @@ cdef class FileselectorEntry(Object):
"""Enable/disable a tree view in the given file selector entry
widget's internal file selector
This has the same effect as :py:attr:`Fileselector.expandable`,
This has the same effect as
:py:attr:`efl.elementary.fileselector.Fileselector.expandable`,
but now applied to a file selector entry's internal file
selector.
@ -208,7 +209,8 @@ cdef class FileselectorEntry(Object):
selector is to display folders only or the directory contents,
as well.
This has the same effect as :py:attr:`Fileselector.folder_only`,
This has the same effect as
:py:attr:`efl.elementary.fileselector.Fileselector.folder_only`,
but now applied to a file selector entry's internal file
selector.
@ -231,7 +233,8 @@ cdef class FileselectorEntry(Object):
in a name for a file, in a given file selector entry widget's
internal file selector.
This has the same effect as :py:attr:`Fileselector.is_save`,
This has the same effect as
:py:attr:`efl.elementary.fileselector.Fileselector.is_save`,
but now applied to a file selector entry's internal file
selector.
@ -254,8 +257,9 @@ cdef class FileselectorEntry(Object):
selector will raise an Elementary "inner window", instead of a
dedicated Elementary window. By default, it won't.
.. seealso:: :py:class:`InnerWindow` for more information on inner
windows
.. seealso::
:py:class:`~efl.elementary.innerwindow.InnerWindow` for more
information on inner windows
:type: bool

View File

@ -29,9 +29,9 @@ and vice-versa using various animations.
If either the front or back contents are not set the flip will treat that
as transparent. So if you were to set the front content but not the back,
and then call :py:func:`go()` you would see whatever is below the flip.
and then call :py:meth:`Flip.go` you would see whatever is below the flip.
For a list of supported animations see :py:func:`go()`.
For a list of supported animations see :py:meth:`Flip.go`.
Signals that you can add callbacks for are:

View File

@ -28,20 +28,20 @@ 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:func:`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:func:`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``.
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``.
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:func:`cb_set()`)
:py:meth:`GestureLayer.cb_set`)
The information reported by gesture layer to your callback is depending
on ``Elm_Gesture_Type``:
@ -528,7 +528,7 @@ cdef class GestureLayer(Object):
:py:func:`attach()` in order to 'activate' gesture-layer.
:param parent: The gesture layer's parent widget.
:type parent: :py:class:`evas.object.Object`
:type parent: :py:class:`~efl.evas.Object`
:return: A new gesture layer object.
:rtype: :py:class:`GestureLayer`
@ -645,7 +645,7 @@ cdef class GestureLayer(Object):
from, to report the gestures made upon it back.
:param target: The target object to attach to this object.
:type target: :py:class:`evas.object.Object`
:type target: :py:class:`~efl.evas.Object`
:return: ``True``, on success, ``False`` otherwise.
:rtype: bool

View File

@ -81,7 +81,7 @@ cdef class Grid(Object):
Pack child at given position and size
:param subobj: The child to pack
:type subobj: :py:class:`evas.object.Object`
:type subobj: :py:class:`~efl.evas.Object`
:param x: The virtual x coord at which to pack it
:type x: Evas_Coord (int)
:param y: The virtual y coord at which to pack it
@ -100,7 +100,7 @@ cdef class Grid(Object):
Unpack a child from a grid object
:param subobj: The child to unpack
:type subobj: :py:class:`evas.object.Object`
:type subobj: :py:class:`~efl.evas.Object`
"""
elm_grid_unpack(self.obj, subobj.obj)
@ -119,7 +119,7 @@ cdef class Grid(Object):
property children:
"""Get the list of the children for the grid.
:type: tuple of :py:class:`evas.object.Object`
:type: tuple of :py:class:`~efl.evas.Object`
"""
def __get__(self):
@ -134,7 +134,7 @@ def grid_pack_set(evasObject subobj, x, y, w, h):
Set packing of an existing child at to position and size
:param subobj: The child to set packing of
:type subobj: :py:class:`evas.object.Object`
:type subobj: :py:class:`~efl.evas.Object`
:param x: The virtual x coord at which to pack it
:type x: Evas_Coord (int)
:param y: The virtual y coord at which to pack it
@ -153,7 +153,7 @@ def grid_pack_get(evasObject subobj):
Get packing of a child
:param subobj: The child to query
:type subobj: :py:class:`evas.object.Object`
:type subobj: :py:class:`~efl.evas.Object`
return: The position and size
rtype: tuple of Evas_Coords (int)

View File

@ -43,7 +43,7 @@ Elementary has the following styles for the hover widget:
- hoversel_vertical
This widget emits the following signals, besides the ones sent from
:py:class:`elementary.layout.Layout`:
:py:class:`~efl.elementary.layout_class.LayoutClass`:
- ``"clicked"`` - the user clicked the empty space in the hover to
dismiss
@ -67,7 +67,7 @@ Default content parts of the hover widget that you can use for are:
All directions may have contents at the same time, except for "smart".
This is a special placement hint and its use case depends of the
calculations coming from :py:func:`best_content_location_get()`. Its use
calculations coming from :py:meth:`~Hover.best_content_location_get`. Its use
is for cases when one desires only one hover content, but with a dynamic
special placement within the hover area. The content's geometry,
whenever it changes, will be used to decide on a best location, not
@ -146,7 +146,7 @@ cdef class Hover(LayoutClass):
Setting this will cause the hover to be centered on the target object.
:type: :py:class:`elementary.object.Object`
:type: :py:class:`~efl.elementary.object.Object`
"""
def __get__(self):
@ -166,7 +166,7 @@ cdef class Hover(LayoutClass):
This will cause the hover to take up the entire space that the
parent object fills.
:type: :py:class:`elementary.object.Object`
:type: :py:class:`~efl.elementary.object.Object`
"""
def __set__(self, evasObject parent):

View File

@ -262,10 +262,10 @@ cdef class Hoversel(Button):
The hover parent object, the area that will be darkened when the
hoversel is clicked. Should probably be the window that the hoversel
is in. See :py:class:`elementary.hover.Hover` objects for more
is in. See :py:class:`~efl.elementary.hover.Hover` objects for more
information.
:type: :py:class:`elementary.object.Object`
:type: :py:class:`~efl.elementary.object.Object`
"""
def __set__(self, evasObject parent):

View File

@ -31,7 +31,7 @@ The icon image requested can be in the Elementary theme in use, or in
the ``freedesktop.org`` theme paths. It's possible to set the order of
preference from where an image will be fetched.
This widget inherits from the :py:class:`elementary.image.Image` one, so
This widget inherits from the :py:class:`~efl.elementary.image.Image` one, so
that all the functions acting on it also work for icon objects.
You should be using an icon, instead of an image, whenever one of the
@ -91,7 +91,7 @@ And these are names for some media player specific icons:
- ``"media_player/stop"``
This widget emits the following signals, besides the ones sent from
:py:class:`elementary.image.Image`:
:py:class:`~efl.elementary.image.Image`:
- ``"thumb,done"`` - Setting :py:attr:`thumb` has completed with success
- ``"thumb,error"`` - Setting :py:attr:`thumb` has failed
@ -172,11 +172,11 @@ cdef class Icon(Image):
This functions like :py:attr:`elementary.image.Image.file` but
requires the Ethumb library support to be enabled successfully with
elm_need_ethumb(). When set the file indicated has a thumbnail
generated and cached on disk for future use or will directly use an
existing cached thumbnail if it is valid.
:py:func:`efl.elementary.need.need_ethumb`. When set the file indicated
has a thumbnail generated and cached on disk for future use or will
directly use an existing cached thumbnail if it is valid.
.. seealso:: Image.file
.. seealso:: :py:attr:`~efl.elementary.image.Image.file`
:type: string ``file`` or tuple(string ``file``, string ``group``)
@ -213,9 +213,11 @@ cdef class Icon(Image):
If name is not found in any of the expected locations and it is the
absolute path of an image file, this image will be used.
.. note:: The icon image set can be changed by :py:attr:`elementary.image.Image.file`.