windows

Arguments: window-or-screen &key owned-p states

This function returns a list of the child windows or the other owned windows of either a window or the screen.

The order of the windows in the returned list will be the front-to-back occlusion order of the windows. (An exception is that the occlusion order of top-level windows on the GTK platform is not known, and so the order of windows in the returned list is not useful when asking for the child windows of the screen or the owned windows of a top-level window.)

window-or-screen is the window or screen whose child or owned windows are to be found. (The screen is the value returned by (screen *system*). See screen and *system*.)

If owned-p is nil (the default) then the child windows of window-or-screen are returned. If owned-p is true, then the owned windows of window-or-screen that are not also child windows of window-or-screen are returned. These two groups together comprise all of the owned windows of window-or-screen. Note that only top-level windows can have owned windows that are not also their children; therefore, nil will always be returned if owned-p is passed as true along with a child window or the screen.

states specifies that only windows that are currently in certain states are to be returned. If nil (the default), then windows in all states are returned. Otherwise states may be a list of some combination of the symbols :normal, :shrunk, :icon, and :maximized, in which case only windows that are currently in those states are returned. See state.

Note that if the specified window is a frame-with-single-child window, then its frame-child pane will be included in the returned list, even though it is sometimes considered to be logically a part of the frame window.

See also windows-scratch-list, do-windows, front-window, and next-window.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.