summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorIan Ward <ian@excess.org>2012-03-28 22:36:07 -0400
committerIan Ward <ian@excess.org>2012-03-28 22:36:07 -0400
commit31c277270ecb17cc307cf6e489dd2f5fbee89dd8 (patch)
treebc24295b0d7bd606b6ae1e68f282fd05b78b8ed2 /docs/reference
parent6bed9d925ad75d81b7867806c738c9c02298cccc (diff)
downloadurwid-31c277270ecb17cc307cf6e489dd2f5fbee89dd8.tar.gz
main_loop: move all reference docs into docstrings
--HG-- branch : feature-sphinx
Diffstat (limited to 'docs/reference')
-rwxr-xr-xdocs/reference/main_loop.rst22
1 files changed, 7 insertions, 15 deletions
diff --git a/docs/reference/main_loop.rst b/docs/reference/main_loop.rst
index e99105e..73695c7 100755
--- a/docs/reference/main_loop.rst
+++ b/docs/reference/main_loop.rst
@@ -1,27 +1,19 @@
-Main Loop and Event Loop Reference
-==================================
+Main Loop and Event Loop Classes
+================================
+
+Main Loop
+---------
.. autoexception:: urwid.ExitMainLoop
.. autoclass:: urwid.MainLoop
- :members: set_alarm_in, set_alarm_at, remove_alarm,
- watch_pipe, remove_watch_pipe,
- run, process_input, input_filter, unhandled_input,
- entering_idle, draw_screen,
-
- .. attribute:: widget
- Property for the topmost widget used. This must be a box widget.
+Event Loops
+-----------
.. autoclass:: urwid.SelectEventLoop
- :members: alarm, remove_alarm, watch_file, remove_watch_file,
- enter_idle, remove_enter_idle, run
.. autoclass:: urwid.GLibEventLoop
- :members: alarm, remove_alarm, watch_file, remove_watch_file,
- enter_idle, remove_enter_idle, run, handle_exit
.. autoclass:: urwid.TwistedEventLoop
- :members: alarm, remove_alarm, watch_file, remove_watch_file,
- enter_idle, remove_enter_idle, run, handle_exit