# $scroll-bar(5)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

## NAME

$scroll-bar - Scroll bar configuration

## SYNOPSIS

$scroll-bar "bitmask"; Default is platform specific

## DESCRIPTION

$scroll-bar defines the configuration of the scroll bar and/or the horizontal window separator for both main text windows and osd(2) dialogs. The variable is interpreted as a bit mask and defines which components of the scroll bar (or separator) should be rendered in a window. The characters used to render the scroll bar or separator are defined by $window-chars(5). The bit mask is defined as follows:-

0x001 - Vertical Scroll Bar Width

Bit 0 controls the width of the vertical scroll bar (or separator). A value of 0 corresponds to a single column width, a value of 1 is a double column width.

0x002 - Upper end cap

Bit 1 set indicates that the scroll bar has an upper end cap. This is the up arrow character at the top of a scroll bar.

0x004 - Lower end cap

Bit 2 set indicates that the scroll bar has a lower end cap. This is the down arrow character at the bottom of a scroll bar.

0x008 - Corner

Bit 3 set indicates that separate corner character is used at the intersection of the mode line and the separator.

0x010 - Scroll Box Enable

Bit 4 determines if the scroll bar has a scrolling box, when the bit is set each scroll bar will have a scroll box. When clear, scroll bars are rendered according to bits 0-3 & 7 only and the main area of the bar is left empty.

0x020 - Reverse Video Box

Bit 5 when set enables the scroll box to be rendered in reverse video, that is the background and foreground/hilight scroll colors are interchanged. This bit is typically set on X-Window platforms allowing the scroll box to comprise of `SPACE` characters allowing a solid box to be rendered in the foreground color.

Bit 5 is only enacted if scroll boxes are enabled.

0x040 - Horizontal Scroll Bar Width

Bit 6 controls the width of the horizontal scroll bar, used only by osd(2). A value of 0 corresponds to a single column width, a value of 1 is a double column width.

0x080 - Splitter

Bit 7 set indicates that the scroll bar has a splitter. This is the split bar character at the top of a scroll bar.

0x100 - Enable window Scroll Bars

When Bit 8 is clear, scroll bars are not present on windows. If a horizontal split has been performed then the window separator is rendered plain. This is useful when performance is important, as scroll bars require constant up-date.

0x200 - Horizontal Scroll Bar Width

Bit 9 enables scroll bars, when the bit is set each window is assigned a scroll bar in the right-hand column(s) of the window with a scroll box.

## SEE ALSO

$mouse-pos(5), $scroll-bar-scheme(5), set-scroll-with-mouse(2), $window-chars(5).

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

</HMTL>