Interface IOutputBuffer | Terminal.Gui v2 (original) (raw)

Namespace

Assembly

Terminal.Gui.dll

Describes the screen state that you want the console to be in. Is designed to be drawn to repeatedly then manifest into the console once at the end of iteration after all drawing is finalized.

public interface IOutputBuffer

Properties

Clip

Gets or sets the clip rectangle that AddRune(Rune) and AddStr(string) are subject to.

Col

Gets the column last set by Move(int, int). Col and Row are used byAddRune(Rune) and AddStr(string) to determine where to add content.

Cols

The number of columns visible in the terminal.

Contents

The contents of the application output. The driver outputs this buffer to the terminal when UpdateScreen is called.

CurrentAttribute

The Attribute that will be used for the next AddRune or AddStr call.

DirtyLines

As performance is a concern, we keep track of the dirty lines and only refresh those. This is in addition to the dirty flag on each cell.

Left

The first cell index on left of screen - basically always 0. Changing this may have unexpected consequences.

Row

Gets the row last set by Move(int, int). Col and Row are used byAddRune(Rune) and AddStr(string) to determine where to add content.

Rows

The number of rows visible in the terminal.

Top

The first cell index on top of screen - basically always 0. Changing this may have unexpected consequences.

Methods

AddRune(char)

Adds the specified character to the display at the current cursor position. This is a convenience method for AddRune.

AddRune(Rune)

Adds the specified rune to the display at the current cursor position.

AddStr(string)

Adds the string to the display at the current cursor position.

ClearContents()

Clears the contents of the buffer.

FillRect(Rectangle, char)

Fills the given rect with the given symbol using the currently selected attribute.

FillRect(Rectangle, Rune)

Fills the given rect with the given symbol using the currently selected attribute.

IsValidLocation(Rune, int, int)

Tests whether the specified coordinate is valid for drawing the specified Rune.

Move(int, int)

Updates the column and row to the specified location in the buffer.

SetWindowSize(int, int)

Changes the size of the buffer to the given size