TextInputKeyMap class

Key map for text input navigation and editing.

Defines all keyboard shortcuts for cursor movement, text deletion, clipboard operations, and suggestion navigation. Each binding can be customized by providing a custom KeyBinding.

Default bindings follow common terminal/editor conventions:

  • Arrow keys for navigation
  • Ctrl+A/E for line start/end (Emacs-style)
  • Alt+Arrow for word navigation
  • Ctrl+W for delete word backward
  • Ctrl+K/U for delete after/before cursor

See also:

  • KeyBinding for defining custom key bindings
  • KeyMap for the interface this implements
Implemented types

Constructors

TextInputKeyMap({KeyBinding? characterForward, KeyBinding? characterBackward, KeyBinding? wordForward, KeyBinding? wordBackward, KeyBinding? deleteWordBackward, KeyBinding? deleteWordForward, KeyBinding? deleteAfterCursor, KeyBinding? deleteBeforeCursor, KeyBinding? deleteCharacterBackward, KeyBinding? deleteCharacterForward, KeyBinding? lineStart, KeyBinding? lineEnd, KeyBinding? selectCharacterForward, KeyBinding? selectCharacterBackward, KeyBinding? selectWordForward, KeyBinding? selectWordBackward, KeyBinding? selectLineStart, KeyBinding? selectLineEnd, KeyBinding? selectAll, KeyBinding? paste, KeyBinding? copy, KeyBinding? cut, KeyBinding? acceptSuggestion, KeyBinding? nextSuggestion, KeyBinding? prevSuggestion, KeyBinding? newline, KeyBinding? lineUp, KeyBinding? lineDown, KeyBinding? selectLineUp, KeyBinding? selectLineDown, KeyBinding? documentStart, KeyBinding? documentEnd})
Creates a text input key map with default bindings.

Properties

acceptSuggestion KeyBinding
Accept current suggestion.
final
characterBackward KeyBinding
Move cursor backward one character.
final
characterForward KeyBinding
Move cursor forward one character.
final
copy KeyBinding
Copy to clipboard.
final
cut KeyBinding
Cut to clipboard.
final
deleteAfterCursor KeyBinding
Delete all text after cursor.
final
deleteBeforeCursor KeyBinding
Delete all text before cursor.
final
deleteCharacterBackward KeyBinding
Delete character before cursor.
final
deleteCharacterForward KeyBinding
Delete character after cursor.
final
deleteWordBackward KeyBinding
Delete word before cursor.
final
deleteWordForward KeyBinding
Delete word after cursor.
final
documentEnd KeyBinding
Move cursor to end of document (multi-line mode only).
final
documentStart KeyBinding
Move cursor to start of document (multi-line mode only).
final
hashCode int
The hash code for this object.
no setterinherited
lineDown KeyBinding
Move cursor down one line (multi-line mode only).
final
lineEnd KeyBinding
Move cursor to end of line.
final
lineStart KeyBinding
Move cursor to start of line.
final
lineUp KeyBinding
Move cursor up one line (multi-line mode only).
final
newline KeyBinding
Insert a newline (multi-line mode only).
final
nextSuggestion KeyBinding
Move to next suggestion.
final
paste KeyBinding
Paste from clipboard.
final
prevSuggestion KeyBinding
Move to previous suggestion.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selectAll KeyBinding
Select all text.
final
selectCharacterBackward KeyBinding
Select one character backward.
final
selectCharacterForward KeyBinding
Select one character forward.
final
selectLineDown KeyBinding
Extend selection one line down (multi-line mode only).
final
selectLineEnd KeyBinding
Select to end of line.
final
selectLineStart KeyBinding
Select to start of line.
final
selectLineUp KeyBinding
Extend selection one line up (multi-line mode only).
final
selectWordBackward KeyBinding
Select one word backward.
final
selectWordForward KeyBinding
Select one word forward.
final
wordBackward KeyBinding
Move cursor backward one word.
final
wordForward KeyBinding
Move cursor forward one word.
final

Methods

fullHelp() List<List<KeyBinding>>
Returns bindings for the full help view, grouped by columns.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
shortHelp() List<KeyBinding>
Returns bindings for the short help view.
override
toString() String
A string representation of this object.
inherited

Operators

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