TerminalLibraryFlutterViewWidget class
Constructors
-
TerminalLibraryFlutterViewWidget(TerminalLibraryFlutter terminal, {Key? key, TerminalLibraryFlutterController? controller, TerminalLibraryFlutterTheme theme = TerminalLibraryFlutterThemes.defaultTheme, TerminalLibraryFlutterStyle textStyle = const TerminalLibraryFlutterStyle(), TextScaler? textScaler, EdgeInsets? padding, ScrollController? scrollController, bool autoResize = true, double backgroundOpacity = 1, FocusNode? focusNode, bool autofocus = false, void onTapUp(TapUpDetails, CellOffset)?, void onSecondaryTapDown(TapDownDetails, CellOffset)?, void onSecondaryTapUp(TapUpDetails, CellOffset)?, MouseCursor mouseCursor = SystemMouseCursors.text, TextInputType keyboardType = TextInputType.emailAddress, Brightness keyboardAppearance = Brightness.dark, TerminalLibraryFlutterCursorType cursorType = TerminalLibraryFlutterCursorType.block, bool alwaysShowCursor = false, bool deleteDetection = false, Map<ShortcutActivator, Intent>? shortcuts, FocusOnKeyEventCallback? onKeyEvent, bool readOnly = false, bool hardwareKeyboardOnly = false, bool simulateScroll = true})
-
const
Properties
-
alwaysShowCursor
→ bool
-
Whether to always show the cursor. This is useful for debugging.
false by default.
final
-
autofocus
→ bool
-
True if this widget will be selected as the initial focus when no other
node in its scope is currently focused.
final
-
autoResize
→ bool
-
Should this widget automatically notify the underlying terminal when its
size changes.
true by default.
final
-
backgroundOpacity
→ double
-
Opacity of the terminal background. Set to 0 to make the terminal
background transparent.
final
-
controller
→ TerminalLibraryFlutterController?
-
final
-
cursorType
→ TerminalLibraryFlutterCursorType
-
The type of cursor to use. TerminalLibraryFlutterCursorType.block by default.
final
-
deleteDetection
→ bool
-
Workaround to detect delete key for platforms and IMEs that does not
emit hardware delete event. Prefered on mobile platforms.
false by
default.
final
-
focusNode
→ FocusNode?
-
An optional focus node to use as the focus node for this widget.
final
-
hardwareKeyboardOnly
→ bool
-
True if only hardware keyboard events should be used as input. This will
also prevent any on-screen keyboard to be shown.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
key
→ Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
keyboardAppearance
→ Brightness
-
The appearance of the keyboard. Brightness.dark by default.
final
-
keyboardType
→ TextInputType
-
The type of information for which to optimize the text input control.
TextInputType.emailAddress by default.
final
-
mouseCursor
→ MouseCursor
-
The mouse cursor for mouse pointers that are hovering over the terminal.
SystemMouseCursors.text by default.
final
-
onKeyEvent
→ FocusOnKeyEventCallback?
-
Keyboard event handler of the terminal. This has higher priority than
shortcuts and input handler of the terminal.
final
-
onSecondaryTapDown
→ void Function(TapDownDetails, CellOffset)?
-
Function called when the user taps on the terminal with a secondary
button.
final
-
onSecondaryTapUp
→ void Function(TapUpDetails, CellOffset)?
-
Function called when the user stops holding down a secondary button.
final
-
onTapUp
→ void Function(TapUpDetails, CellOffset)?
-
Callback for when the user taps on the terminal.
final
-
padding
→ EdgeInsets?
-
Padding around the inner Scrollable widget.
final
-
readOnly
→ bool
-
True if no input should send to the terminal.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
scrollController
→ ScrollController?
-
Scroll controller for the inner Scrollable widget.
final
-
shortcuts
→ Map<ShortcutActivator, Intent>?
-
Shortcuts for this terminal. This has higher priority than input handler
of the terminal If not provided, defaultTerminalLibraryFlutterShortcuts will be used.
final
-
simulateScroll
→ bool
-
If true, when the terminal is in alternate buffer (for example running
vim, man, etc), if the application does not declare that it can handle
scrolling, the terminal will simulate scrolling by sending up/down arrow
keys to the application. This is standard behavior for most terminal
emulators. True by default.
final
-
terminal
→ TerminalLibraryFlutter
-
The underlying terminal that this widget renders.
final
-
textScaler
→ TextScaler?
-
final
-
textStyle
→ TerminalLibraryFlutterStyle
-
The style to use for painting characters.
final
-
theme
→ TerminalLibraryFlutterTheme
-
The theme to use for this terminal.
final
