diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2013-05-25 23:52:33 +0100 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2013-05-25 23:52:33 +0100 |
| commit | 7b7e456fd8a59ac7c545b868bd86e5ed27eeaaf5 (patch) | |
| tree | fbbc143955a9679900376e0ecf2058d9d8ed09fd /docs | |
| parent | a1420aa8635b9b062ba5d1dd6f42772181fc92b1 (diff) | |
doc: minor tweak of interface doc
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/api/interface.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/source/api/interface.rst b/docs/source/api/interface.rst index 7d66cf1f..0ee0cb29 100644 --- a/docs/source/api/interface.rst +++ b/docs/source/api/interface.rst @@ -1,7 +1,7 @@ User Interface ================== -Alot sets up a widget tree and an :class:`mainloop <urwid.main_loop.TwistedEventLoop>` +Alot sets up a widget tree and a :class:`mainloop <urwid.main_loop.TwistedEventLoop>` in the constructor of :class:`alot.ui.UI`. The visible area is a :class:`urwid.Frame`, where the footer is used as a status line and the body part displays the currently active :class:`alot.buffers.Buffer`. @@ -14,7 +14,8 @@ customary in urwid. Instead, the root widget given to urwids mainloop is a custo key presses to the wrapped root widget and thereby accessing standard urwid behaviour. -In order to keep the interface non-blocking, alot makes use of twisted's deferred_ - a +In order to keep the interface non-blocking and react to events like +terminal size changes, alot makes use of twisted's deferred_ - a framework that makes it easy to deal with callbacks. Many commands in alot make use of `inline callbacks`_, which allow you to treat deferred-returning functions almost like syncronous functions. Consider the following example of a function that prompts for some |