TerminalLibraryFlutter class

TerminalLibraryFlutter is an interface to interact with command line applications. It translates escape sequences from the application into updates to the buffer and events such as onTitleChange or onBell, as well as translating user input into escape sequences that the application can understand.

Implemented types

• TerminalLibraryFlutterState
• EscapeHandler
• TerminalLibrary

Mixed-in types

• Observable

Constructors

TerminalLibraryFlutter.new({int maxLines = 1000, void onBell()?, void onTitleChange(String title)?, void onIconChange(String icon)?, void onOutput(String data)?, void onResize(int width, int height, int pixelWidth, int pixelHeight)?, TerminalLibraryFlutterTargetPlatform platform = TerminalLibraryFlutterTargetPlatform.unknown, TerminalLibraryFlutterInputHandler? inputHandler = defaultInputHandler, TerminalLibraryFlutterMouseHandler? mouseHandler = defaultMouseHandler, void onPrivateOSC(String code, List<String> args)?, bool reflowEnabled = true, Set<int>? wordSeparators})

UncompleteDocumentation

Properties

altBuffer → Buffer

UncompleteDocumentation

no setter

altBufferMouseScrollMode → bool

UncompleteDocumentation

no setter, override

appKeypadMode → bool

UncompleteDocumentation

no setter, override

autoWrapMode → bool

UncompleteDocumentation

no setter, override

bracketedPasteMode → bool

UncompleteDocumentation

no setter, override

buffer → Buffer

Current active buffer of the terminal. This is initially mainBuffer and can be switched back and forth from altBuffer to mainBuffer when the underlying program requests it.

no setter

cursor → CursorStyle

UncompleteDocumentation

no setter, override

cursorBlinkMode → bool

UncompleteDocumentation

no setter, override

cursorKeysMode → bool

UncompleteDocumentation UncompleteDocumentation

no setter, override

cursorVisibleMode → bool

UncompleteDocumentation

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

inputHandler ↔ TerminalLibraryFlutterInputHandler?

The TerminalLibraryFlutterInputHandler used by this terminal. defaultInputHandler is used when not specified. User of this class can provide their own implementation of TerminalLibraryFlutterInputHandler or extend defaultInputHandler with CascadeInputHandler.

getter/setter pair

insertMode → bool

UncompleteDocumentation

no setter, override

isUsingAltBuffer → bool

UncompleteDocumentation

no setter

lineFeedMode → bool

UncompleteDocumentation

no setter, override

lines → IndexAwareCircularBuffer<BufferLine>

Lines of the active buffer.

no setter

listeners → Set<void Function()>

UncompleteDocumentation

final, inherited

mainBuffer → Buffer

UncompleteDocumentation

no setter

maxLines → int

The number of lines that the scrollback buffer can hold. If the buffer exceeds this size, the lines at the top of the buffer will be removed.

final

mouseHandler ↔ TerminalLibraryFlutterMouseHandler?

UncompleteDocumentation

getter/setter pair

mouseMode → MouseMode

UncompleteDocumentation

no setter, override

mouseReportMode → MouseReportMode

UncompleteDocumentation

no setter, override

onBell ↔ void Function()?

Function that is called when the program requests the terminal to ring the bell. If not set, the terminal will do nothing.

getter/setter pair

onIconChange ↔ void Function(String icon)?

Function that is called when the program requests the terminal to change the icon of the window. icon is the name of the icon.

getter/setter pair

onOutput ↔ void Function(String data)?

Function that is called when the terminal emits data to the underlying program. This is typically caused by user inputs from textInput, keyInput, mouseInput, or paste.

getter/setter pair

onPrivateOSC ↔ void Function(String code, List<String> args)?

The callback that is called when the terminal receives a unrecognized escape sequence.

getter/setter pair

onResize ↔ void Function(int width, int height, int pixelWidth, int pixelHeight)?

Function that is called when the dimensions of the terminal change.

getter/setter pair

onTitleChange ↔ void Function(String title)?

Function that is called when the program requests the terminal to change the title of the window to title.

getter/setter pair

originMode → bool

UncompleteDocumentation

no setter, override

platform → TerminalLibraryFlutterTargetPlatform

Flag to toggle os specific behaviors.

final

reflowEnabled ↔ bool

Whether the terminal performs reflow when the viewport size changes or simply truncates lines. true by default.

getter/setter pair, override-getter

reportFocusMode → bool

UncompleteDocumentation

no setter, override

reverseDisplayMode → bool

UncompleteDocumentation

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

viewHeight → int

Number of rows in this terminal.

no setter, override

viewWidth → int

Number of cells in a terminal row.

no setter, override

wordSeparators → Set<int>?

Characters that break selection when double clicking. If not set, the Buffer.defaultWordSeparators will be used.

final

Methods

addListener(void listener()) → void

UncompleteDocumentation

inherited

backspaceReturn() → void

UncompleteDocumentation UncompleteDocumentation

override

bell() → void

UncompleteDocumentation UncompleteDocumentation

override

carriageReturn() → void

UncompleteDocumentation UncompleteDocumentation

override

charInput(int charCode, {bool alt = false, bool ctrl = false}) → bool

Similary to keyInput, but takes a character as input instead of a TerminalLibraryFlutterKey.

clearAllTabStops() → void

UncompleteDocumentation UncompleteDocumentation

override

clearAltBuffer() → void

UncompleteDocumentation

override

clearTabStopUnderCursor() → void

UncompleteDocumentation UncompleteDocumentation

override

cursorNextLine(int amount) → void

UncompleteDocumentation

override

cursorPrecedingLine(int amount) → void

UncompleteDocumentation

override

deleteChars(int amount) → void

UncompleteDocumentation

override

deleteLines(int amount) → void

UncompleteDocumentation

override

designateCharset(int charset, int name) → void

UncompleteDocumentation UncompleteDocumentation

override

eraseChars(int amount) → void

UncompleteDocumentation

override

eraseDisplay() → void

UncompleteDocumentation

override

eraseDisplayAbove() → void

UncompleteDocumentation

override

eraseDisplayBelow() → void

UncompleteDocumentation

override

eraseLine() → void

UncompleteDocumentation

override

eraseLineLeft() → void

UncompleteDocumentation

override

eraseLineRight() → void

UncompleteDocumentation

override

eraseScrollbackOnly() → void

UncompleteDocumentation

override

index() → void

UncompleteDocumentation UncompleteDocumentation

override

insertBlankChars(int amount) → void

UncompleteDocumentation

override

insertLines(int amount) → void

UncompleteDocumentation

override

keyInput(TerminalLibraryFlutterKey key, {bool shift = false, bool alt = false, bool ctrl = false}) → bool

Sends a key event to the underlying program.

lineFeed() → void

UncompleteDocumentation UncompleteDocumentation

override

mouseInput(TerminalLibraryFlutterMouseButton button, TerminalLibraryFlutterMouseButtonState buttonState, CellOffset position) → bool

UncompleteDocumentation

moveCursorX(int offset) → void

UncompleteDocumentation UncompleteDocumentation

override

moveCursorY(int n) → void

UncompleteDocumentation UncompleteDocumentation

override

nextLine() → void

UncompleteDocumentation UncompleteDocumentation

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyListeners() → void

UncompleteDocumentation

inherited

paste(String text) → void

Similar to textInput, except that when the program tells the terminal that it supports bracketedPasteMode, the text is wrapped in escape sequences to indicate that it is a paste operation. Prefer this method over textInput when pasting text.

removeListener(void listener()) → void

UncompleteDocumentation

inherited

repeatPreviousCharacter(int count) → void

UncompleteDocumentation UncompleteDocumentation

override

resetBackground() → void

UncompleteDocumentation

override

resetCursorStyle() → void

UncompleteDocumentation

override

resetForeground() → void

UncompleteDocumentation

override

resize(int newWidth, int newHeight, [int? pixelWidth, int? pixelHeight]) → void

Resize the terminal screen. newWidth and newHeight should be greater than 0. Text reflow is currently not implemented and will be avaliable in the future.

override

restoreCursor() → void

UncompleteDocumentation UncompleteDocumentation

override

reverseIndex() → void

UncompleteDocumentation UncompleteDocumentation

override

saveCursor() → void

UncompleteDocumentation UncompleteDocumentation

override

scrollDown(int amount) → void

UncompleteDocumentation

override

scrollUp(int amount) → void

UncompleteDocumentation

override

sendCursorPosition() → void

UncompleteDocumentation UncompleteDocumentation

override

sendOperatingStatus() → void

UncompleteDocumentation UncompleteDocumentation

override

sendPrimaryDeviceAttributes() → void

UncompleteDocumentation UncompleteDocumentation

override

sendSecondaryDeviceAttributes() → void

UncompleteDocumentation UncompleteDocumentation

override

sendSize() → void

UncompleteDocumentation

override

sendTertiaryDeviceAttributes() → void

UncompleteDocumentation UncompleteDocumentation

override

setAltBufferMouseScrollMode(bool enabled) → void

UncompleteDocumentation

override

setAppKeypadMode(bool enabled) → void

UncompleteDocumentation

override

setAutoWrapMode(bool enabled) → void

UncompleteDocumentation

override

setBackgroundColor16(int color) → void

UncompleteDocumentation

override

setBackgroundColor256(int index) → void

UncompleteDocumentation

override

setBackgroundColorRgb(int r, int g, int b) → void

UncompleteDocumentation

override

setBracketedPasteMode(bool enabled) → void

UncompleteDocumentation

override

setColumnMode(bool enabled) → void

UncompleteDocumentation

override

setCursor(int x, int y) → void

UncompleteDocumentation UncompleteDocumentation

override

setCursorBlink() → void

UncompleteDocumentation

override

setCursorBlinkMode(bool enabled) → void

UncompleteDocumentation

override

setCursorBold() → void

UncompleteDocumentation

override

setCursorFaint() → void

UncompleteDocumentation

override

setCursorInverse() → void

UncompleteDocumentation

override

setCursorInvisible() → void

UncompleteDocumentation

override

setCursorItalic() → void

UncompleteDocumentation

override

setCursorKeysMode(bool enabled) → void

UncompleteDocumentation

override

setCursorStrikethrough() → void

UncompleteDocumentation

override

setCursorUnderline() → void

UncompleteDocumentation

override

setCursorVisibleMode(bool enabled) → void

UncompleteDocumentation

override

setCursorX(int x) → void

UncompleteDocumentation UncompleteDocumentation

override

setCursorY(int y) → void

UncompleteDocumentation UncompleteDocumentation

override

setForegroundColor16(int color) → void

UncompleteDocumentation

override

setForegroundColor256(int index) → void

UncompleteDocumentation

override

setForegroundColorRgb(int r, int g, int b) → void

UncompleteDocumentation

override

setIconName(String name) → void

UncompleteDocumentation

override

setInsertMode(bool enabled) → void

UncompleteDocumentation

override

setLineFeedMode(bool enabled) → void

UncompleteDocumentation

override

setMargins(int top, [int? bottom]) → void

UncompleteDocumentation

override

setMouseMode(MouseMode mode) → void

UncompleteDocumentation

override

setMouseReportMode(MouseReportMode mode) → void

UncompleteDocumentation

override

setOriginMode(bool enabled) → void

UncompleteDocumentation

override

setReportFocusMode(bool enabled) → void

UncompleteDocumentation

override

setReverseDisplayMode(bool enabled) → void

UncompleteDocumentation

override

setTapStop() → void

UncompleteDocumentation UncompleteDocumentation

override

setTitle(String name) → void

UncompleteDocumentation

override

setUnknownDecMode(int mode, bool enabled) → void

UncompleteDocumentation

override

setUnknownMode(int mode, bool enabled) → void

UncompleteDocumentation

override

shiftIn() → void

UncompleteDocumentation UncompleteDocumentation

override

shiftOut() → void

UncompleteDocumentation UncompleteDocumentation

override

tab() → void

UncompleteDocumentation UncompleteDocumentation

override

textInput(String text) → void

Sends regular text input to the underlying program.

toString() → String

A string representation of this object.

override

unknownCSI(int finalByte) → void

UncompleteDocumentation

override

unknownOSC(String ps, List<String> pt) → void

UncompleteDocumentation

override

unknownSBC(int char) → void

UncompleteDocumentation UncompleteDocumentation

override

unkownEscape(int char) → void

UncompleteDocumentation UncompleteDocumentation

override

unsetCursorBlink() → void

UncompleteDocumentation

override

unsetCursorBold() → void

UncompleteDocumentation

override

unsetCursorFaint() → void

UncompleteDocumentation

override

unsetCursorInverse() → void

UncompleteDocumentation

override

unsetCursorInvisible() → void

UncompleteDocumentation

override

unsetCursorItalic() → void

UncompleteDocumentation

override

unsetCursorStrikethrough() → void

UncompleteDocumentation

override

unsetCursorUnderline() → void

UncompleteDocumentation

override

unsupportedStyle(int param) → void

UncompleteDocumentation

override

useAltBuffer() → void

UncompleteDocumentation

override

useMainBuffer() → void

UncompleteDocumentation

override

write(String data) → void

Writes the data from the underlying program to the terminal. Calling this updates the states of the terminal and emits events such as onBell or onTitleChange when the escape sequences in data request it.

writeChar(int char) → void

UncompleteDocumentation UncompleteDocumentation

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited