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

Elementary: Improve documentation for Window, Entry, Hoversel, Label, 

List, Datetime and Dayselector.
This commit is contained in:
Kai Huuhko 2013-04-12 21:53:55 +00:00
parent b7e0b00d9a
commit 823363c6eb
7 changed files with 191 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

160
efl/elementary/datetime_elm.pyx
View File

@ -36,57 +36,80 @@ format.
Elm_datetime supports only the following sub set of libc date format specifiers: Elm_datetime supports only the following sub set of libc date format specifiers:
**%%Y** : The year as a decimal number including the century (example: 2011). **%%Y**
The year as a decimal number including the century (example: 2011).
**%%y** : The year as a decimal number without a century (range 00 to 99) **%%y**
The year as a decimal number without a century (range 00 to 99)
**%%m** : The month as a decimal number (range 01 to 12). **%%m**
The month as a decimal number (range 01 to 12).
**%%b** : The abbreviated month name according to the current locale. **%%b**
The abbreviated month name according to the current locale.
**%%B** : The full month name according to the current locale. **%%B**
The full month name according to the current locale.
**%%h** : The abbreviated month name according to the current locale(same as %%b). **%%h**
The abbreviated month name according to the current locale(same as %%b).
**%%d** : The day of the month as a decimal number (range 01 to 31). **%%d**
The day of the month as a decimal number (range 01 to 31).
**%%e** : The day of the month as a decimal number (range 1 to 31). single **%%e**
digits are preceded by a blank. The day of the month as a decimal number (range 1 to 31). single
digits are preceded by a blank.
**%%I** : The hour as a decimal number using a 12-hour clock (range 01 to 12). **%%I**
The hour as a decimal number using a 12-hour clock (range 01 to 12).
**%%H** : The hour as a decimal number using a 24-hour clock (range 00 to 23). **%%H**
The hour as a decimal number using a 24-hour clock (range 00 to 23).
**%%k** : The hour (24-hour clock) as a decimal number (range 0 to 23). single **%%k**
digits are preceded by a blank. The hour (24-hour clock) as a decimal number (range 0 to 23). single
digits are preceded by a blank.
**%%l** : The hour (12-hour clock) as a decimal number (range 1 to 12); single **%%l**
digits are preceded by a blank. The hour (12-hour clock) as a decimal number (range 1 to 12); single
digits are preceded by a blank.
**%%M** : The minute as a decimal number (range 00 to 59). **%%M**
The minute as a decimal number (range 00 to 59).
**%%p** : Either 'AM' or 'PM' according to the given time value, or the **%%p**
corresponding strings for the current locale. Noon is treated as 'PM' Either 'AM' or 'PM' according to the given time value, or the
and midnight as 'AM' corresponding strings for the current locale. Noon is treated as 'PM'
and midnight as 'AM'
**%%P** : Like %p but in lower case: 'am' or 'pm' or a corresponding string for **%%P**
the current locale. Like %p but in lower case: 'am' or 'pm' or a corresponding string for
the current locale.
**%%c** : The preferred date and time representation for the current locale. **%%c**
The preferred date and time representation for the current locale.
**%%x** : The preferred date representation for the current locale without the time. **%%x**
The preferred date representation for the current locale without the time.
**%%X** : The preferred time representation for the current locale without the date. **%%X**
The preferred time representation for the current locale without the date.
**%%r** : The complete calendar time using the AM/PM format of the current locale. **%%r**
The complete calendar time using the AM/PM format of the current locale.
**%%R** : The hour and minute in decimal numbers using the format %H:%M. **%%R**
The hour and minute in decimal numbers using the format %H:%M.
**%%T** : The time of day in decimal numbers using the format %H:%M:%S. **%%T**
The time of day in decimal numbers using the format %H:%M:%S.
**%%D** : The date using the format %%m/%%d/%%y. **%%D**
The date using the format %%m/%%d/%%y.
**%%F** : The date using the format %%Y-%%m-%%d. **%%F**
The date using the format %%Y-%%m-%%d.
(For more reference on the available **LIBC date format specifiers**, (For more reference on the available **LIBC date format specifiers**,
please visit the link: please visit the link:
@ -256,57 +279,80 @@ cdef class Datetime(Object):
Following are the allowed set of format specifiers for each datetime field. Following are the allowed set of format specifiers for each datetime field.
**%%Y** : The year as a decimal number including the century. **%%Y**
The year as a decimal number including the century.
**%%y** : The year as a decimal number without a century (range 00 to 99). **%%y**
The year as a decimal number without a century (range 00 to 99).
**%%m** : The month as a decimal number (range 01 to 12). **%%m**
The month as a decimal number (range 01 to 12).
**%%b** : The abbreviated month name according to the current locale. **%%b**
The abbreviated month name according to the current locale.
**%%B** : The full month name according to the current locale. **%%B**
The full month name according to the current locale.
**%%h** : The abbreviated month name according to the current locale(same as %%b). **%%h**
The abbreviated month name according to the current locale(same as %%b).
**%%d** : The day of the month as a decimal number (range 01 to 31). **%%d**
The day of the month as a decimal number (range 01 to 31).
**%%e** : The day of the month as a decimal number (range 1 to 31). single **%%e**
The day of the month as a decimal number (range 1 to 31). single
digits are preceded by a blank. digits are preceded by a blank.
**%%I** : The hour as a decimal number using a 12-hour clock (range 01 to 12). **%%I**
The hour as a decimal number using a 12-hour clock (range 01 to 12).
**%%H** : The hour as a decimal number using a 24-hour clock (range 00 to 23). **%%H**
The hour as a decimal number using a 24-hour clock (range 00 to 23).
**%%k** : The hour (24-hour clock) as a decimal number (range 0 to 23). single **%%k**
digits are preceded by a blank. The hour (24-hour clock) as a decimal number (range 0 to 23). single
digits are preceded by a blank.
**%%l** : The hour (12-hour clock) as a decimal number (range 1 to 12); single **%%l**
digits are preceded by a blank. The hour (12-hour clock) as a decimal number (range 1 to 12); single
digits are preceded by a blank.
**%%M** : The minute as a decimal number (range 00 to 59). **%%M**
The minute as a decimal number (range 00 to 59).
**%%p** : Either 'AM' or 'PM' according to the given time value, or the **%%p**
corresponding strings for the current locale. Noon is treated as 'PM' Either 'AM' or 'PM' according to the given time value, or the
and midnight as 'AM'. corresponding strings for the current locale. Noon is treated as 'PM'
and midnight as 'AM'.
**%%P** : Like %p but in lower case: 'am' or 'pm' or a corresponding string for **%%P**
the current locale. Like %p but in lower case: 'am' or 'pm' or a corresponding string for
the current locale.
**%%c** : The preferred date and time representation for the current locale. **%%c**
The preferred date and time representation for the current locale.
**%%x** : The preferred date representation for the current locale without the time. **%%x**
The preferred date representation for the current locale without the time.
**%%X** : The preferred time representation for the current locale without the date. **%%X**
The preferred time representation for the current locale without the date.
**%%r** : The complete calendar time using the AM/PM format of the current locale. **%%r**
The complete calendar time using the AM/PM format of the current locale.
**%%R** : The hour and minute in decimal numbers using the format %H:%M. **%%R**
The hour and minute in decimal numbers using the format %H:%M.
**%%T** : The time of day in decimal numbers using the format %H:%M:%S. **%%T**
The time of day in decimal numbers using the format %H:%M:%S.
**%%D** : The date using the format %%m/%%d/%%y. **%%D**
The date using the format %%m/%%d/%%y.
**%%F** : The date using the format %%Y-%%m-%%d. **%%F**
The date using the format %%Y-%%m-%%d.
These specifiers can be arranged in any order and the widget will display the These specifiers can be arranged in any order and the widget will display the
fields accordingly. fields accordingly.

18
efl/elementary/dayselector.pyx
View File

@ -69,6 +69,8 @@ Available styles for dayselector are:
- default - default
.. _Elm_Dayselector_Day:
.. rubric:: Dayselector days .. rubric:: Dayselector days
.. data:: ELM_DAYSELECTOR_SUN .. data:: ELM_DAYSELECTOR_SUN
@ -131,11 +133,8 @@ cdef class Dayselector(LayoutClass):
Set the state of given Dayselector_Day. Set the state of given Dayselector_Day.
.. seealso:: Elm_Dayselector_Day
.. seealso:: :py:func:`day_selected_get()`
:param day: The day that the user want to set state. :param day: The day that the user want to set state.
:type day: Elm_Dayselector_Day :type day: :ref:`Day <Elm_Dayselector_Day>`
:param selected: state of the day. ``True`` is selected. :param selected: state of the day. ``True`` is selected.
:type selected: bool :type selected: bool
@ -143,15 +142,12 @@ cdef class Dayselector(LayoutClass):
elm_dayselector_day_selected_set(self.obj, day, selected) elm_dayselector_day_selected_set(self.obj, day, selected)
def day_selected_get(self, day): def day_selected_get(self, day):
"""day_selected_get(int day): """day_selected_get(int day) -> bool
Get the state of given Dayselector_Day. Get the state of given Dayselector_Day.
.. seealso:: Elm_Dayselector_Day
.. seealso:: :py:func:`day_selected_set()`
:param day: The day that the user want to know state. :param day: The day that the user want to know state.
:type day: Elm_Dayselector_Day :type day: :ref:`Day <Elm_Dayselector_Day>`
:return: ``True``, if the Day is selected :return: ``True``, if the Day is selected
:rtype: bool :rtype: bool
@ -161,7 +157,7 @@ cdef class Dayselector(LayoutClass):
property week_start: property week_start:
"""The starting day of Dayselector. """The starting day of Dayselector.
:type: Elm_Dayselector_Day :type: :ref:`Day <Elm_Dayselector_Day>`
""" """
def __get__(self): def __get__(self):
@ -172,7 +168,7 @@ cdef class Dayselector(LayoutClass):
property weekend_start: property weekend_start:
"""The weekend starting day of Dayselector. """The weekend starting day of Dayselector.
:type: Elm_Dayselector_Day :type: :ref:`Day <Elm_Dayselector_Day>`
""" """
def __get__(self): def __get__(self):

38
efl/elementary/entry.pyx
View File

@ -215,15 +215,15 @@ This widget emits the following signals:
- "selection,cleared": The current selection has been cleared. - "selection,cleared": The current selection has been cleared.
- "cursor,changed": The cursor has changed position. - "cursor,changed": The cursor has changed position.
- "anchor,clicked": An anchor has been clicked. The event_info - "anchor,clicked": An anchor has been clicked. The event_info
parameter for the callback will be an *Elm_Entry_Anchor_Info*. parameter for the callback will be an :py:class:`EntryAnchorInfo`.
- "anchor,in": Mouse cursor has moved into an anchor. The event_info - "anchor,in": Mouse cursor has moved into an anchor. The event_info
parameter for the callback will be an *Elm_Entry_Anchor_Info*. parameter for the callback will be an :py:class:`EntryAnchorInfo`.
- "anchor,out": Mouse cursor has moved out of an anchor. The event_info - "anchor,out": Mouse cursor has moved out of an anchor. The event_info
parameter for the callback will be an *Elm_Entry_Anchor_Info*. parameter for the callback will be an :py:class:`EntryAnchorInfo`.
- "anchor,up": Mouse button has been unpressed on an anchor. The event_info - "anchor,up": Mouse button has been unpressed on an anchor. The event_info
parameter for the callback will be an *Elm_Entry_Anchor_Info*. parameter for the callback will be an :py:class:`EntryAnchorInfo`.
- "anchor,down": Mouse button has been pressed on an anchor. The event_info - "anchor,down": Mouse button has been pressed on an anchor. The event_info
parameter for the callback will be an *Elm_Entry_Anchor_Info*. parameter for the callback will be an :py:class:`EntryAnchorInfo`.
- "preedit,changed": The preedit string has changed. - "preedit,changed": The preedit string has changed.
- "language,changed": Program language changed. - "language,changed": Program language changed.
@ -237,6 +237,8 @@ Default text parts of the entry that you can use for are:
- "default" - text of the entry - "default" - text of the entry
.. _Elm_Cnp_Mode:
.. rubric:: Copy & paste modes .. rubric:: Copy & paste modes
.. data:: ELM_CNP_MODE_MARKUP .. data:: ELM_CNP_MODE_MARKUP
@ -252,6 +254,8 @@ Default text parts of the entry that you can use for are:
Copy & paste text without markup tags Copy & paste text without markup tags
.. _Elm_Input_Panel_Lang:
.. rubric:: Input panel language sort order .. rubric:: Input panel language sort order
.. data:: ELM_INPUT_PANEL_LANG_AUTOMATIC .. data:: ELM_INPUT_PANEL_LANG_AUTOMATIC
@ -263,6 +267,8 @@ Default text parts of the entry that you can use for are:
Alphabetic Alphabetic
.. _Elm_Input_Panel_Layout:
.. rubric:: Input panel layouts .. rubric:: Input panel layouts
.. data:: ELM_INPUT_PANEL_LAYOUT_NORMAL .. data:: ELM_INPUT_PANEL_LAYOUT_NORMAL
@ -314,6 +320,8 @@ Default text parts of the entry that you can use for are:
Like normal, but no auto-correct, no auto-capitalization etc. Like normal, but no auto-correct, no auto-capitalization etc.
.. _Elm_Input_Panel_Return_Key_Type:
.. rubric:: Input panel return key modes .. rubric:: Input panel return key modes
.. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT .. data:: ELM_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT
@ -349,6 +357,8 @@ Default text parts of the entry that you can use for are:
Send Send
.. _Elm_Scroller_Policy:
.. rubric:: Scrollbar visibility .. rubric:: Scrollbar visibility
.. data:: ELM_SCROLLER_POLICY_AUTO .. data:: ELM_SCROLLER_POLICY_AUTO
@ -364,6 +374,8 @@ Default text parts of the entry that you can use for are:
Scrollbars are never visible Scrollbars are never visible
.. _Elm_Text_Format:
.. rubric:: Text format .. rubric:: Text format
.. data:: ELM_TEXT_FORMAT_PLAIN_UTF8 .. data:: ELM_TEXT_FORMAT_PLAIN_UTF8
@ -375,6 +387,8 @@ Default text parts of the entry that you can use for are:
UTF-8 with markup UTF-8 with markup
.. _Elm_Wrap_Type:
.. rubric:: Wrap mode .. rubric:: Wrap mode
.. data:: ELM_WRAP_NONE .. data:: ELM_WRAP_NONE
@ -745,7 +759,7 @@ cdef class Entry(Object):
Note that this only makes sense for multi-line entries. A widget set Note that this only makes sense for multi-line entries. A widget set
to be single line will never wrap. to be single line will never wrap.
:type: Elm_Wrap_Type :type: :ref:`Line wrapping mode <Elm_Wrap_Type>`
""" """
def __get__(self): def __get__(self):
@ -1157,7 +1171,7 @@ cdef class Entry(Object):
will automatically disable the display of scrollbars when the entry will automatically disable the display of scrollbars when the entry
moves inside its scroller. moves inside its scroller.
:type: tuple of Elm_Scroller_Policy (h, v) :type: (:ref:`Scroll policy <Elm_Scroller_Policy>` **h**, :ref:`Scroll policy <Elm_Scroller_Policy>` **v**)
""" """
def __set__(self, value): def __set__(self, value):
@ -1172,7 +1186,7 @@ cdef class Entry(Object):
"""Whether the entry will bounce when scrolling reaches """Whether the entry will bounce when scrolling reaches
the end of the contained entry. the end of the contained entry.
:type: tuple of bools (h_bounce, v_bounce) :type: (bool **h_bounce**, bool **v_bounce**)
""" """
def __get__(self): def __get__(self):
@ -1195,7 +1209,7 @@ cdef class Entry(Object):
property input_panel_layout: property input_panel_layout:
"""The input panel layout of the entry """The input panel layout of the entry
:type: Elm_Input_Panel_Layout :type: :ref:`Input panel layout <Elm_Input_Panel_Layout>`
""" """
def __get__(self): def __get__(self):
@ -1258,7 +1272,7 @@ cdef class Entry(Object):
This API can be used if you want to show the alphabet keyboard mode. This API can be used if you want to show the alphabet keyboard mode.
:type: Elm_Input_Panel_Lang :type: :ref:`Input panel language <Elm_Input_Panel_Lang>`
""" """
def __get__(self): def __get__(self):
@ -1282,7 +1296,7 @@ cdef class Entry(Object):
An input panel displays the string or icon associated with this type An input panel displays the string or icon associated with this type
:type: Elm_Input_Panel_Return_Key_Type :type: :ref:`Input panel return key type <Elm_Input_Panel_Return_Key_Type>`
""" """
def __get__(self): def __get__(self):
@ -1373,7 +1387,7 @@ cdef class Entry(Object):
.. note:: This only changes the behaviour of text. .. note:: This only changes the behaviour of text.
:type: Elm_Cnp_Mode :type: :ref:`Copy and paste mode <Elm_Cnp_Mode>`
""" """
def __get__(self): def __get__(self):

6
efl/elementary/hoversel.pyx
View File

@ -49,6 +49,10 @@ Default text parts of the hoversel widget that you can use for are:
- "default" - Label of the hoversel - "default" - Label of the hoversel
.. _Elm_Icon_Type:
.. rubric:: Icon types
.. data:: ELM_ICON_NONE .. data:: ELM_ICON_NONE
No icon No icon
@ -100,7 +104,7 @@ cdef class HoverselItem(ObjectItem):
standard icon name (None if not desired) standard icon name (None if not desired)
:type icon_file: string :type icon_file: string
:param icon_type: The icon type if relevant :param icon_type: The icon type if relevant
:type icon_type: string :type icon_type: :ref:`Icon type <Elm_Icon_Type>`
:param callback: Convenience function to call when this item is :param callback: Convenience function to call when this item is
selected selected
:type callback: function :type callback: function

8
efl/elementary/label.pyx
View File

@ -50,6 +50,8 @@ This widget emits the following signals, besides the ones sent from
- *"language,changed"*: The program's language changed. - *"language,changed"*: The program's language changed.
.. _Elm_Wrap_Type:
.. rubric:: Wrap modes .. rubric:: Wrap modes
.. data:: ELM_WRAP_NONE .. data:: ELM_WRAP_NONE
@ -69,6 +71,8 @@ This widget emits the following signals, besides the ones sent from
Word wrap, and if that fails, char wrap. Word wrap, and if that fails, char wrap.
.. _Elm_Label_Slide_Mode:
.. rubric:: Slide modes .. rubric:: Slide modes
.. data:: ELM_LABEL_SLIDE_MODE_NONE .. data:: ELM_LABEL_SLIDE_MODE_NONE
@ -123,7 +127,7 @@ cdef class Label(LayoutClass):
- ELM_WRAP_WORD - wrap between words - ELM_WRAP_WORD - wrap between words
- ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap - ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
:type: Elm_Wrap_Type :type: :ref:`Line wrapping mode <Elm_Wrap_Type>`
""" """
def __get__(self): def __get__(self):
@ -238,7 +242,7 @@ cdef class Label(LayoutClass):
the text width length the text width length
- ELM_LABEL_SLIDE_MODE_ALWAYS - slide always - ELM_LABEL_SLIDE_MODE_ALWAYS - slide always
:type: Elm_Label_Slide_Mode :type: :ref:`Label slide mode <Elm_Label_Slide_Mode>`
""" """
def __get__(self): def __get__(self):

69
efl/elementary/list.pyx
View File

@ -61,6 +61,8 @@ Default text parts of the list items that you can use for are:
- "default" - label in the list item - "default" - label in the list item
.. _Elm_List_Mode:
.. rubric:: List sizing modes .. rubric:: List sizing modes
.. data:: ELM_LIST_COMPRESS .. data:: ELM_LIST_COMPRESS
@ -100,25 +102,34 @@ Default text parts of the list items that you can use for are:
externally. externally.
.. _Elm_Object_Select_Mode:
.. rubric:: Selection modes .. rubric:: Selection modes
.. data:: ELM_OBJECT_SELECT_MODE_DEFAULT .. data:: ELM_OBJECT_SELECT_MODE_DEFAULT
Default select mode Items will only call their selection func and callback when
first becoming selected. Any further clicks will do nothing,
unless you set always select mode.
.. data:: ELM_OBJECT_SELECT_MODE_ALWAYS .. data:: ELM_OBJECT_SELECT_MODE_ALWAYS
Always select mode This means that, even if selected, every click will make the
selected callbacks be called.
.. data:: ELM_OBJECT_SELECT_MODE_NONE .. data:: ELM_OBJECT_SELECT_MODE_NONE
No select mode This will turn off the ability to select items entirely and
they will neither appear selected nor call selected callback
functions.
.. data:: ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY .. data:: ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY
No select mode with no finger size rule No select mode with no finger size rule
.. _Elm_Scroller_Policy:
.. rubric:: Scrollbar visibility .. rubric:: Scrollbar visibility
.. data:: ELM_SCROLLER_POLICY_AUTO .. data:: ELM_SCROLLER_POLICY_AUTO
@ -253,9 +264,9 @@ cdef class ListItem(ObjectItem):
.. seealso:: .. seealso::
:py:attr:`List.select_mode` :py:attr:`List.select_mode`
:py:func:`elementary.object_item.ObjectItem.delete()` :py:func:`efl.elementary.object_item.ObjectItem.delete()`
:py:func:`List.clear()` :py:func:`List.clear()`
:py:class:`elementary.icon.Icon` :py:class:`Icon <efl.elementary.icon.Icon>`
:return: The created item or ``None`` upon failure. :return: The created item or ``None`` upon failure.
:rtype: :py:class:`ListItem` :rtype: :py:class:`ListItem`
@ -284,9 +295,9 @@ cdef class ListItem(ObjectItem):
.. seealso:: .. seealso::
:py:func:`append_to()` :py:func:`append_to()`
:py:attr:`List.select_mode` :py:attr:`List.select_mode`
:py:func:`elementary.object_item.ObjectItem.delete()` :py:func:`efl.elementary.object_item.ObjectItem.delete()`
:py:func:`List.clear()` :py:func:`List.clear()`
:py:class:`elementary.icon.Icon` :py:class:`Icon <efl.elementary.icon.Icon>`
:param list: The list :param list: The list
:type list: List :type list: List
@ -318,9 +329,9 @@ cdef class ListItem(ObjectItem):
.. seealso:: .. seealso::
:py:func:`append_to()` :py:func:`append_to()`
:py:attr:`List.select_mode` :py:attr:`List.select_mode`
:py:func:`elementary.object_item.ObjectItem.delete()` :py:func:`efl.elementary.object_item.ObjectItem.delete()`
:py:func:`List.clear()` :py:func:`List.clear()`
:py:class:`elementary.icon.Icon` :py:class:`Icon <efl.elementary.icon.Icon>`
:param before: The list item to insert before. :param before: The list item to insert before.
:type before: :py:class:`ListItem` :type before: :py:class:`ListItem`
@ -354,9 +365,9 @@ cdef class ListItem(ObjectItem):
.. seealso:: .. seealso::
:py:func:`append_to()` :py:func:`append_to()`
:py:attr:`List.select_mode` :py:attr:`List.select_mode`
:py:func:`elementary.object_item.ObjectItem.delete()` :py:func:`efl.elementary.object_item.ObjectItem.delete()`
:py:func:`List.clear()` :py:func:`List.clear()`
:py:class:`elementary.icon.Icon` :py:class:`Icon <efl.elementary.icon.Icon>`
:param after: The list item to insert after. :param after: The list item to insert after.
:type after: :py:class:`ListItem` :type after: :py:class:`ListItem`
@ -388,9 +399,9 @@ cdef class ListItem(ObjectItem):
.. seealso:: .. seealso::
:py:func:`append_to()` :py:func:`append_to()`
:py:attr:`List.select_mode` :py:attr:`List.select_mode`
:py:func:`elementary.object_item.ObjectItem.delete()` :py:func:`efl.elementary.object_item.ObjectItem.delete()`
:py:func:`List.clear()` :py:func:`List.clear()`
:py:class:`elementary.icon.Icon` :py:class:`Icon <efl.elementary.icon.Icon>`
.. note:: This function inserts values into a list object assuming .. note:: This function inserts values into a list object assuming
it was sorted and the result will be sorted. it was sorted and the result will be sorted.
@ -580,7 +591,7 @@ cdef class List(Object):
li.go() li.go()
li.show() li.show()
.. note:: Call before running show() on the list object. .. note:: Call before running :py:func:`show() <efl.evas.Object.show>` on the list object.
.. warning:: If not called, it won't display the list properly. .. warning:: If not called, it won't display the list properly.
""" """
@ -620,7 +631,7 @@ cdef class List(Object):
.. note:: Default value is ELM_LIST_SCROLL. .. note:: Default value is ELM_LIST_SCROLL.
:type: Elm_List_Mode :type: :ref:`List mode <Elm_List_Mode>`
""" """
def __get__(self): def __get__(self):
@ -656,21 +667,7 @@ cdef class List(Object):
property select_mode: property select_mode:
"""The list select mode. """The list select mode.
Possible modes are: :type: :ref:`Selection mode <Elm_Object_Select_Mode>`
ELM_OBJECT_SELECT_MODE_DEFAULT
Items will only call their selection func and callback when
first becoming selected. Any further clicks will do nothing,
unless you set always select mode.
ELM_OBJECT_SELECT_MODE_ALWAYS
This means that, even if selected, every click will make the
selected callbacks be called.
ELM_OBJECT_SELECT_MODE_NONE
This will turn off the ability to select items entirely and
they will neither appear selected nor call selected callback
functions.
:type: Elm_Object_Select_Mode
""" """
def __set__(self, mode): def __set__(self, mode):
@ -690,7 +687,7 @@ cdef class List(Object):
Whether the internal scroller object should bounce or not when it Whether the internal scroller object should bounce or not when it
reaches the respective edges for each axis. reaches the respective edges for each axis.
:type: tuple of bools :type: (bool **h**, bool **v**)
""" """
def __set__(self, value): def __set__(self, value):
@ -721,7 +718,7 @@ cdef class List(Object):
The both are disabled by default, i.e., are set to The both are disabled by default, i.e., are set to
ELM_SCROLLER_POLICY_OFF. ELM_SCROLLER_POLICY_OFF.
:type: Elm_Scroller_Policy :type: :ref:`Scrolling policy <Elm_Scroller_Policy>`
""" """
def __set__(self, value): def __set__(self, value):
@ -763,8 +760,8 @@ cdef class List(Object):
Remove all list's items. Remove all list's items.
.. seealso:: .. seealso::
:py:func:`object_item.ObjectItem.delete()` :py:func:`efl.elementary.object_item.ObjectItem.delete`
:py:func:`ListItem.append()` :py:func:`ListItem.append_to`
""" """
elm_list_clear(self.obj) elm_list_clear(self.obj)
@ -774,10 +771,10 @@ cdef class List(Object):
.. seealso:: .. seealso::
:py:func:`ListItem.append_to()` :py:func:`ListItem.append_to()`
:py:func:`elementary.object_item.ObjectItem.delete()` :py:func:`efl.elementary.object_item.ObjectItem.delete`
:py:func:`clear()` :py:func:`clear()`
:type: tuple of :py:class:`ListItem` :type: tuple of :py:class:`List items <ListItem>`
""" """
def __get__(self): def __get__(self):

15
efl/elementary/window.pyx
View File

@ -100,6 +100,7 @@ Signals that you can add callbacks for are:
- "maximized": window has been maximized - "maximized": window has been maximized
- "unmaximized": window has stopped being maximized - "unmaximized": window has stopped being maximized
.. _Elm_Win_Type:
.. rubric:: Window types .. rubric:: Window types
@ -200,6 +201,8 @@ Signals that you can add callbacks for are:
process's plug image object process's plug image object
.. _Elm_Win_Indicator_Mode:
.. rubric:: Indicator states .. rubric:: Indicator states
.. data:: ELM_WIN_INDICATOR_UNKNOWN .. data:: ELM_WIN_INDICATOR_UNKNOWN
@ -215,6 +218,8 @@ Signals that you can add callbacks for are:
Shows the indicator. Shows the indicator.
.. _Elm_Win_Indicator_Opacity_Mode:
.. rubric:: Indicator opacity .. rubric:: Indicator opacity
.. data:: ELM_WIN_INDICATOR_OPACITY_UNKNOWN .. data:: ELM_WIN_INDICATOR_OPACITY_UNKNOWN
@ -234,6 +239,8 @@ Signals that you can add callbacks for are:
Transparentizes the indicator. Transparentizes the indicator.
.. _Elm_Win_Keyboard_Mode:
.. rubric:: Keyboard virtual keyboard modes .. rubric:: Keyboard virtual keyboard modes
.. data:: ELM_WIN_KEYBOARD_UNKNOWN .. data:: ELM_WIN_KEYBOARD_UNKNOWN
@ -371,7 +378,7 @@ cdef class Window(Object):
:param name: A name for the new window. :param name: A name for the new window.
:type name: string :type name: string
:param type: A type for the new window: :param type: A type for the new window:
:type type: Elm_Win_Type :type type: :ref:`Window type <Elm_Win_Type>`
:keyword parent: Parent object to add the window to, defaults to None :keyword parent: Parent object to add the window to, defaults to None
:type parent: :py:class:`efl.evas.Object` :type parent: :py:class:`efl.evas.Object`
@ -1337,7 +1344,7 @@ cdef class Window(Object):
property keyboard_mode: property keyboard_mode:
"""The keyboard mode of the window. """The keyboard mode of the window.
:type: Elm_Win_Keyboard_Mode :type: :ref:`Window keyboard mode <Elm_Win_Keyboard_Mode>`
""" """
def __get__(self): def __get__(self):
@ -1369,7 +1376,7 @@ cdef class Window(Object):
property indicator_mode: property indicator_mode:
"""The indicator mode of the window. """The indicator mode of the window.
:type: Elm_Win_Indicator_Mode :type: :ref:`Window indicator mode <Elm_Win_Indicator_Mode>`
""" """
def __get__(self): def __get__(self):
@ -1385,7 +1392,7 @@ cdef class Window(Object):
property indicator_opacity: property indicator_opacity:
"""The indicator opacity mode of the window. """The indicator opacity mode of the window.
:type: Elm_Win_Indicator_Opacity_Mode :type: :ref:`Window indicator opacity <Elm_Win_Indicator_Opacity_Mode>`
""" """
def __get__(self): def __get__(self):