$window-flags(5)

NAME

$window-flags - Current window setup flags

SYNOPSIS

$window-flags bitmask; Default is 0

DESCRIPTION

The $window-flags variable is used to set or get various behavioural characteristic settings of the current window, it is a bit based flag where:

0x001


If set the width of the window is locked, calls to resize-all-windows(2) will maintained the width of this window whenever possible.

0x002


If set the depth of the window is locked, calls to resize-all-windows(2) will maintained the depth of this window whenever possible.

0x004


If set the buffer being displayed by the window is locked, the user can still manually change the buffer being displayed (by using commands like find-buffer(2)) but commands that pop-up buffers (such as help(2) or find-tag(2)) will not use this window.

0x008


When set the command compare-windows(2) will ignore this window.

0x010


When set the commands like previous-window(2) and next-window(2) will skip this window unless the numeric argument given to the command is used to override the flag setting.

0x020


When set the command delete-other-windows(2) will not delete this window unless the numeric argument given to the command is used to override the flag setting.

0x040


When set the command delete-window(2) will not delete this window unless the numeric argument given to the command is used to override the flag setting.

0x080


When set the window cannot be split using either the split-window-horizontally(2) or split-window-vertically(2) commands.

0x100


If not set the window cannot be deleted if it is the only window without this bit set. This more esoteric feature is utilized by the toolbar, all toolbar windows have this bit set which means that the main user window cannot be delete.

NOTES

The $window-flags setting is not preserved during a window splitting operation (i.e. using a command like split-window-vertically(2)) as the persistence of these settings can lead to unexpected behaviour.

The toolbar uses bit 0x1000 to indicate that the window is displaying a toolbar tool, this bit should not be used by users and its value should be maintained.

SEE ALSO

next-window(2), delete-other-windows(2), compare-windows(2).

(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12