summaryrefslogtreecommitdiff
path: root/lisp/subr.el
diff options
context:
space:
mode:
authorRichard M. Stallman <rms@gnu.org>1995-02-25 07:35:09 +0000
committerRichard M. Stallman <rms@gnu.org>1995-02-25 07:35:09 +0000
commitf67d583f4a2eba8c6b081353a7ae4156994013f3 (patch)
tree9264654afe018cec251f2eb93b6a149e3460e368 /lisp/subr.el
parenta0e7a59029b8e3ca06619d1beb5d2884ad1a9802 (diff)
downloademacs-f67d583f4a2eba8c6b081353a7ae4156994013f3.tar.gz
(walk-windows): Doc fix.
Diffstat (limited to 'lisp/subr.el')
-rw-r--r--lisp/subr.el27
1 files changed, 18 insertions, 9 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index e0a8e0177ff..f7bbad7b405 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -73,15 +73,24 @@ If ALL-FRAMES is neither nil nor t, count only the selected frame."
(defun walk-windows (proc &optional minibuf all-frames)
"Cycle through all visible windows, calling PROC for each one.
PROC is called with a window as argument.
-Optional second arg MINIBUF t means count the minibuffer window
-even if not active. If MINIBUF is neither t nor nil it means
-not to count the minibuffer even if it is active.
-
-Optional third arg ALL-FRAMES, if t, means include all frames.
-ALL-FRAMES nil or omitted means cycle within the selected frame,
-but include the minibuffer window (if MINIBUF says so) that that
-frame uses, even if it is on another frame.
-If ALL-FRAMES is neither nil nor t, stick strictly to the selected frame."
+
+Optional second arg MINIBUF t means count the minibuffer window even
+if not active. MINIBUF nil or omitted means count the minibuffer iff
+it is active. MINIBUF neither t nor nil means not to count the
+minibuffer even if it is active.
+
+Several frames may share a single minibuffer; if the minibuffer
+counts, all windows on all frames that share that minibuffer count
+too. Therefore, when a separate minibuffer frame is active,
+`walk-windows' includes the windows in the frame from which you
+entered the minibuffer, as well as the minibuffer window. But if the
+minibuffer does not count, only windows from WINDOW's frame count.
+
+Optional third arg ALL-FRAMES t means include windows on all frames.
+ALL-FRAMES nil or omitted means cycle within the frames as specified
+above. ALL-FRAMES = `visible' means include windows on all visible frames.
+ALL-FRAMES = 0 means include windows on all visible and iconified frames.
+Anything else means restrict to WINDOW's frame."
;; If we start from the minibuffer window, don't fail to come back to it.
(if (window-minibuffer-p (selected-window))
(setq minibuf t))