From 4c9ab894269099f93a60b61352e969903709a730 Mon Sep 17 00:00:00 2001 From: Kai Huuhko Date: Tue, 3 Dec 2013 21:56:47 +0200 Subject: [PATCH] Documentation: Fixed invalid references and other misc. issues. --- doc/conf.py | 2 + doc/ecore/animator.rst | 2 + doc/ecore/exe.rst | 2 + doc/ecore/fdhandler.rst | 2 + doc/ecore/filedownload.rst | 2 + doc/ecore/filemonitor.rst | 2 + doc/ecore/idleenterer.rst | 2 + doc/ecore/idleexiter.rst | 2 + doc/ecore/idler.rst | 2 + doc/ecore/poller.rst | 2 + doc/ecore/timer.rst | 2 + doc/edje/class-edje.rst | 2 + doc/emotion/class-emotion.rst | 2 + doc/evas/class-canvas.rst | 2 + doc/evas/class-grid.rst | 2 + doc/evas/class-map.rst | 2 + doc/evas/class-object-box.rst | 2 + doc/evas/class-object-image.rst | 2 + doc/evas/class-object-line.rst | 2 + doc/evas/class-object-polygon.rst | 2 + doc/evas/class-object-rectangle.rst | 2 + doc/evas/class-object-smart.rst | 2 + doc/evas/class-object-text.rst | 2 + doc/evas/class-object-textblock.rst | 2 + doc/evas/class-object.rst | 2 + doc/evas/class-rect.rst | 2 + doc/evas/class-table.rst | 2 + doc/evas/class-textgrid.rst | 2 + efl/ecore/efl.ecore_exe.pxi | 10 ++--- efl/elementary/box.pyx | 34 +++++++-------- efl/elementary/button.pyx | 10 ++--- efl/elementary/calendar_elm.pyx | 13 +++--- efl/elementary/check.pyx | 5 +-- efl/elementary/clock.pyx | 2 +- efl/elementary/colorselector.pyx | 6 +-- efl/elementary/configuration.pyx | 15 ++++--- efl/elementary/ctxpopup.pyx | 12 ++++-- efl/elementary/datetime_elm.pyx | 6 +-- efl/elementary/dayselector.pyx | 15 ++++--- efl/elementary/diskselector.pyx | 24 +++++------ efl/elementary/fileselector_button.pyx | 16 ++++--- efl/elementary/fileselector_entry.pyx | 14 +++--- efl/elementary/flip.pyx | 4 +- efl/elementary/gesture_layer.pyx | 16 +++---- efl/elementary/grid.pyx | 10 ++--- efl/elementary/hover.pyx | 8 ++-- efl/elementary/hoversel.pyx | 4 +- efl/elementary/icon.pyx | 18 ++++---- efl/elementary/innerwindow.pyx | 16 +++---- efl/elementary/layout.pyx | 59 +++++++++++++------------- efl/elementary/naviframe.pyx | 19 +++++---- efl/elementary/spinner.pyx | 6 +-- efl/elementary/toolbar.pyx | 36 ++++++++-------- 53 files changed, 252 insertions(+), 182 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 6cce99a..010aeb2 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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 --------------------------------------------------- diff --git a/doc/ecore/animator.rst b/doc/ecore/animator.rst index 6555b37..b5b61b9 100644 --- a/doc/ecore/animator.rst +++ b/doc/ecore/animator.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.ecore + :class:`efl.ecore.Animator` Class ================================= diff --git a/doc/ecore/exe.rst b/doc/ecore/exe.rst index 599503e..b37abcb 100644 --- a/doc/ecore/exe.rst +++ b/doc/ecore/exe.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.ecore + :class:`efl.ecore.Exe` Class ============================== diff --git a/doc/ecore/fdhandler.rst b/doc/ecore/fdhandler.rst index 8cfd6a8..f18e44b 100644 --- a/doc/ecore/fdhandler.rst +++ b/doc/ecore/fdhandler.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.ecore + :class:`efl.ecore.FdHandler` Class ================================== diff --git a/doc/ecore/filedownload.rst b/doc/ecore/filedownload.rst index 9b45ee8..cb375dd 100644 --- a/doc/ecore/filedownload.rst +++ b/doc/ecore/filedownload.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.ecore + :class:`efl.ecore.FileDownload` Class ===================================== diff --git a/doc/ecore/filemonitor.rst b/doc/ecore/filemonitor.rst index d9bc773..e2f1d8a 100644 --- a/doc/ecore/filemonitor.rst +++ b/doc/ecore/filemonitor.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.ecore + :class:`efl.ecore.FileMonitor` Class ===================================== diff --git a/doc/ecore/idleenterer.rst b/doc/ecore/idleenterer.rst index 05fe79c..1d8deca 100644 --- a/doc/ecore/idleenterer.rst +++ b/doc/ecore/idleenterer.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.ecore + :class:`efl.ecore.IdleEnterer` Class ==================================== diff --git a/doc/ecore/idleexiter.rst b/doc/ecore/idleexiter.rst index c960cfc..cc61ee4 100644 --- a/doc/ecore/idleexiter.rst +++ b/doc/ecore/idleexiter.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.ecore + :class:`efl.ecore.IdleExiter` Class =================================== diff --git a/doc/ecore/idler.rst b/doc/ecore/idler.rst index 7620bb4..aefaafe 100644 --- a/doc/ecore/idler.rst +++ b/doc/ecore/idler.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.ecore + :class:`efl.ecore.Idler` Class ============================== diff --git a/doc/ecore/poller.rst b/doc/ecore/poller.rst index 370a5c0..0d0e457 100644 --- a/doc/ecore/poller.rst +++ b/doc/ecore/poller.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.ecore + :class:`efl.ecore.Poller` Class =============================== diff --git a/doc/ecore/timer.rst b/doc/ecore/timer.rst index c37f591..b61dc8e 100644 --- a/doc/ecore/timer.rst +++ b/doc/ecore/timer.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.ecore + :class:`efl.ecore.Timer` Class ============================== diff --git a/doc/edje/class-edje.rst b/doc/edje/class-edje.rst index dcf02d3..3f322ae 100644 --- a/doc/edje/class-edje.rst +++ b/doc/edje/class-edje.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.edje + :class:`efl.edje.Edje` Class ============================== diff --git a/doc/emotion/class-emotion.rst b/doc/emotion/class-emotion.rst index c4d6604..485fb96 100644 --- a/doc/emotion/class-emotion.rst +++ b/doc/emotion/class-emotion.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.emotion + :class:`efl.emotion.Emotion` Class ================================== diff --git a/doc/evas/class-canvas.rst b/doc/evas/class-canvas.rst index 079fb58..4feeab9 100644 --- a/doc/evas/class-canvas.rst +++ b/doc/evas/class-canvas.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Canvas` Class ============================== diff --git a/doc/evas/class-grid.rst b/doc/evas/class-grid.rst index 03747db..784c09a 100644 --- a/doc/evas/class-grid.rst +++ b/doc/evas/class-grid.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Grid` Class ============================ diff --git a/doc/evas/class-map.rst b/doc/evas/class-map.rst index 20d69ab..12ab949 100644 --- a/doc/evas/class-map.rst +++ b/doc/evas/class-map.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Map` Class ============================ diff --git a/doc/evas/class-object-box.rst b/doc/evas/class-object-box.rst index 8b283f7..0610010 100644 --- a/doc/evas/class-object-box.rst +++ b/doc/evas/class-object-box.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Box` Class =========================== diff --git a/doc/evas/class-object-image.rst b/doc/evas/class-object-image.rst index b30cbd5..bd54071 100644 --- a/doc/evas/class-object-image.rst +++ b/doc/evas/class-object-image.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Image` Class ============================= diff --git a/doc/evas/class-object-line.rst b/doc/evas/class-object-line.rst index 92bf206..2a1d89c 100644 --- a/doc/evas/class-object-line.rst +++ b/doc/evas/class-object-line.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Line` Class ============================ diff --git a/doc/evas/class-object-polygon.rst b/doc/evas/class-object-polygon.rst index b6822a8..f6e27bf 100644 --- a/doc/evas/class-object-polygon.rst +++ b/doc/evas/class-object-polygon.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Polygon` Class =============================== diff --git a/doc/evas/class-object-rectangle.rst b/doc/evas/class-object-rectangle.rst index 0c2160e..e2a6455 100644 --- a/doc/evas/class-object-rectangle.rst +++ b/doc/evas/class-object-rectangle.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Rectangle` Class ================================= diff --git a/doc/evas/class-object-smart.rst b/doc/evas/class-object-smart.rst index adf6c74..0163e0a 100644 --- a/doc/evas/class-object-smart.rst +++ b/doc/evas/class-object-smart.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.SmartObject` Class =================================== diff --git a/doc/evas/class-object-text.rst b/doc/evas/class-object-text.rst index ca36820..a7f39a4 100644 --- a/doc/evas/class-object-text.rst +++ b/doc/evas/class-object-text.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Text` Class ============================ diff --git a/doc/evas/class-object-textblock.rst b/doc/evas/class-object-textblock.rst index 2a1dc75..6cc7021 100644 --- a/doc/evas/class-object-textblock.rst +++ b/doc/evas/class-object-textblock.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Textblock` Class ================================= diff --git a/doc/evas/class-object.rst b/doc/evas/class-object.rst index 2a998f7..38e1558 100644 --- a/doc/evas/class-object.rst +++ b/doc/evas/class-object.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Object` Class ============================== diff --git a/doc/evas/class-rect.rst b/doc/evas/class-rect.rst index 4da7033..a38ad18 100644 --- a/doc/evas/class-rect.rst +++ b/doc/evas/class-rect.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Rect` Class ============================ diff --git a/doc/evas/class-table.rst b/doc/evas/class-table.rst index 19a7936..323b761 100644 --- a/doc/evas/class-table.rst +++ b/doc/evas/class-table.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Table` Class ============================= diff --git a/doc/evas/class-textgrid.rst b/doc/evas/class-textgrid.rst index 85efc5a..46153cc 100644 --- a/doc/evas/class-textgrid.rst +++ b/doc/evas/class-textgrid.rst @@ -1,3 +1,5 @@ +.. currentmodule:: efl.evas + :class:`efl.evas.Textgrid` Class ================================ diff --git a/efl/ecore/efl.ecore_exe.pxi b/efl/ecore/efl.ecore_exe.pxi index 760af2f..eece160 100644 --- a/efl/ecore/efl.ecore_exe.pxi +++ b/efl/ecore/efl.ecore_exe.pxi @@ -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) diff --git a/efl/elementary/box.pyx b/efl/elementary/box.pyx index b47be39..d1b3491 100644 --- a/efl/elementary/box.pyx +++ b/efl/elementary/box.pyx @@ -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 ` + :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 ` + :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 ` + :type subobj: :py:class:`~efl.evas.Object` :param before: The object before which to add it - :type before: :py:class:`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 ` + :type subobj: :py:class:`~efl.evas.Object` :param after: The object after which to add it - :type after: :py:class:`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 ` + :type subobj: :py:class:`~efl.evas.Object` """ elm_box_unpack(self.obj, obj.obj) @@ -352,7 +352,7 @@ cdef class Box(Object): `. The order of the list corresponds to the packing order the box uses. - :type: list of :py:class:`Objects ` + :type: list of :py:class:`~efl.evas.Object` """ def __get__(self): diff --git a/efl/elementary/button.pyx b/efl/elementary/button.pyx index 20ccc7d..f187d87 100644 --- a/efl/elementary/button.pyx +++ b/efl/elementary/button.pyx @@ -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: diff --git a/efl/elementary/calendar_elm.pyx b/efl/elementary/calendar_elm.pyx index 9d07b12..06d9f6a 100644 --- a/efl/elementary/calendar_elm.pyx +++ b/efl/elementary/calendar_elm.pyx @@ -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 ` + :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) diff --git a/efl/elementary/check.pyx b/efl/elementary/check.pyx index 8824d33..25b1095 100644 --- a/efl/elementary/check.pyx +++ b/efl/elementary/check.pyx @@ -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. diff --git a/efl/elementary/clock.pyx b/efl/elementary/clock.pyx index d707cc1..1320c30 100644 --- a/efl/elementary/clock.pyx +++ b/efl/elementary/clock.pyx @@ -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) diff --git a/efl/elementary/colorselector.pyx b/efl/elementary/colorselector.pyx index 7ae735c..041e8d0 100644 --- a/efl/elementary/colorselector.pyx +++ b/efl/elementary/colorselector.pyx @@ -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 diff --git a/efl/elementary/configuration.pyx b/efl/elementary/configuration.pyx index 8747565..1f0a3ed 100644 --- a/efl/elementary/configuration.pyx +++ b/efl/elementary/configuration.pyx @@ -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 diff --git a/efl/elementary/ctxpopup.pyx b/efl/elementary/ctxpopup.pyx index 41b8b88..5acb2ad 100644 --- a/efl/elementary/ctxpopup.pyx +++ b/efl/elementary/ctxpopup.pyx @@ -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): diff --git a/efl/elementary/datetime_elm.pyx b/efl/elementary/datetime_elm.pyx index da58f14..90724d2 100644 --- a/efl/elementary/datetime_elm.pyx +++ b/efl/elementary/datetime_elm.pyx @@ -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` diff --git a/efl/elementary/dayselector.pyx b/efl/elementary/dayselector.pyx index 639702b..d080678 100644 --- a/efl/elementary/dayselector.pyx +++ b/efl/elementary/dayselector.pyx @@ -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... diff --git a/efl/elementary/diskselector.pyx b/efl/elementary/diskselector.pyx index 2acd386..511da11 100644 --- a/efl/elementary/diskselector.pyx +++ b/efl/elementary/diskselector.pyx @@ -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` 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` diff --git a/efl/elementary/fileselector_button.pyx b/efl/elementary/fileselector_button.pyx index 2545442..60e5ff2 100644 --- a/efl/elementary/fileselector_button.pyx +++ b/efl/elementary/fileselector_button.pyx @@ -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 diff --git a/efl/elementary/fileselector_entry.pyx b/efl/elementary/fileselector_entry.pyx index 2e888b6..9056af2 100644 --- a/efl/elementary/fileselector_entry.pyx +++ b/efl/elementary/fileselector_entry.pyx @@ -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 diff --git a/efl/elementary/flip.pyx b/efl/elementary/flip.pyx index f4beafc..962528a 100644 --- a/efl/elementary/flip.pyx +++ b/efl/elementary/flip.pyx @@ -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: diff --git a/efl/elementary/gesture_layer.pyx b/efl/elementary/gesture_layer.pyx index 3610787..ccabeb8 100644 --- a/efl/elementary/gesture_layer.pyx +++ b/efl/elementary/gesture_layer.pyx @@ -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 diff --git a/efl/elementary/grid.pyx b/efl/elementary/grid.pyx index 7966ce9..d2ec240 100644 --- a/efl/elementary/grid.pyx +++ b/efl/elementary/grid.pyx @@ -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) diff --git a/efl/elementary/hover.pyx b/efl/elementary/hover.pyx index 8af934a..cff604f 100644 --- a/efl/elementary/hover.pyx +++ b/efl/elementary/hover.pyx @@ -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): diff --git a/efl/elementary/hoversel.pyx b/efl/elementary/hoversel.pyx index 6b814ef..ea73775 100644 --- a/efl/elementary/hoversel.pyx +++ b/efl/elementary/hoversel.pyx @@ -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): diff --git a/efl/elementary/icon.pyx b/efl/elementary/icon.pyx index 36a5f5e..66e33e9 100644 --- a/efl/elementary/icon.pyx +++ b/efl/elementary/icon.pyx @@ -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`. + .. note:: + The icon image set can be changed by + :py:attr:`~efl.elementary.image.Image.file`. - .. seealso:: Image.file + .. seealso:: :py:attr:`~efl.elementary.image.Image.file` :type: string :raise RuntimeWarning: when setting the standard name fails. diff --git a/efl/elementary/innerwindow.pyx b/efl/elementary/innerwindow.pyx index 926ce5c..ab65a55 100644 --- a/efl/elementary/innerwindow.pyx +++ b/efl/elementary/innerwindow.pyx @@ -26,12 +26,12 @@ Widget description An inwin is a window inside a window that is useful for a quick popup. It does not hover. -It works by creating an object that will occupy the entire window, so it -must be created using an :py:class:`elementary.window.Window` as parent -only. The inwin object can be hidden or restacked below every other -object if it's needed to show what's behind it without destroying it. If -this is done, the :py:func:`activate()` function can be used to bring it -back to full visibility again. +It works by creating an object that will occupy the entire window, so it must be +created using an :py:class:`~efl.elementary.window.Window` as parent only. The +inwin object can be hidden or restacked below every other object if it's needed +to show what's behind it without destroying it. If this is done, the +:py:meth:`~InnerWindow.activate` function can be used to bring it back to full +visibility again. There are three styles available in the default theme. These are: - default: The inwin is sized to take over most of the window it's @@ -63,7 +63,7 @@ cdef class InnerWindow(LayoutClass): Activates an inwin object, ensuring its visibility This function will make sure that the inwin is completely visible - by calling :py:func:`show()` and :py:func:`_raise()` on it, to bring it + by calling :py:func:`show()` and :py:func:`raise_()` on it, to bring it to the front. It also sets the keyboard focus to it, which will be passed onto its content. @@ -88,7 +88,7 @@ cdef class InnerWindow(LayoutClass): Once the content object is set, a previously set one will be deleted. - :type: :py:class:`evas.object.Object` + :type: :py:class:`~efl.evas.Object` """ def __get__(self): diff --git a/efl/elementary/layout.pyx b/efl/elementary/layout.pyx index 525a160..ff89ed6 100644 --- a/efl/elementary/layout.pyx +++ b/efl/elementary/layout.pyx @@ -30,7 +30,8 @@ describe the behavior of elements added to the Layout. Check out the Edje documentation and the EDC reference to get more information about what can be done with Edje. -Just like :py:class:`List`, :py:class:`Box`, and other container +Just like :py:class:`~efl.elementary.list.List`, +:py:class:`~efl.elementary.box.Box`, and other container widgets, any object added to the Layout will become its child, meaning that it will be deleted if the Layout is deleted, move if the Layout is moved, and so on. @@ -67,47 +68,47 @@ Content (SWALLOW part) Box (BOX part) An Edje ``BOX`` part is very similar to the Elementary - :py:class:`elementary.box.Box` widget. It allows one to add objects - to the box and have them distributed along its area, accordingly to - the specified ``layout`` property (now by ``layout`` we mean the - chosen layouting design of the Box, not the Layout widget itself). + :py:class:`elementary.box.Box` widget. It allows one to add objects to the + box and have them distributed along its area, accordingly to the specified + ``layout`` property (now by ``layout`` we mean the chosen layouting design + of the Box, not the Layout widget itself). - A similar effect for having a box with its position, size and other - things controlled by the Layout theme would be to create an - Elementary :py:class:`Box` widget and add it as a Content in the + A similar effect for having a box with its position, size and other things + controlled by the Layout theme would be to create an Elementary + :py:class:`~efl.elementary.box.Box` widget and add it as a Content in the ``SWALLOW`` part. - The main difference of using the Layout Box is that its behavior, - the box properties like layouting format, padding, align, etc. will - be all controlled by the theme. This means, for example, that a - signal could be sent to the Layout theme (with - :py:func:`Object.signal_emit()`) and the theme handled the signal by - changing the box padding, or align, or both. Using the Elementary - :py:class:`Box` widget is not necessarily harder or easier, it just - depends on the circumstances and requirements. + The main difference of using the Layout Box is that its behavior, the box + properties like layouting format, padding, align, etc. will be all + controlled by the theme. This means, for example, that a signal could be + sent to the Layout theme (with + :py:meth:`~efl.elementary.object.Object.signal_emit`) and the theme handled + the signal by changing the box padding, or align, or both. Using the + Elementary :py:class:`~efl.elementary.box.Box` widget is not necessarily + harder or easier, it just depends on the circumstances and requirements. 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:`Table` widget. It allows one to add objects to - the Table specifying the row and column where the object should be - added, and any column or row span if necessary. + 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, + and any column or row span if necessary. - Again, we could have this design by adding a :py:class:`Table` - widget to the ``SWALLOW`` part using - :py:func:`Object.part_content_set()`. The same difference happens - here when choosing to use the Layout Table (a ``TABLE`` part) - instead of the :py:class:`Table` plus ``SWALLOW`` part. It's just a - matter of convenience. + Again, we could have this design by adding a + :py:class:`~efl.elementary.table.Table` widget to the ``SWALLOW`` part using + :py:func:`~efl.elementary.object.Object.part_content_set`. The same + difference happens here when choosing to use the Layout Table (a ``TABLE`` + part) instead of the :py:class:`~efl.elementary.table.Table` plus + ``SWALLOW`` part. It's just a matter of convenience. The Layout Table can be used through the ``table_`` set of functions. Another interesting thing about the Layout widget is that it offers some -predefined themes that come with the default Elementary theme. These -themes can be set by :py:attr:`theme`, and provide some basic -functionality depending on the theme used. +predefined themes that come with the default Elementary theme. These themes can +be set by :py:attr:`~efl.elementary.layout_class.LayoutClass.theme`, and provide +some basic functionality depending on the theme used. Most of them already send some signals, some already provide a toolbar or back and next buttons. diff --git a/efl/elementary/naviframe.pyx b/efl/elementary/naviframe.pyx index 8b5a3ed..8f51581 100644 --- a/efl/elementary/naviframe.pyx +++ b/efl/elementary/naviframe.pyx @@ -40,9 +40,9 @@ Naviframe views hold spaces to various elements, which are: - title icon and - content area. -Becase this widget is a layout, one places content on those areas -by using :py:func:`content_set()` on the right swallow part names -expected for each, which are: +Becase this widget is a layout, one places content on those areas by using +:py:func:`~efl.elementary.object.Object.part_content_set` on the right swallow +part names expected for each, which are: - ``"default"`` - The main content of the current page - ``"icon"`` - An icon in the title area of the current page @@ -51,7 +51,8 @@ expected for each, which are: - ``"next_btn"`` - A button of the current page to go to the next page -For text, :py:func:`text_set()` will work here on: +For text, :py:func:`~efl.elementary.object.Object.part_text_set` will work here +on: - ``"default"`` - Title label in the title area of the current page @@ -59,7 +60,7 @@ For text, :py:func:`text_set()` will work here on: current page Most of those content objects can be passed at the time of an item -creation (see :py:func:`item_push()`). +creation (see :py:meth:`~Naviframe.item_push`). Naviframe items can have different styles, which affect the transition between views, for example. On the default theme, two of @@ -72,7 +73,7 @@ them are supported: This widget emits the following signals, besides the ones sent from -:py:class:`elementary.layout_class.LayoutClass`: +:py:class:`~efl.elementary.layout_class.LayoutClass`: - ``transition,finished`` - When the transition is finished in changing the item @@ -134,14 +135,14 @@ cdef class NaviframeItem(ObjectItem): :param prev_btn: The button to go to the previous item. If it is None, then naviframe will create a back button automatically. The name of the prev_btn part is "elm.swallow.prev_btn" - :type prev_btn: :py:class:`elementary.button.Button` + :type prev_btn: :py:class:`~efl.elementary.button.Button` :param next_btn: The button to go to the next item. Or It could be just an extra function button. The name of the next_btn part is "elm.swallow.next_btn" - :type next_btn: :py:class:`elementary.button.Button` + :type next_btn: :py:class:`~efl.elementary.button.Button` :param content: The main content object. The name of content part is "elm.swallow.content" - :type content: :py:class:`elementary.object.Object` + :type content: :py:class:`~efl.elementary.object.Object` :param item_style: The current item style name. ``None`` would be default. :type item_style: string diff --git a/efl/elementary/spinner.pyx b/efl/elementary/spinner.pyx index c01389b..6df7336 100644 --- a/efl/elementary/spinner.pyx +++ b/efl/elementary/spinner.pyx @@ -37,7 +37,7 @@ point values and thus accepts a printf-style format string, like It also allows specific values to be replaced by pre-defined labels. 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 the spinner value is changed. - ``"delay,changed"`` - A short time after the value is changed by @@ -280,7 +280,7 @@ cdef class Spinner(LayoutClass): It will remove a previously added special value. After this, the spinner will display the value itself instead of a label. - :see: elm_spinner_special_value_add() for more details. + :see: :py:meth:`special_value_add` for more details. :since: 1.8 @@ -295,7 +295,7 @@ cdef class Spinner(LayoutClass): :param value: The replaced value. :return: The used label. - :see: elm_spinner_special_value_add() for more details. + :see: :py:meth:`special_value_add` for more details. :since: 1.8 diff --git a/efl/elementary/toolbar.pyx b/efl/elementary/toolbar.pyx index 61f721b..3aaceb6 100644 --- a/efl/elementary/toolbar.pyx +++ b/efl/elementary/toolbar.pyx @@ -55,7 +55,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` class +:py:class:`~efl.elementary.scroller.Scrollable` class using multiple inheritance, for example:: class ScrollableGenlist(Genlist, Scrollable): @@ -228,8 +228,6 @@ cdef class ToolbarItemState(object): cdef Elm_Toolbar_Item_State *state cdef object params - # FIXME - def __init__(self, ToolbarItem it, icon = None, label = None, callback = None, *args, **kwargs): cdef Evas_Smart_Cb cb = NULL @@ -310,14 +308,14 @@ cdef class ToolbarItem(ObjectItem): be set as **last** item. Items created with this method can be deleted with - :py:func:`ObjectItem.delete()`. + :py:meth:`~efl.elementary.object_item.ObjectItem.delete` - .. seealso:: :py:attr:`ToolbarItem.icon` :py:func:`ObjectItem.delete()` + :seealso: :py:attr:`ToolbarItem.icon` :param toolbar: The toolbar this item should be appended to :type toolbar: :py:class:`Toolbar` :return: The created item or ``None`` upon failure. - :rtype: ToolbarItem + :rtype: :py:class:`ToolbarItem` """ cdef Elm_Object_Item *item @@ -345,7 +343,7 @@ cdef class ToolbarItem(ObjectItem): be set as **first** item. Items created with this method can be deleted with - :py:func:`ObjectItem.delete()`. + :py:meth:`~efl.elementary.object_item.ObjectItem.delete` :param toolbar: The toolbar this item should be prepended to :type toolbar: :py:class:`Toolbar` @@ -378,7 +376,7 @@ cdef class ToolbarItem(ObjectItem): this toolbar will be just after item ``after``. Items created with this method can be deleted with - :py:func:`ObjectItem.delete()`. + :py:meth:`~efl.elementary.object_item.ObjectItem.delete` :param after: The toolbar item to insert after. :type after: :py:class:`ToolbarItem` @@ -414,7 +412,7 @@ cdef class ToolbarItem(ObjectItem): this toolbar will be just before item ``before``. Items created with this method can be deleted with - :py:func:`ObjectItem.delete()`. + :py:meth:`~efl.elementary.object_item.ObjectItem.delete` :param before: The toolbar item to insert before. :type before: :py:class:`ToolbarItem` @@ -448,7 +446,7 @@ cdef class ToolbarItem(ObjectItem): .. note:: If it is the last item, ``None`` will be returned. - .. seealso:: :py:func:`Toolbar.item_append()` + .. seealso:: :py:meth:`Toolbar.item_append` :type: :py:class:`ToolbarItem` @@ -464,7 +462,7 @@ cdef class ToolbarItem(ObjectItem): .. note:: If it is the first item, ``None`` will be returned. - .. seealso:: :py:func:`Toolbar.item_prepend()` + .. seealso:: :py:func:`Toolbar.item_prepend` :type: :py:class:`ToolbarItem` @@ -653,10 +651,12 @@ cdef class ToolbarItem(ObjectItem): return elm_toolbar_item_separator_get(self.item) property menu: - """This property has two diffent functionalities. The object you get - from it is the :py:class:`Menu` object used by this toolbar item, - and setting it to True or False controls whether this item is a menu - or not. + """ + + This property has two diffent functionalities. The object you get from + it is the :py:class:`~efl.elementary.menu.Menu` object used by this + toolbar item, and setting it to True or False controls whether this item + is a menu or not. If item wasn't set as menu item, getting the value of this property sets it to be that. @@ -666,7 +666,7 @@ cdef class ToolbarItem(ObjectItem): and properties. So, items to be displayed in this item's menu should be added with - :py:func:`Menu.item_add()`. + :py:func:`efl.elementary.menu.Menu.item_add()`. The following code exemplifies the most basic usage:: @@ -846,7 +846,7 @@ cdef class Toolbar(Object): property first_item: """Get the first item in the given toolbar widget's list of items. - .. seealso:: :py:func:`item_append()` :py:attr:`last_item` + .. seealso:: :py:func:`item_append` :py:attr:`last_item` :type: :py:class:`ToolbarItem` @@ -860,7 +860,7 @@ cdef class Toolbar(Object): property last_item: """Get the last item in the given toolbar widget's list of items. - .. seealso:: :py:func:`item_prepend()` :py:attr:`first_item` + .. seealso:: :py:func:`item_prepend` :py:attr:`first_item` :type: :py:class:`ToolbarItem`