TerminalUiInteraction class abstract

this interface describes what a Terminal UI needs from a Terminal

Mixed-in types
Implementers

Constructors

TerminalUiInteraction.new()

Properties

backendExited → Future<int>
Future that fires when the backend has exited
no setter
backgroundColor → int
color code for the background
no setter
bufferHeight → int
the total buffer height
no setter
composingString → String
returns the current composing string. '' when there is no composing going on
no setter
currentLine → BufferLine?
current line
no setter
currentSearchHit ↔ int?
gets the current search hit
getter/setter pair
cursorColor → int
color code for the cursor
no setter
cursorX → int
cursor x coordinate
no setter
cursorY → int
cursor y coordinate
no setter
dirty → bool
flag that indicates if the terminal is dirty (since the last time this flag has been queried)
no setter
hashCode → int
The hash code for this object.
no setterinherited
invisibleHeight → int
the part of the buffer that is not visible (scrollback)
no setter
isReady → bool
flag that indicates if the Terminal is ready
no setter
isTerminated → bool
flag that indicates if the backend is already terminated
no setter
isUserSearchActive ↔ bool
gets if a user search is active
getter/setter pair
listeners → Set<_VoidCallback>
finalinherited
numberOfSearchHits → int
gets the number of search hits
no setter
platform → PlatformBehavior
platform behavior for this terminal
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrollOffsetFromBottom → int
the ViewPort scroll offset from the bottom
no setter
scrollOffsetFromTop → int
the ViewPort scroll offset from the top
no setter
selectedText → String?
selected text defined by selection
no setter
selection → Selection?
object that describes details about the current selection
no setter
showCursor → bool
true when the cursor shall be shown, otherwise false
no setter
terminalHeight → int
terminal height (view port)
no setter
terminalWidth → int
terminal width (view port)
no setter
theme → TerminalTheme
The theme associated with this Terminal
no setter
userSearchOptions ↔ TerminalSearchOptions
gets the current user search options
getter/setter pair
userSearchPattern ↔ String?
the search pattern of a currently active search or null
getter/setter pair
userSearchResult → TerminalSearchResult
returns the list of search hits
no setter

Methods

addListener(_VoidCallback listener) → void
inherited
clearSelection() → void
clears the selection
convertViewLineToRawLine(int viewLine) → int
converts the given view line (view port line) index to its position in the overall buffer
getVisibleLines() → List<BufferLine>
returns the visible lines
keyInput(TerminalKey key, {bool ctrl = false, bool alt = false, bool shift = false, bool mac = false, String? character}) → void
notifies the Terminal about key input
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
inherited
onMouseDoubleTap(Position position) → void
notify the Terminal about a mouse double tap
onMouseTap(Position position) → void
notify the Terminal about a mouse tap
onPanStart(Position position) → void
notify the Terminal about a pan start
onPanUpdate(Position position) → void
notify the Terminal about a pan update
paste(String data) → void
paste clipboard content to the Terminal
raiseOnInput(String input) → void
notifies the Terminal about user input
refresh() → void
refreshes the Terminal (notifies listeners and sets it to dirty)
removeListener(_VoidCallback listener) → void
inherited
resize(int newWidth, int newHeight, int newPixelWidth, int newPixelHeight) → void
notifies the Terminal about a resize that happened. The Terminal will do any resize / reflow logic and notify the backend about the resize
selectAll() → void
select the whole buffer
setScrollOffsetFromBottom(int offset) → void
sets the scroll offset from bottom (scrolling)
terminateBackend() → void
terminates the backend. If already terminated, nothing happens
toString() → String
A string representation of this object.
inherited
updateComposingString(String value) → void
update the composing string. This gets called by the input handling part of the terminal
write(String text) → void
writes data to the Terminal

Operators

operator ==(Object other) → bool
The equality operator.
inherited