summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIan Ward <ian@excess.org>2012-12-13 17:06:41 -0500
committerIan Ward <ian@excess.org>2012-12-13 17:06:41 -0500
commitab59f4d881e8af6b8f4f834b86948a5a4822a377 (patch)
tree065fa700e4e59fbc2335d3d4560947db987143c8 /docs
parent073f5066f90b5b28e033f28cb951a49204447d60 (diff)
downloadurwid-ab59f4d881e8af6b8f4f834b86948a5a4822a377.tar.gz
copy get_focus_widgets() docs into manual
Diffstat (limited to 'docs')
-rw-r--r--docs/manual/widgets.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/manual/widgets.rst b/docs/manual/widgets.rst
index 26e5b48..0e42c52 100644
--- a/docs/manual/widgets.rst
+++ b/docs/manual/widgets.rst
@@ -230,6 +230,18 @@ focus to a widget as returned by a previous call to ``container.get_focus_path()
::
+ container.get_focus_widgets()
+
+is a method that returns the ``.focus`` values starting from this container
+and proceeding along each child widget until reaching a leaf
+(non-container) widget.
+
+Note that the list does not contain the topmost container widget
+(i.e, on which this method is called), but does include the
+lowest leaf widget.
+
+::
+
container.__iter__()
# typically
for x in container: ...