Elm: Add documentation for the exceptions added earlier.
This commit is contained in:
parent
e9453b5a31
commit
f532a40fae
2
TODO
2
TODO
|
@ -62,6 +62,8 @@ CHANGES FROM 1.7 to 1.8
|
||||||
- efl.elementary.genlist.GenlistItem.tooltip_window_mode_set
|
- efl.elementary.genlist.GenlistItem.tooltip_window_mode_set
|
||||||
- efl.elementary.icon.Icon.standard_set
|
- efl.elementary.icon.Icon.standard_set
|
||||||
- efl.elementary.image.Image.file_set
|
- efl.elementary.image.Image.file_set
|
||||||
|
- efl.elementary.layout_class.LayoutClass.file_set
|
||||||
|
- efl.elementary.layout_class.LayoutClass.theme_set
|
||||||
- efl.elementary.layout_class.LayoutClass.box_append
|
- efl.elementary.layout_class.LayoutClass.box_append
|
||||||
- efl.elementary.layout_class.LayoutClass.box_prepend
|
- efl.elementary.layout_class.LayoutClass.box_prepend
|
||||||
- efl.elementary.layout_class.LayoutClass.box_insert_before
|
- efl.elementary.layout_class.LayoutClass.box_insert_before
|
||||||
|
|
|
@ -1057,6 +1057,7 @@ cdef class Entry(Object):
|
||||||
will be silently discarded and any non-saved changes will be lost.
|
will be silently discarded and any non-saved changes will be lost.
|
||||||
|
|
||||||
:type: tuple of strings (file, format)
|
:type: tuple of strings (file, format)
|
||||||
|
:raise RuntimeError: when setting the file fails
|
||||||
|
|
||||||
"""
|
"""
|
||||||
def __get__(self):
|
def __get__(self):
|
||||||
|
@ -1075,7 +1076,7 @@ cdef class Entry(Object):
|
||||||
if not elm_entry_file_set(self.obj,
|
if not elm_entry_file_set(self.obj,
|
||||||
<const_char *>a1 if a1 is not None else NULL,
|
<const_char *>a1 if a1 is not None else NULL,
|
||||||
<Elm_Text_Format>a2 if a2 is not None else ""):
|
<Elm_Text_Format>a2 if a2 is not None else ""):
|
||||||
raise RuntimeError
|
raise RuntimeError("Could not set file")
|
||||||
cpdef file_get(self):
|
cpdef file_get(self):
|
||||||
cdef const_char *file
|
cdef const_char *file
|
||||||
cdef Elm_Text_Format format
|
cdef Elm_Text_Format format
|
||||||
|
|
|
@ -205,6 +205,7 @@ cdef class Fileselector(LayoutClass):
|
||||||
widget
|
widget
|
||||||
|
|
||||||
:type: string
|
:type: string
|
||||||
|
:raise RuntimeError: when setting the selected file path fails
|
||||||
|
|
||||||
"""
|
"""
|
||||||
def __get__(self):
|
def __get__(self):
|
||||||
|
|
|
@ -1013,6 +1013,7 @@ cdef class GenlistItem(ObjectItem):
|
||||||
It will instead be limited only by the size of the display.
|
It will instead be limited only by the size of the display.
|
||||||
|
|
||||||
:type: bool
|
:type: bool
|
||||||
|
:raise RuntimeError: when setting the mode fails
|
||||||
|
|
||||||
"""
|
"""
|
||||||
def __set__(self, disable):
|
def __set__(self, disable):
|
||||||
|
|
|
@ -196,6 +196,7 @@ cdef class Icon(Image):
|
||||||
.. seealso:: Image.file
|
.. seealso:: Image.file
|
||||||
|
|
||||||
:type: string
|
:type: string
|
||||||
|
:raise RuntimeError: when setting the standard icon fails
|
||||||
|
|
||||||
"""
|
"""
|
||||||
def __get__(self):
|
def __get__(self):
|
||||||
|
|
|
@ -114,6 +114,7 @@ cdef class Image(Object):
|
||||||
the extension, :py:attr:`file_edje` must be used, instead.
|
the extension, :py:attr:`file_edje` must be used, instead.
|
||||||
|
|
||||||
:type: string or tuple of strings
|
:type: string or tuple of strings
|
||||||
|
:raise RuntimeError: when setting the file fails
|
||||||
|
|
||||||
"""
|
"""
|
||||||
def __set__(self, value):
|
def __set__(self, value):
|
||||||
|
|
|
@ -52,6 +52,7 @@ cdef class LayoutClass(Object):
|
||||||
layout.
|
layout.
|
||||||
|
|
||||||
:type: tuple of string
|
:type: tuple of string
|
||||||
|
:raise RuntimeError: when setting the file fails
|
||||||
|
|
||||||
"""
|
"""
|
||||||
def __set__(self, value):
|
def __set__(self, value):
|
||||||
|
@ -74,6 +75,7 @@ cdef class LayoutClass(Object):
|
||||||
:py:attr:`style`.
|
:py:attr:`style`.
|
||||||
|
|
||||||
:type: tuple of strings
|
:type: tuple of strings
|
||||||
|
:raise RuntimeError: when setting the theme fails
|
||||||
|
|
||||||
"""
|
"""
|
||||||
def __set__(self, theme):
|
def __set__(self, theme):
|
||||||
|
@ -175,8 +177,7 @@ cdef class LayoutClass(Object):
|
||||||
:param child: the child object to append to box.
|
:param child: the child object to append to box.
|
||||||
:type child: :py:class:`evas.object.Object`
|
:type child: :py:class:`evas.object.Object`
|
||||||
|
|
||||||
:return: ``True`` on success, ``False`` otherwise
|
:raise RuntimeError: when adding the box fails
|
||||||
:rtype: bool
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(part, unicode): part = part.encode("UTF-8")
|
if isinstance(part, unicode): part = part.encode("UTF-8")
|
||||||
|
@ -206,8 +207,7 @@ cdef class LayoutClass(Object):
|
||||||
:param child: the child object to prepend to box.
|
:param child: the child object to prepend to box.
|
||||||
:type child: :py:class:`evas.object.Object`
|
:type child: :py:class:`evas.object.Object`
|
||||||
|
|
||||||
:return: ``True`` on success, ``False`` otherwise
|
:raise RuntimeError: when adding to box fails
|
||||||
:rtype: bool
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(part, unicode): part = part.encode("UTF-8")
|
if isinstance(part, unicode): part = part.encode("UTF-8")
|
||||||
|
@ -239,8 +239,7 @@ cdef class LayoutClass(Object):
|
||||||
:param reference: another reference object to insert before in box.
|
:param reference: another reference object to insert before in box.
|
||||||
:type reference: :py:class:`evas.object.Object`
|
:type reference: :py:class:`evas.object.Object`
|
||||||
|
|
||||||
:return: ``True`` on success, ``False`` otherwise
|
:raise RuntimeError: when inserting to box fails
|
||||||
:rtype: bool
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(part, unicode): part = part.encode("UTF-8")
|
if isinstance(part, unicode): part = part.encode("UTF-8")
|
||||||
|
@ -272,8 +271,7 @@ cdef class LayoutClass(Object):
|
||||||
:param pos: the numeric position >=0 to insert the child.
|
:param pos: the numeric position >=0 to insert the child.
|
||||||
:type pos: int
|
:type pos: int
|
||||||
|
|
||||||
:return: ``True`` on success, ``False`` otherwise
|
:raise RuntimeError: when inserting to box fails
|
||||||
:rtype: bool
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(part, unicode): part = part.encode("UTF-8")
|
if isinstance(part, unicode): part = part.encode("UTF-8")
|
||||||
|
@ -329,8 +327,7 @@ cdef class LayoutClass(Object):
|
||||||
dangling on the canvas.
|
dangling on the canvas.
|
||||||
:type clear: bool
|
:type clear: bool
|
||||||
|
|
||||||
:return: ``True`` on success, ``False`` otherwise
|
:raise RuntimeError: when removing all items fails
|
||||||
:rtype: bool
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(part, unicode): part = part.encode("UTF-8")
|
if isinstance(part, unicode): part = part.encode("UTF-8")
|
||||||
|
@ -370,8 +367,7 @@ cdef class LayoutClass(Object):
|
||||||
:param rowspan: how many rows should be used to store this object. (>= 1)
|
:param rowspan: how many rows should be used to store this object. (>= 1)
|
||||||
:type rowspan: int
|
:type rowspan: int
|
||||||
|
|
||||||
:return: ``True`` on success, ``False`` otherwise
|
:raise RuntimeError: when packing an item fails
|
||||||
:rtype: bool
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(part, unicode): part = part.encode("UTF-8")
|
if isinstance(part, unicode): part = part.encode("UTF-8")
|
||||||
|
@ -427,8 +423,7 @@ cdef class LayoutClass(Object):
|
||||||
dangling on the canvas.
|
dangling on the canvas.
|
||||||
:type clear: bool
|
:type clear: bool
|
||||||
|
|
||||||
:return: ``True`` on success, ``False`` otherwise
|
:raise RuntimeError: when clearing the table fails
|
||||||
:rtype: bool
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(part, unicode): part = part.encode("UTF-8")
|
if isinstance(part, unicode): part = part.encode("UTF-8")
|
||||||
|
@ -533,9 +528,7 @@ cdef class LayoutClass(Object):
|
||||||
:param cursor: cursor name to use, see Elementary_Cursor.h
|
:param cursor: cursor name to use, see Elementary_Cursor.h
|
||||||
:type cursor: string
|
:type cursor: string
|
||||||
|
|
||||||
:return: True on success or False on failure, that may be
|
:raise RuntimeError: when setting the parts cursor fails
|
||||||
part not exists or it has "mouse_events: 0".
|
|
||||||
:rtype: bool
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(part_name, unicode): part_name = part_name.encode("UTF-8")
|
if isinstance(part_name, unicode): part_name = part_name.encode("UTF-8")
|
||||||
|
@ -568,8 +561,8 @@ cdef class LayoutClass(Object):
|
||||||
:param part_name: a part from loaded edje group, that had a cursor set
|
:param part_name: a part from loaded edje group, that had a cursor set
|
||||||
with :py:func:`part_cursor_set()`.
|
with :py:func:`part_cursor_set()`.
|
||||||
:type part_name: string
|
:type part_name: string
|
||||||
:return: ``True`` on success, ``False`` otherwise
|
|
||||||
:rtype: bool
|
:raise RuntimeError: when unsetting the part cursor fails
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(part_name, unicode): part_name = part_name.encode("UTF-8")
|
if isinstance(part_name, unicode): part_name = part_name.encode("UTF-8")
|
||||||
|
@ -587,9 +580,7 @@ cdef class LayoutClass(Object):
|
||||||
:param style: the theme style to use (default, transparent, ...)
|
:param style: the theme style to use (default, transparent, ...)
|
||||||
:type style: string
|
:type style: string
|
||||||
|
|
||||||
:return: True on success or False on failure, that may be
|
:raise RuntimeError: when setting the part cursor style fails
|
||||||
part not exists or it did not had a cursor set.
|
|
||||||
:rtype: bool
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(part_name, unicode): part_name = part_name.encode("UTF-8")
|
if isinstance(part_name, unicode): part_name = part_name.encode("UTF-8")
|
||||||
|
@ -636,6 +627,9 @@ cdef class LayoutClass(Object):
|
||||||
part not exists or it did not had a cursor set.
|
part not exists or it did not had a cursor set.
|
||||||
:rtype: bool
|
:rtype: bool
|
||||||
|
|
||||||
|
:raise RuntimeError: when setting the engine_only setting fails,
|
||||||
|
when part does not exist or has no cursor set.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if isinstance(part_name, unicode): part_name = part_name.encode("UTF-8")
|
if isinstance(part_name, unicode): part_name = part_name.encode("UTF-8")
|
||||||
if not elm_layout_part_cursor_engine_only_set(self.obj,
|
if not elm_layout_part_cursor_engine_only_set(self.obj,
|
||||||
|
|
|
@ -49,6 +49,7 @@ cdef class Photo(Object):
|
||||||
"""Set the file that will be used as photo
|
"""Set the file that will be used as photo
|
||||||
|
|
||||||
:type: string
|
:type: string
|
||||||
|
:raise RuntimeError: when setting the file fails
|
||||||
|
|
||||||
"""
|
"""
|
||||||
def __set__(self, filename):
|
def __set__(self, filename):
|
||||||
|
|
|
@ -103,6 +103,7 @@ cdef class Photocam(Object):
|
||||||
displayed at the full quality needed.
|
displayed at the full quality needed.
|
||||||
|
|
||||||
:type: string
|
:type: string
|
||||||
|
:raise RuntimeError: when setting the file fails
|
||||||
|
|
||||||
"""
|
"""
|
||||||
def __set__(self, file):
|
def __set__(self, file):
|
||||||
|
|
|
@ -46,6 +46,7 @@ cdef class Video(LayoutClass):
|
||||||
request and list the available Webcam on your system).
|
request and list the available Webcam on your system).
|
||||||
|
|
||||||
:type: string
|
:type: string
|
||||||
|
:raise RuntimeError: when setting the file/uri fails
|
||||||
|
|
||||||
"""
|
"""
|
||||||
def __set__(self, filename):
|
def __set__(self, filename):
|
||||||
|
|
Loading…
Reference in New Issue