gui-cs.Terminal.Gui/docfx/docs/scrolling.md

Scrolling

Terminal.Gui provides a rich system for how View users can scroll content with the keyboard and/or mouse.

Lexicon & Taxonomy

See View Deep Dive for broader definitions.

• Scroll (Verb) - The act of causing content to move either horizontally or vertically within the View.Viewport. Also referred to as "Content Scrolling".
• ScrollSlider - A visual indicator that shows the proportion of the scrollable content to the size of the View.Viewport and allows the user to use the mouse to scroll.
• ScrollBar - Indicates the size of scrollable content and controls the position of the visible content, either vertically or horizontally. At each end, a @Terminal.Gui.Button is provided, one to scroll up or left and one to scroll down or right. Between the buttons is a @Terminal.Gui.ScrollSlider that can be dragged to control the position of the visible content. The ScrollSlier is sized to show the proportion of the scrollable content to the size of the @Terminal.Gui.View.Viewport.

Overview

The ability to scroll content is built into View. The View.Viewport represents the scrollable "viewport" into the View's Content Area (which is defined by the return value of View.GetContentSize()).

By default, View, includes no bindings for the typical directional keyboard and mouse input and cause the Content Area.

Terminal.Gui also provides the ability show a visual scroll bar that responds to mouse input. This ability is not enabled by default given how precious TUI screen real estate is.

Scrolling with the mouse and keyboard are enabled by:

1) Making the View.Viewport size smaller than the size returned by View.GetContentSize(). 2) Creating key bindings for the appropriate directional keys (e.g. Key.CursorDown), and calling View.ScrollHorizontal()/ScrollVertical() as needed. 3) Subscribing to View.MouseEvent and calling calling View.ScrollHorizontal()/ScrollVertical() as needed. 4) Enabling the ScrollBars built into View (View.HorizontalScrollBar/VerticalScrollBar) by either enabling automatic show/hide behavior (see @Terminal.Gui.ScrollBar.AutoShow) or explicitly making them visible (see @Terminal.Gui.View.Visible).

While ScrollBar can be used in a standalone manner to provide proportional scrolling, it is typically enabled automatically via the View.HorizontalScrollBar and View.VerticalScrollBar properties.

Examples

These Scenarios illustrate Terminal.Gui scrolling:

• Scrolling - Demonstrates the @Terminal.Gui.ScrollBar objects built into-View.
• ScrollBar Demo - Demonstrates using @Terminal.Gui.ScrollBar view in a standalone manner.
• ViewportSettings - Demonstrates the various Viewport Settings (see below) in an interactive manner. Used by the development team to visually verify that convoluted View layout and arrangement scenarios scroll properly.
• Character Map - Demonstrates a sophisticated scrolling use-case. The entire set of Unicode code-points can be scrolled and searched. From a scrolling perspective, this Scenario illustrates how to manually configure Viewport, SetContentArea(), and ViewportSettings to enable horizontal and vertical headers (as might appear in a spreadsheet), full keyboard and mouse support, and more.
• ListView and HexEdit - The source code to these built-in Views are good references for how to support scrolling and ScrollBars in a re-usable View sub-class.

Viewport Settings

Use @Terminal.Gui.ViewportSettings to adjust the behavior of scrolling.

• AllowNegativeX/Y - If set, Viewport.Size can be set to negative coordinates enabling scrolling beyond the top-left of the content area.

• AllowX/YGreaterThanContentWidth - If set, Viewport.Size can be set values greater than GetContentSize() enabling scrolling beyond the bottom-right of the Content Area. When not set, Viewport.X/Y are constrained to the dimension of the content area - 1. This means the last column of the content will remain visible even if there is an attempt to scroll the Viewport past the last column. The practical effect of this is that the last column/row of the content will always be visible.

• ClipContentOnly - By default, clipping is applied to Viewport. Setting this flag will cause clipping to be applied to the visible content area.

• ClearContentOnly- If set View.Clear() will clear only the portion of the content area that is visible within the Viewport. This is useful for views that have a content area larger than the Viewport and want the area outside the content to be visually distinct.