scrolling-static-text

The class of a scrolling-static-text control.

This widget displays a block of non-editable text that wraps at spaces as needed to contain the text within the width of the widget, just as an ordinary static-text widget does. In addition, it will scroll vertically when not all of the text will fit within the height of the widget. A vertical scrollbar appears only when scrolling is needed. The widget can be scrolled as usual with the mouse on the scrollbar or with the Page Up, Page Down, and up and down arrow keys. This widget always uses the double-buffered property for smooth scrolling and updating.

The value property holds the string that the widget displays. The draw-focus property determines whether a rectangle is drawn around the text when the widget has the keyboard focus. If border-color is not nil, then a rectangle is drawn around the text at all times. The horizontal-justification, vertical-justification, and margin-around-text properties determine how the text is laid out within the widget. The text may be scrolled programmatically by calling set-first-visible-line.

Application code that precedes the scrolling-static-text widget may have emulated it by using a multi-line-editable-text widget with its read-only property set to true and perhaps its border set to :none. Using a scrolling-static-text in such cases may be more efficient.

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