From 1e8ca3a9ae42f2450f29d74df4495916b1a85fa4 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Sat, 8 Sep 2001 17:50:39 +0000 Subject: [PATCH] (Selecting Windows): Document some-window. --- lispref/windows.texi | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/lispref/windows.texi b/lispref/windows.texi index bb5c88f0c23..b1f18fa7857 100644 --- a/lispref/windows.texi +++ b/lispref/windows.texi @@ -468,6 +468,21 @@ The argument @var{frame} controls which set of windows to consider. See @code{get-lru-window}, above. @end defun +@cindex window that satisfies a predicate +@cindex conditional selection of windows +@defun get-window-with-predicate predicate &optional minibuf all-frames default +This function returns a window satisfying @var{predicate}. It cycles +through all visible windows using @code{walk-windows} (@pxref{Cyclic +Window Ordering}), calling @var{predicate} on each one one of them +with that window as its argument. The function returns the first +window for which @var{predicate} returns a non-@code{nil} value; if +that never happens, it returns @var{default}. + +The optional arguments @var{minibuf} and @var{all-frames} specify the +set of windows to include in the scan. See the description of +@code{next-window} in @ref{Cyclic Window Ordering}, for details. +@end defun + @node Cyclic Window Ordering @comment node-name, next, previous, up @section Cyclic Ordering of Windows