Documentation formatting fixes.
This commit is contained in:
parent
606bf8694d
commit
8b58ef24ea
|
@ -1,4 +1,4 @@
|
|||
:class:`efl.ecore.Poller` Class
|
||||
==============================
|
||||
===============================
|
||||
|
||||
.. autoclass:: efl.ecore.Poller
|
||||
|
|
|
@ -68,7 +68,7 @@ cdef class Event(object):
|
|||
|
||||
cdef class EventHandler(object):
|
||||
def __init__(self, int type, func, *args, **kargs):
|
||||
"@parm: B{type} event type, as registered with ecore_event_type_new()."
|
||||
":parm type: event type, as registered with ecore_event_type_new()."
|
||||
if not callable(func):
|
||||
raise TypeError("Parameter 'func' must be callable")
|
||||
event_cls = _event_type_mapping.get(type, None)
|
||||
|
|
|
@ -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 ``continue_()``
|
||||
In order to resume application execution, use :py:func:`continue_()`
|
||||
"""
|
||||
ecore_exe_pause(self.exe)
|
||||
|
||||
|
@ -585,9 +585,7 @@ cdef class Exe(object):
|
|||
def continue_(self):
|
||||
"""Send contine signal (SIGCONT) to executed process.
|
||||
|
||||
This resumes application previously paused with L{pause()}
|
||||
|
||||
:see: pause()
|
||||
This resumes application previously paused with :py:func:`pause`
|
||||
|
||||
"""
|
||||
ecore_exe_continue(self.exe)
|
||||
|
@ -689,7 +687,7 @@ cdef class Exe(object):
|
|||
filter.callback_add(func, args, kargs)
|
||||
|
||||
def on_del_event_del(self, func, *args, **kargs):
|
||||
"""Removes the event listener registered with L{on_del_event_add()}.
|
||||
"""Removes the event listener registered with :py:func`on_del_event_add`.
|
||||
|
||||
Parameters must be exactly the same.
|
||||
|
||||
|
@ -725,7 +723,7 @@ cdef class Exe(object):
|
|||
filter.callback_add(func, args, kargs)
|
||||
|
||||
def on_data_event_del(self, func, *args, **kargs):
|
||||
"""Removes the event listener registered with L{on_data_event_add()}.
|
||||
"""Removes the event listener registered with :py:func:`on_data_event_add()`.
|
||||
|
||||
Parameters must be exactly the same.
|
||||
|
||||
|
@ -749,7 +747,7 @@ cdef class Exe(object):
|
|||
In contrast with ``on_exe_error_event_add()``, this only receives
|
||||
the events from this exact exe instance. The signature is also
|
||||
very different, the first parameter is the ``Exe`` reference
|
||||
and the return value does B{not} removes the event listener!
|
||||
and the return value does **not** remove the event listener!
|
||||
|
||||
:see: on_error_event_del()
|
||||
:see: on_exe_error_event_add()
|
||||
|
@ -761,7 +759,7 @@ cdef class Exe(object):
|
|||
filter.callback_add(func, args, kargs)
|
||||
|
||||
def on_error_event_del(self, func, *args, **kargs):
|
||||
"""Removes the event listener registered with L{on_error_event_add()}.
|
||||
"""Removes the event listener registered with :py:func:`on_error_event_add()`.
|
||||
|
||||
Parameters must be exactly the same.
|
||||
|
||||
|
@ -788,7 +786,7 @@ def exe_pipe_run(exe_cmd, int flags=0, data=None):
|
|||
cdef class EventExeAdd(Event):
|
||||
""""Represents Ecore_Exe_Event_Add event from C-api.
|
||||
|
||||
This event notifies the process created with L{Exe} was started.
|
||||
This event notifies the process created with :py:class:`Exe` was started.
|
||||
|
||||
See property ``exe`` for ``Exe`` instance.
|
||||
"""
|
||||
|
@ -843,14 +841,14 @@ cdef class EventExeDel(Event):
|
|||
cdef class EventExeData(Event):
|
||||
"""Represents Ecore_Exe_Event_Data from C-api.
|
||||
|
||||
This event is issued by L{Exe} instances created with flags that
|
||||
This event is issued by :py:class:`Exe` instances created with flags that
|
||||
allow reading from either stdout or stderr.
|
||||
|
||||
See properties:
|
||||
|
||||
- **exe** instance of L{Exe} that created this event.
|
||||
- **exe** instance of :py:class:`Exe` that created this event.
|
||||
- **data** the raw string buffer with binary data from child process.
|
||||
- **size** the size of B{data} (same as C{len(data)})
|
||||
- **size** the size of **data** (same as ``len(data)``)
|
||||
- **lines** list of strings with all text lines
|
||||
"""
|
||||
cdef int _set_obj(self, void *o) except 0:
|
||||
|
@ -935,7 +933,7 @@ def on_exe_data_event_add(func, *args, **kargs):
|
|||
def on_exe_error_event_add(func, *args, **kargs):
|
||||
"""Create an ecore event handler for ECORE_EXE_EVENT_ERROR
|
||||
|
||||
:see: L{EventHandler}
|
||||
:see: L{EventHandlerExe}
|
||||
:see: :py:class:`EventHandler`
|
||||
:see: :py:class:`EventHandlerExe`
|
||||
"""
|
||||
return EventHandlerExe(enums.ECORE_EXE_EVENT_ERROR, func, *args, **kargs)
|
||||
|
|
|
@ -227,7 +227,7 @@ def fd_handler_add(fd, int flags, func, *args, **kargs):
|
|||
|
||||
func(fd_handler, *args, **kargs): bool
|
||||
|
||||
:param fd: file descriptor or object with C{fileno()} method.
|
||||
:param fd: file descriptor or object with ``fileno()`` method.
|
||||
:param flags: bitwise OR of ECORE_FD_READ, ECORE_FD_WRITE...
|
||||
:param func: function to call when file descriptor state changes.
|
||||
|
||||
|
|
|
@ -908,7 +908,7 @@ cdef class Edje(Object):
|
|||
<const_char *>part if part is not None else NULL, dx, dy)
|
||||
|
||||
def part_drag_page_get(self, part):
|
||||
"@rtype: tuple of float"
|
||||
":rtype: tuple of float"
|
||||
cdef double dx, dy
|
||||
if isinstance(part, unicode): part = PyUnicode_AsUTF8String(part)
|
||||
edje_object_part_drag_page_get(self.obj,
|
||||
|
|
|
@ -97,7 +97,7 @@ cdef class Accessible(Object):
|
|||
|
||||
# :param type: The type of content that will be read
|
||||
# :param func: The function to be called when the content is read
|
||||
# :param data: The data pointer to be passed to @p func
|
||||
# :param data: The data pointer to be passed to ``func``
|
||||
|
||||
# The type would be one of ELM_ACCESS_TYPE, ELM_ACCESS_INFO,
|
||||
# ELM_ACCESS_STATE, ELM_ACCESS_CONTEXT_INFO.
|
||||
|
@ -119,7 +119,7 @@ cdef class Accessible(Object):
|
|||
# :since: 1.8
|
||||
|
||||
# :param func: The function to be called when the activate gesture is detected
|
||||
# :param data: The data pointer to be passed to @p func
|
||||
# :param data: The data pointer to be passed to ``func``
|
||||
|
||||
# """
|
||||
# if not callable(func):
|
||||
|
|
|
@ -1311,7 +1311,7 @@ cdef class Entry(Object):
|
|||
# default provider in entry does.
|
||||
|
||||
# :param func: The function called to provide the item object
|
||||
# :param data: The data passed to @p func
|
||||
# :param data: The data passed to ``func``
|
||||
|
||||
# """
|
||||
# elm_entry_item_provider_append(self.obj, Elm_Entry_Item_Provider_Cb func, void *data)
|
||||
|
@ -1324,7 +1324,7 @@ cdef class Entry(Object):
|
|||
# more information
|
||||
|
||||
# :param func: The function called to provide the item object
|
||||
# :param data: The data passed to @p func
|
||||
# :param data: The data passed to ``func``
|
||||
|
||||
# """
|
||||
# elm_entry_item_provider_prepend(self.obj, Elm_Entry_Item_Provider_Cb func, void *data)
|
||||
|
@ -1337,7 +1337,7 @@ cdef class Entry(Object):
|
|||
# more information
|
||||
|
||||
# :param func: The function called to provide the item object
|
||||
# :param data: The data passed to @p func
|
||||
# :param data: The data passed to ``func``
|
||||
|
||||
# """
|
||||
# elm_entry_item_provider_remove(self.obj, Elm_Entry_Item_Provider_Cb func, void *data)
|
||||
|
@ -1356,7 +1356,7 @@ cdef class Entry(Object):
|
|||
# being called.
|
||||
|
||||
# :param func: The function to use as text filter
|
||||
# :param data: User data to pass to @p func
|
||||
# :param data: User data to pass to ``func``
|
||||
|
||||
# """
|
||||
# cb_data = (func, data)
|
||||
|
@ -1371,7 +1371,7 @@ cdef class Entry(Object):
|
|||
# for more information
|
||||
|
||||
# :param func: The function to use as text filter
|
||||
# :param data: User data to pass to @p func
|
||||
# :param data: User data to pass to ``func``
|
||||
|
||||
# """
|
||||
# elm_entry_markup_filter_prepend(self.obj, Elm_Entry_Filter_Cb func, void *data)
|
||||
|
@ -1808,9 +1808,9 @@ cdef class Entry(Object):
|
|||
# mutually exclusive. This structure must be available for as long as
|
||||
# the entry is alive AND the elm_entry_filter_accept_set is being used.
|
||||
|
||||
# The @c accepted set takes preference, so if it is set, the filter will
|
||||
# The ``accepted`` set takes preference, so if it is set, the filter will
|
||||
# only work based on the accepted characters, ignoring anything in the
|
||||
# @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
|
||||
# ``rejected`` value. If ``accepted`` is ``None``, then ``rejected`` is used.
|
||||
|
||||
# In both cases, the function filters by matching utf8 characters to the
|
||||
# raw markup text, so it can be used to remove formatting tags.
|
||||
|
|
|
@ -186,7 +186,7 @@ cdef class FlipSelectorItem(ObjectItem):
|
|||
This sets whether ``item`` is or not the selected (thus, under
|
||||
display) one. If ``item`` is different than the one under display,
|
||||
the latter will be unselected. If the ``item`` is set to be
|
||||
unselected, on the other hand, the B{first} item in the widget's
|
||||
unselected, on the other hand, the **first** item in the widget's
|
||||
internal members list will be the new selected one.
|
||||
|
||||
:type: bool
|
||||
|
|
|
@ -341,9 +341,9 @@ def cache_all_flush():
|
|||
# def font_available_hash_add(list):
|
||||
# """Create a font hash table of available system fonts.
|
||||
|
||||
# One must call it with @p list being the return value of
|
||||
# One must call it with ``list`` being the return value of
|
||||
# evas_font_available_list(). The hash will be indexed by font
|
||||
# (family) names, being its values @c Elm_Font_Properties blobs.
|
||||
# (family) names, being its values ``Elm_Font_Properties`` blobs.
|
||||
|
||||
# :param list: The list of available system fonts, as returned by
|
||||
# evas_font_available_list().
|
||||
|
|
|
@ -174,8 +174,8 @@ Smart events that you can add callbacks for are:
|
|||
- ``"unselected"`` - The user has made an item unselected. The
|
||||
``event_info`` parameter is the gengrid item that was unselected.
|
||||
- ``"realized"`` - This is called when the item in the gengrid
|
||||
has its implementing Evas object instantiated, de facto. @c
|
||||
event_info is the gengrid item that was created. The object
|
||||
has its implementing Evas object instantiated, de facto.
|
||||
``event_info`` is the gengrid item that was created. The object
|
||||
may be deleted at any time, so it is highly advised to the
|
||||
caller **not** to use the object pointer returned from
|
||||
elm_gengrid_item_object_get(), because it may point to freed
|
||||
|
@ -811,7 +811,7 @@ cdef class GengridItem(ObjectItem):
|
|||
"""show(int scrollto_type = ELM_GENLIST_ITEM_SCROLLTO_IN)
|
||||
|
||||
This causes gengrid to **redraw** its viewport's contents to the
|
||||
region containing the given @p item item, if it is not fully
|
||||
region containing the given ``item``, if it is not fully
|
||||
visible.
|
||||
|
||||
.. seealso:: :py:func:`bring_in()`
|
||||
|
@ -1204,8 +1204,8 @@ cdef class Gengrid(Object):
|
|||
# XXX TODO elm_gengrid_item_sorted_insert()
|
||||
|
||||
property selected_item:
|
||||
"""This returns the selected item in @p obj. If multi selection is
|
||||
enabled on @p obj (.. seealso:: :py:func:`multi_select_set()),` only
|
||||
"""This returns the selected item in ``obj``. If multi selection is
|
||||
enabled on ``obj`` (.. seealso:: :py:func:`multi_select_set()),` only
|
||||
the first item in the list is selected, which might not be very
|
||||
useful. For that case, see elm_gengrid_selected_items_get().
|
||||
|
||||
|
@ -1326,7 +1326,7 @@ cdef class Gengrid(Object):
|
|||
property item_size:
|
||||
"""A gengrid, after creation, has still no information on the size
|
||||
to give to each of its cells. So, you most probably will end up
|
||||
with squares one @ref Fingers "finger" wide, the default
|
||||
with squares one :ref:`Fingers` "finger" wide, the default
|
||||
size. Use this property to force a custom size for you items,
|
||||
making them as big as you wish.
|
||||
|
||||
|
@ -1475,7 +1475,7 @@ cdef class Gengrid(Object):
|
|||
|
||||
This function sets the size of a page of the gengrid, in pixels,
|
||||
for each axis. Sane usable values are, between ``0`` and the
|
||||
dimensions of @p obj, for each axis. Values beyond those will
|
||||
dimensions of ``obj``, for each axis. Values beyond those will
|
||||
make it behave behave inconsistently. If you only want one axis
|
||||
to snap to pages, use the value ``0`` for the other one.
|
||||
|
||||
|
|
|
@ -98,9 +98,9 @@ Available item styles:
|
|||
- icon_top_text_bottom
|
||||
- group_index
|
||||
|
||||
- one_icon - Only 1 icon (left) @since 1.1
|
||||
- end_icon - Only 1 icon (at end/right) @since 1.1
|
||||
- no_icon - No icon (at end/right) @since 1.1
|
||||
- one_icon - Only 1 icon (left) :since: 1.1
|
||||
- end_icon - Only 1 icon (at end/right) :since: 1.1
|
||||
- no_icon - No icon (at end/right) :since: 1.1
|
||||
|
||||
Structure of items
|
||||
==================
|
||||
|
@ -120,14 +120,14 @@ spaces in the data fields. For the default genlist item theme, we have
|
|||
|
||||
A genlist item may be at one of several styles. Elementary provides one
|
||||
by default - "default", but this can be extended by system or application
|
||||
custom themes/overlays/extensions (see @ref Theme "themes" for more
|
||||
custom themes/overlays/extensions (see :ref:`Theme` "themes" for more
|
||||
details).
|
||||
|
||||
Editing and Navigating
|
||||
======================
|
||||
|
||||
Items can be added by several calls. All of them return a @ref
|
||||
Elm_Object_Item handle that is an internal member inside the genlist.
|
||||
Items can be added by several calls. All of them return a
|
||||
:ref:`Elm_Object_Item` handle that is an internal member inside the genlist.
|
||||
They all take a data parameter that is meant to be used for a handle to
|
||||
the applications internal data (eg. the struct with the original item
|
||||
data). The parent parameter is the parent genlist item this belongs to if
|
||||
|
|
|
@ -1305,8 +1305,8 @@ cdef class Object(evasObject):
|
|||
Set the content to be shown in the tooltip object
|
||||
|
||||
Setup the tooltip to object. The object can have only one tooltip,
|
||||
so any previews tooltip data is removed. C{func(owner, tooltip,
|
||||
args, kargs)} will be called every time that need show the tooltip
|
||||
so any previews tooltip data is removed. ``func(owner, tooltip,
|
||||
args, kargs)`` will be called every time that need show the tooltip
|
||||
and it should return a valid Evas_Object. This object is then
|
||||
managed fully by tooltip system and is deleted when the tooltip is
|
||||
gone.
|
||||
|
@ -1627,13 +1627,13 @@ cdef class Object(evasObject):
|
|||
|
||||
Gets the current selection data from a widget.
|
||||
The widget input here will usually be elm_entry,
|
||||
in which case @p datacb and @p udata can be NULL.
|
||||
If a different widget is passed, @p datacb and @p udata are used for retrieving data.
|
||||
in which case ``datacb`` and ``udata`` can be None.
|
||||
If a different widget is passed, ``datacb`` and ``udata`` are used for retrieving data.
|
||||
|
||||
:param selection: Selection type for copying and pasting
|
||||
:param format: Selection format
|
||||
:param datacb: The user data callback if the target widget isn't elm_entry
|
||||
:param udata: The user data pointer for @p datacb
|
||||
:param udata: The user data pointer for ``datacb``
|
||||
|
||||
:raise RuntimeError: if getting cnp data fails.
|
||||
|
||||
|
@ -1662,9 +1662,9 @@ cdef class Object(evasObject):
|
|||
def cnp_selection_loss_callback_set(self, Elm_Sel_Type selection, func, data = None):
|
||||
"""Set a function to be called when a selection is lost
|
||||
|
||||
The function @p func is set of be called when selection @p selection is lost
|
||||
to another process or when elm_cnp_selection_set() is called. If @p func
|
||||
is NULL then it is not called. @p data is passed as the data parameter to
|
||||
The function ``func`` is set of be called when selection ``selection`` is lost
|
||||
to another process or when elm_cnp_selection_set() is called. If ``func``
|
||||
is NULL then it is not called. ``data`` is passed as the data parameter to
|
||||
the callback functions and selection is passed in as the selection that
|
||||
has been lost.
|
||||
|
||||
|
@ -1729,14 +1729,14 @@ cdef class Object(evasObject):
|
|||
# :param data: The drag data itself (a string)
|
||||
# :param action: The drag action to be done
|
||||
# :param createicon: Function to call to create a drag object, or NULL if not wanted
|
||||
# :param createdata: Application data passed to @p createicon
|
||||
# :param createdata: Application data passed to ``createicon``
|
||||
# :param dragpos: Function called with each position of the drag, x, y being screen coordinates if possible, and action being the current action.
|
||||
# :param dragdata: Application data passed to @p dragpos
|
||||
# :param dragdata: Application data passed to ``dragpos``
|
||||
# :param acceptcb: Function called indicating if drop target accepts (or does not) the drop data while dragging
|
||||
|
||||
# :param acceptdata: Application data passed to @p acceptcb
|
||||
# :param acceptdata: Application data passed to ``acceptcb``
|
||||
# :param dragdone: Function to call when drag is done
|
||||
# :param donecbdata: Application data to pass to @p dragdone
|
||||
# :param donecbdata: Application data to pass to ``dragdone``
|
||||
# :raise RuntimeError: if starting drag fails.
|
||||
|
||||
# :since: 1.8
|
||||
|
|
|
@ -248,14 +248,14 @@ cdef class ObjectItem(object):
|
|||
|
||||
Set the text for an object item's part, marking it as translatable.
|
||||
|
||||
The string to set as @p text must be the original one. Do not pass the
|
||||
return of @c gettext() here. Elementary will translate the string
|
||||
The string to set as ``text`` must be the original one. Do not pass the
|
||||
return of ``gettext()`` here. Elementary will translate the string
|
||||
internally and set it on the object item using
|
||||
elm_object_item_part_text_set(), also storing the original string so that it
|
||||
can be automatically translated when the language is changed with
|
||||
elm_language_set(). The @p domain will be stored along to find the
|
||||
translation in the correct catalog. It can be NULL, in which case it will use
|
||||
whatever domain was set by the application with @c textdomain(). This is
|
||||
elm_language_set(). The ``domain`` will be stored along to find the
|
||||
translation in the correct catalog. It can be None, in which case it will use
|
||||
whatever domain was set by the application with ``textdomain()``. This is
|
||||
useful in case you are building a library on top of Elementary that will have
|
||||
its own translatable strings, that should not be mixed with those of programs
|
||||
using the library.
|
||||
|
@ -281,7 +281,7 @@ cdef class ObjectItem(object):
|
|||
Gets the original string set as translatable for an object item.
|
||||
|
||||
When setting translated strings, the function elm_object_item_part_text_get()
|
||||
will return the translation returned by @c gettext(). To get the original
|
||||
will return the translation returned by ``gettext()``. To get the original
|
||||
string use this function.
|
||||
|
||||
:param part: The name of the part that was set
|
||||
|
|
|
@ -31,8 +31,8 @@ A progress bar may be horizontal or vertical. It may display an icon
|
|||
besides it, as well as primary and **units** labels. The former is meant
|
||||
to label the widget as a whole, while the latter, which is formatted
|
||||
with floating point values (and thus accepts a ``printf``-style format
|
||||
string, like ``"%1.2f units"``), is meant to label the widget's B{progress
|
||||
value}. Label, icon and unit strings/objects are **optional** for
|
||||
string, like ``"%1.2f units"``), is meant to label the widget's **progress
|
||||
value**. Label, icon and unit strings/objects are **optional** for
|
||||
progress bars.
|
||||
|
||||
A progress bar may be **inverted**, in which case it gets its values
|
||||
|
@ -201,9 +201,9 @@ cdef class Progressbar(LayoutClass):
|
|||
# property unit_format_function:
|
||||
# """Set the callback function to format the unit string.
|
||||
|
||||
# @see: L{unit_format} for more info on how this works.
|
||||
# :see: :py:attr:`unit_format` for more info on how this works.
|
||||
|
||||
# @type: function
|
||||
# :type: function
|
||||
|
||||
# """
|
||||
# def __set__(self, func not None):
|
||||
|
|
|
@ -205,7 +205,7 @@ cdef class Slider(LayoutClass):
|
|||
#~
|
||||
#~ Set the callback function to format the units string.
|
||||
#~
|
||||
#~ .. seealso:: L{units_format_set() for more info on how this works.
|
||||
#~ .. seealso:: :py:attr:`units_format_set()` for more info on how this works.
|
||||
#~
|
||||
#~ :param func: The units format function.
|
||||
#~ :type func: function
|
||||
|
|
|
@ -285,7 +285,7 @@ cdef class Store(object):
|
|||
def delete(self):
|
||||
"""Free the store object and all items it manages
|
||||
|
||||
This frees the given @p st store and all the items it manages. It will
|
||||
This frees the given store and all the items it manages. It will
|
||||
clear the List that it populated, but otherwise leave it alone. It will
|
||||
cancel background threads (and may have to wait for them to complete a
|
||||
pending operation to do this).
|
||||
|
@ -296,7 +296,7 @@ cdef class Store(object):
|
|||
property filesystem_directory:
|
||||
"""The path to the directory to scan for a filesystem store
|
||||
|
||||
This sets the directory (@p dir) to scan and begins scanning in the
|
||||
This sets the directory to scan and begins scanning in the
|
||||
the background in threads (or not if threading is disabled with
|
||||
elm_store_fetch_thread_set()). Note that Listing is always done in a thread
|
||||
but fetching may not be if disabled here. This should be the last thing
|
||||
|
|
|
@ -253,15 +253,15 @@ cdef class Map(object):
|
|||
This applies a given perspective (3D) to the map coordinates. X, Y and Z
|
||||
values are used. The px and py points specify the "infinite distance" point
|
||||
in the 3D conversion (where all lines converge to like when artists draw
|
||||
3D by hand). The @p z0 value specifies the z value at which there is a 1:1
|
||||
3D by hand). The ``z0`` value specifies the z value at which there is a 1:1
|
||||
mapping between spatial coordinates and screen coordinates. Any points
|
||||
on this z value will not have their X and Y values modified in the transform.
|
||||
Those further away (Z value higher) will shrink into the distance, and
|
||||
those less than this value will expand and become bigger. The @p foc value
|
||||
those less than this value will expand and become bigger. The ``foc`` value
|
||||
determines the "focal length" of the camera. This is in reality the distance
|
||||
between the camera lens plane itself (at or closer than this rendering
|
||||
results are undefined) and the "z0" z value. This allows for some "depth"
|
||||
control and @p foc must be greater than 0.
|
||||
control and ``foc`` must be greater than 0.
|
||||
|
||||
:param m: map to change.
|
||||
:param px: The perspective distance X coordinate
|
||||
|
|
|
@ -1743,17 +1743,17 @@ cdef class Object(Eo):
|
|||
return ret
|
||||
|
||||
def key_grab(self, keyname not None, Evas_Modifier_Mask modifiers, Evas_Modifier_Mask not_modifiers, bint exclusive):
|
||||
"""Requests @p keyname key events be directed to @p obj.
|
||||
"""Requests ``keyname`` key events be directed to ``obj``.
|
||||
|
||||
:param keyname: the key to request events for.
|
||||
:param modifiers: a mask of modifiers that must be present to
|
||||
trigger the event.
|
||||
:type modifiers: Evas_Modifier_Mask
|
||||
:param not_modifiers: a mask of modifiers that must @b not be present
|
||||
:param not_modifiers: a mask of modifiers that must **not** be present
|
||||
to trigger the event.
|
||||
:type not_modifiers: Evas_Modifier_Mask
|
||||
:param exclusive: request that the @p obj is the only object
|
||||
receiving the @p keyname events.
|
||||
:param exclusive: request that the ``obj`` is the only object
|
||||
receiving the ``keyname`` events.
|
||||
:type exclusive: bool
|
||||
:raise RuntimeError: if grabbing the key was unsuccesful
|
||||
|
||||
|
@ -1762,28 +1762,28 @@ cdef class Object(Eo):
|
|||
key is grabbed, only the objects grabbing it will get the events
|
||||
for the given keys.
|
||||
|
||||
@p keyname is a platform dependent symbolic name for the key
|
||||
pressed (see @ref Evas_Keys for more information).
|
||||
``keyname`` is a platform dependent symbolic name for the key
|
||||
pressed (see :ref:`Evas_Keys` for more information).
|
||||
|
||||
@p modifiers and @p not_modifiers are bit masks of all the
|
||||
``modifiers`` and ``not_modifiers`` are bit masks of all the
|
||||
modifiers that must and mustn't, respectively, be pressed along
|
||||
with @p keyname key in order to trigger this new key
|
||||
with ``keyname`` key in order to trigger this new key
|
||||
grab. Modifiers can be things such as Shift and Ctrl as well as
|
||||
user defined types via evas_key_modifier_add(). Retrieve them with
|
||||
evas_key_modifier_mask_get() or use @c 0 for empty masks.
|
||||
evas_key_modifier_mask_get() or use ``0`` for empty masks.
|
||||
|
||||
@p exclusive will make the given object the only one permitted to
|
||||
grab the given key. If given @c EINA_TRUE, subsequent calls on this
|
||||
function with different @p obj arguments will fail, unless the key
|
||||
``exclusive`` will make the given object the only one permitted to
|
||||
grab the given key. If given ``EINA_TRUE``, subsequent calls on this
|
||||
function with different ``obj`` arguments will fail, unless the key
|
||||
is ungrabbed again.
|
||||
|
||||
.. warning:: Providing impossible modifier sets creates undefined behavior
|
||||
|
||||
@see evas_object_key_ungrab
|
||||
@see evas_object_focus_set
|
||||
@see evas_object_focus_get
|
||||
@see evas_focus_get
|
||||
@see evas_key_modifier_add
|
||||
:see: evas_object_key_ungrab
|
||||
:see: evas_object_focus_set
|
||||
:see: evas_object_focus_get
|
||||
:see: evas_focus_get
|
||||
:see: evas_key_modifier_add
|
||||
|
||||
"""
|
||||
if isinstance(keyname, unicode): keyname = PyUnicode_AsUTF8String(keyname)
|
||||
|
@ -1791,7 +1791,7 @@ cdef class Object(Eo):
|
|||
raise RuntimeError("Could not grab key.")
|
||||
|
||||
def key_ungrab(self, keyname not None, Evas_Modifier_Mask modifiers, Evas_Modifier_Mask not_modifiers):
|
||||
"""Removes the grab on @p keyname key events by @p obj.
|
||||
"""Removes the grab on ``keyname`` key events by ``obj``.
|
||||
|
||||
:param keyname: the key the grab is set for.
|
||||
:param modifiers: a mask of modifiers that must be present to
|
||||
|
@ -1799,13 +1799,13 @@ cdef class Object(Eo):
|
|||
:param not_modifiers: a mask of modifiers that must not not be
|
||||
present to trigger the event.
|
||||
|
||||
Removes a key grab on @p obj if @p keyname, @p modifiers, and @p
|
||||
not_modifiers match.
|
||||
Removes a key grab on ``obj`` if ``keyname``, ``modifiers``, and
|
||||
``not_modifiers`` match.
|
||||
|
||||
@see evas_object_key_grab
|
||||
@see evas_object_focus_set
|
||||
@see evas_object_focus_get
|
||||
@see evas_focus_get
|
||||
:see: evas_object_key_grab
|
||||
:see: evas_object_focus_set
|
||||
:see: evas_object_focus_get
|
||||
:see: evas_focus_get
|
||||
|
||||
"""
|
||||
if isinstance(keyname, unicode): keyname = PyUnicode_AsUTF8String(keyname)
|
||||
|
|
|
@ -29,7 +29,7 @@ cdef class Box(Object):
|
|||
|
||||
|
||||
:param canvas: The evas canvas for this object
|
||||
:type canvas: L{Canvas}
|
||||
:type canvas: :py:class:`Canvas`
|
||||
:keyword size: Width and height
|
||||
:type size: tuple of ints
|
||||
:keyword pos: X and Y
|
||||
|
@ -148,18 +148,18 @@ cdef class Box(Object):
|
|||
evas_object_box_prepend(self.obj, child.obj)
|
||||
|
||||
def insert_before(self, Object child, Object reference):
|
||||
"""Insert a new @a child object **before another existing one**, in
|
||||
a given box object @a o.
|
||||
"""Insert a new ``child`` object **before another existing one**, in
|
||||
a given box object.
|
||||
|
||||
:param child: A child Evas object to be made a member of **o**
|
||||
:param child: A child Evas object to be made a member of this object
|
||||
:param reference: The child object to place this new one before
|
||||
:return: A box option bound to the recently added box item or ``NULL``, on errors
|
||||
:return: A box option bound to the recently added box item or ``None``, on errors
|
||||
|
||||
On success, the ``"child,added"`` smart event will take place.
|
||||
|
||||
.. note::
|
||||
|
||||
This function will fail if **reference** is not a member of @p o.
|
||||
This function will fail if **reference** is not a member of this object.
|
||||
|
||||
.. note::
|
||||
|
||||
|
@ -172,25 +172,26 @@ cdef class Box(Object):
|
|||
_Evas_Object_Box_Api::insert_before smart function.
|
||||
|
||||
"""
|
||||
# TODO: raise exception if unsuccesful
|
||||
evas_object_box_insert_before(self.obj, child.obj, reference.obj)
|
||||
|
||||
def insert_after(self, Object child, Object reference):
|
||||
"""Insert a new @a child object **after another existing one**, in
|
||||
a given box object @a o.
|
||||
"""Insert a new ``child`` object **after another existing one**, in
|
||||
this box object.
|
||||
|
||||
:param child: A child Evas object to be made a member of **o**
|
||||
:param child: A child Evas object to be made a member of this object
|
||||
:param reference: The child object to place this new one after
|
||||
:return: A box option bound to the recently added box item or ``NULL``, on errors
|
||||
:return: A box option bound to the recently added box item or ``None``, on errors
|
||||
|
||||
On success, the ``"child,added"`` smart event will take place.
|
||||
|
||||
.. note::
|
||||
|
||||
This function will fail if **reference** is not a member of @p o.
|
||||
This function will fail if **reference** is not a member of this object.
|
||||
|
||||
.. note::
|
||||
|
||||
The actual placing of the item relative to **o**'s area will
|
||||
The actual placing of the item relative to this objects area will
|
||||
depend on the layout set to it.
|
||||
|
||||
.. note::
|
||||
|
@ -199,27 +200,28 @@ cdef class Box(Object):
|
|||
_Evas_Object_Box_Api::insert_after smart function.
|
||||
|
||||
"""
|
||||
# TODO: raise exception if unsuccesful
|
||||
evas_object_box_insert_after(self.obj, child.obj, reference.obj)
|
||||
|
||||
def insert_at(self, Object child, unsigned int pos):
|
||||
"""Insert a new @a child object **at a given position**, in a given
|
||||
box object @a o.
|
||||
"""Insert a new ``child`` object **at a given position**, in this
|
||||
box object.
|
||||
|
||||
:param child: A child Evas object to be made a member of **o**
|
||||
:param child: A child Evas object to be made a member of this object
|
||||
:param pos: The numeric position (starting from ``0``) to place the
|
||||
new child object at
|
||||
:return: A box option bound to the recently added box item or ``NULL``, on errors
|
||||
:return: A box option bound to the recently added box item or ``None``, on errors
|
||||
|
||||
On success, the ``"child,added"`` smart event will take place.
|
||||
|
||||
.. note::
|
||||
|
||||
This function will fail if the given position is invalid,
|
||||
given **o**'s internal list of elements.
|
||||
given this objects internal list of elements.
|
||||
|
||||
.. note::
|
||||
|
||||
The actual placing of the item relative to **o**'s area will
|
||||
The actual placing of the item relative to this objects area will
|
||||
depend on the layout set to it.
|
||||
|
||||
.. note::
|
||||
|
|
|
@ -23,7 +23,7 @@ cdef class Grid(Object):
|
|||
|
||||
@classmethod
|
||||
def add_to(cls, Object parent):
|
||||
"""Create a grid that is child of a given element @a parent."""
|
||||
"""Create a grid that is child of a given element ``parent``."""
|
||||
Object._set_obj(cls, evas_object_grid_add_to(parent.obj))
|
||||
|
||||
property grid_size:
|
||||
|
|
|
@ -160,22 +160,22 @@ cdef class Image(Object):
|
|||
|
||||
# This is the same as evas_object_image_file_set() but the file to be loaded
|
||||
# may exist at an address in memory (the data for the file, not the filename
|
||||
# itself). The @p data at the address is copied and stored for future use, so
|
||||
# no @p data needs to be kept after this call is made. It will be managed and
|
||||
# freed for you when no longer needed. The @p size is limited to 2 gigabytes
|
||||
# in size, and must be greater than 0. A @c NULL @p data pointer is also
|
||||
# invalid. Set the filename to @c NULL to reset to empty state and have the
|
||||
# itself). The ``data`` at the address is copied and stored for future use, so
|
||||
# no ``data`` needs to be kept after this call is made. It will be managed and
|
||||
# freed for you when no longer needed. The ``size`` is limited to 2 gigabytes
|
||||
# in size, and must be greater than 0. A ``None`` ``data`` pointer is also
|
||||
# invalid. Set the filename to ``None`` to reset to empty state and have the
|
||||
# image file data freed from memory using evas_object_image_file_set().
|
||||
|
||||
# The @p format is optional (pass @c NULL if you don't need/use it). It is
|
||||
# The ``format`` is optional (pass ``None`` if you don't need/use it). It is
|
||||
# used to help Evas guess better which loader to use for the data. It may
|
||||
# simply be the "extension" of the file as it would normally be on disk
|
||||
# such as "jpg" or "png" or "gif" etc.
|
||||
|
||||
# @param data The image file data address
|
||||
# @param size The size of the image file data in bytes
|
||||
# @param format The format of the file (optional), or @c NULL if not needed
|
||||
# @param key The image key in file, or @c NULL.
|
||||
# :param data: The image file data address
|
||||
# :param size: The size of the image file data in bytes
|
||||
# :param format: The format of the file (optional), or ``None`` if not needed
|
||||
# :param key: The image key in file, or ``None``.
|
||||
|
||||
# """
|
||||
# if isinstance(format, unicode): format = PyUnicode_AsUTF8String(format)
|
||||
|
@ -474,15 +474,15 @@ cdef class Image(Object):
|
|||
|
||||
# Note that this function does not modify the raw image data. If the
|
||||
# requested colorspace is the same as the image colorspace nothing is
|
||||
# done and @c NULL is returned. You should use
|
||||
# done and ``NULL`` is returned. You should use
|
||||
# evas_object_image_colorspace_get() to check the current image
|
||||
# colorspace.
|
||||
|
||||
# See @ref evas_object_image_colorspace_get.
|
||||
|
||||
# @param obj The given image object.
|
||||
# @param to_cspace The colorspace to which the image raw data will be converted.
|
||||
# @return data A newly allocated data in the format specified by to_cspace.
|
||||
# :param obj: The given image object.
|
||||
# :param to_cspace: The colorspace to which the image raw data will be converted.
|
||||
# :return: A newly allocated data in the format specified by to_cspace.
|
||||
|
||||
# """
|
||||
# void *evas_object_image_data_convert(self.obj, Evas_Colorspace to_cspace) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
|
||||
|
@ -821,7 +821,7 @@ cdef class Image(Object):
|
|||
# property native_surface:
|
||||
# """The native surface of a given image of the canvas
|
||||
|
||||
# @param surf The new native surface.
|
||||
# :param surf: The new native surface.
|
||||
|
||||
# """
|
||||
# def __set__(self, value):
|
||||
|
@ -839,7 +839,7 @@ cdef class Image(Object):
|
|||
# property video_surface:
|
||||
# """The video surface linked to a given image of the canvas
|
||||
|
||||
# @param surf The new video surface.
|
||||
# :param surf: The new video surface.
|
||||
|
||||
# """
|
||||
# def __set__(self, value):
|
||||
|
@ -920,17 +920,17 @@ cdef class Image(Object):
|
|||
evas_object_image_alpha_mask_set(self.obj, ismask)
|
||||
|
||||
property image_source:
|
||||
"""The source object on an image object to used as a @b proxy.
|
||||
"""The source object on an image object to used as a **proxy**.
|
||||
|
||||
If an image object is set to behave as a @b proxy, it will mirror
|
||||
the rendering contents of a given @b source object in its drawing
|
||||
If an image object is set to behave as a **proxy**, it will mirror
|
||||
the rendering contents of a given **source** object in its drawing
|
||||
region, without affecting that source in any way. The source must
|
||||
be another valid Evas object. Other effects may be applied to the
|
||||
proxy, such as a map (see evas_object_map_set()) to create a
|
||||
reflection of the original object (for example).
|
||||
|
||||
Any existing source object on @p obj will be removed after this
|
||||
call. Setting @p src to @c NULL clears the proxy object (not in
|
||||
Any existing source object on ``obj`` will be removed after this
|
||||
call. Setting ``src`` to ``NULL`` clears the proxy object (not in
|
||||
"proxy state" anymore).
|
||||
|
||||
:type: Object
|
||||
|
@ -983,7 +983,7 @@ cdef class Image(Object):
|
|||
|
||||
.. seealso:: evas_object_image_source_set()
|
||||
|
||||
@since 1.8
|
||||
:since: 1.8
|
||||
|
||||
"""
|
||||
def __set__(self, value):
|
||||
|
@ -1014,7 +1014,7 @@ cdef class Image(Object):
|
|||
:py:attr:`source`
|
||||
:py:attr:`source_visible`
|
||||
|
||||
@since 1.8
|
||||
:since: 1.8
|
||||
|
||||
"""
|
||||
def __set__(self, value):
|
||||
|
|
|
@ -515,7 +515,7 @@ cdef class SmartObject(Object):
|
|||
def callback_del(self, char *event, func):
|
||||
"""Remove a smart callback.
|
||||
|
||||
Removes a callback that was added by L{callback_add()}.
|
||||
Removes a callback that was added by :py:func:`callback_add()`.
|
||||
|
||||
:param event: event name
|
||||
:param func: what to callback, should have be previously registered.
|
||||
|
@ -654,10 +654,10 @@ cdef class SmartObject(Object):
|
|||
evas_object_smart_calculate(self.obj)
|
||||
|
||||
def changed(self):
|
||||
"""Mark object as changed, so it's L{calculate()} will be called.
|
||||
"""Mark object as changed, so it's :py:func:`calculate()` will be called.
|
||||
|
||||
If an object is changed and it provides a calculate() method,
|
||||
it will be called from L{Canvas.render()}, what we call pre-render
|
||||
it will be called from :py:func:`Canvas.render()`, what we call pre-render
|
||||
calculate.
|
||||
|
||||
This can be used to postpone heavy calculations until you need to
|
||||
|
@ -705,56 +705,56 @@ cdef class SmartObject(Object):
|
|||
|
||||
# Factory
|
||||
def Rectangle(self, **kargs):
|
||||
"""Factory of children L{evas.Rectangle}.
|
||||
:rtype: L{Rectangle<evas.Rectangle>}
|
||||
"""Factory of children :py:class:`evas.Rectangle`.
|
||||
:rtype: :py:class:`Rectangle<evas.Rectangle>`
|
||||
"""
|
||||
obj = Rectangle(self.evas, **kargs)
|
||||
self.member_add(obj)
|
||||
return obj
|
||||
|
||||
def Line(self, **kargs):
|
||||
"""Factory of children L{evas.Line}.
|
||||
:rtype: L{Line<evas.Line>}
|
||||
"""Factory of children :py:class:`evas.Line`.
|
||||
:rtype: :py:class:`Line<evas.Line>`
|
||||
"""
|
||||
obj = Line(self.evas, **kargs)
|
||||
self.member_add(obj)
|
||||
return obj
|
||||
|
||||
# def Image(self, **kargs):
|
||||
# """Factory of children L{evas.Image}.
|
||||
# :rtype: L{Image<evas.Image>}
|
||||
# """Factory of children :py:class:`evas.Image`.
|
||||
# :rtype: :py:class:`Image<evas.Image>`
|
||||
# """
|
||||
# obj = Image(self.evas, **kargs)
|
||||
# self.member_add(obj)
|
||||
# return obj
|
||||
|
||||
# def FilledImage(self, **kargs):
|
||||
# """Factory of L{evas.FilledImage} associated with this canvas.
|
||||
# :rtype: L{FilledImage<evas.FilledImage>}
|
||||
# """Factory of :py:class:`evas.FilledImage` associated with this canvas.
|
||||
# :rtype: :py:class:`FilledImage<evas.FilledImage>`
|
||||
# """
|
||||
# obj = FilledImage(self.evas, **kargs)
|
||||
# self.member_add(obj)
|
||||
# return obj
|
||||
#
|
||||
# def Polygon(self, **kargs):
|
||||
# """Factory of children L{evas.Polygon}.
|
||||
# :rtype: L{Polygon<evas.Polygon>}
|
||||
# """Factory of children :py:class:`evas.Polygon`.
|
||||
# :rtype: :py:class:`Polygon<evas.Polygon>`
|
||||
# """
|
||||
# obj = Polygon(self.evas, **kargs)
|
||||
# self.member_add(obj)
|
||||
# return obj
|
||||
#
|
||||
# def Text(self, **kargs):
|
||||
# """Factory of children L{evas.Text}.
|
||||
# :rtype: L{Text<evas.Text>}
|
||||
# """Factory of children :py:class:`evas.Text`.
|
||||
# :rtype: :py:class:`Text<evas.Text>`
|
||||
# """
|
||||
# obj = Text(self.evas, **kargs)
|
||||
# self.member_add(obj)
|
||||
# return obj
|
||||
#
|
||||
# def Textblock(self, **kargs):
|
||||
# """Factory of children L{evas.Textblock}.
|
||||
# :rtype: L{Textblock<evas.Textblock>}
|
||||
# """Factory of children :py:class:`evas.Textblock`.
|
||||
# :rtype: :py:class:`Textblock<evas.Textblock>`
|
||||
# """
|
||||
# obj = Textblock(self.evas, **kargs)
|
||||
# self.member_add(obj)
|
||||
|
@ -772,8 +772,8 @@ cdef class ClippedSmartObject(SmartObject):
|
|||
|
||||
This class is optimized for the recommended SmartObject usage of
|
||||
having an internal clipper, with all member objects clipped to it and
|
||||
operations like L{hide()}, L{show()}, L{color_set()}, L{clip_set()} and
|
||||
L{clip_unset()} operating on it.
|
||||
operations like :py:func:`hide()`, :py:func:`show()`, :py:func:`color_set()`, :py:func:`clip_set()` and
|
||||
:py:func:`clip_unset()` operating on it.
|
||||
|
||||
This internal clipper size is huge by default (and not the same as the
|
||||
object size), this means that you should clip this object to another
|
||||
|
|
|
@ -113,9 +113,9 @@ cdef class Text(Object):
|
|||
:param size: The font size, in points.
|
||||
|
||||
This function allows the font name and size of a text object to be
|
||||
set. The @p font string has to follow fontconfig's convention on
|
||||
set. The ``font`` string has to follow fontconfig's convention on
|
||||
naming fonts, as it's the underlying library used to query system
|
||||
fonts by Evas (see the @c fc-list command's output, on your system,
|
||||
fonts by Evas (see the ``fc-list`` command's output, on your system,
|
||||
to get an idea).
|
||||
|
||||
:see: :py:attr:`font_source`
|
||||
|
|
Loading…
Reference in New Issue