39.5 Finding All Frames

Function: frame-list

The function frame-list returns a list of all the frames that have not been deleted. It is analogous to buffer-list for buffers. The list that you get is newly created, so modifying the list doesn’t have any effect on the internals of SXEmacs.

Function: device-frame-list &optional device

This function returns a list of all frames on device. If device is nil, the selected device will be used.

Function: visible-frame-list &optional device

This function returns a list of just the currently visible frames. If device is specified only frames on that device will be returned. See Visibility of Frames. (TTY frames always count as “visible”, even though only the selected one is actually displayed.)

Function: next-frame &optional frame which-frames which-devices

The function next-frame lets you cycle conveniently through all the frames from an arbitrary starting point. It returns the “next” frame after frame in the cycle. If frame defaults to the selected frame.

The second argument, which-frames, says which frames to consider:

visible

Consider only frames that are visible.

iconic

Consider only frames that are iconic.

invisible

Consider only frames that are invisible (this is different from iconic).

visible-iconic

Consider frames that are visible or iconic.

invisible-iconic

Consider frames that are invisible or iconic.

nomini

Consider all frames except minibuffer-only ones.

visible-nomini

Like visible but omits minibuffer-only frames.

iconic-nomini

Like iconic but omits minibuffer-only frames.

invisible-nomini

Like invisible but omits minibuffer-only frames.

visible-iconic-nomini

Like visible-iconic but omits minibuffer-only frames.

invisible-iconic-nomini

Like invisible-iconic but omits minibuffer-only frames.

nil

Identical to nomini.

window

Consider only the window window’s frame and any frame now using window as the minibuffer.

any other value

Consider all frames.

The optional argument which-devices further clarifies on which devices to search for frames as specified by which-frames.

nil

Consider all devices on the selected console.

device

Consider only the one device device.

console

Consider all devices on console.

device-type

Consider all devices with device type device-type.

window-system

Consider all devices on window system consoles.

anything else

Consider all devices without restriction.

Function: previous-frame &optional frame which-frames which-devices

Like next-frame, but cycles through all frames in the opposite direction.

See also next-window and previous-window, in Cyclic Window Ordering.