TextOffsetStateSnapshot class final

Available extensions

• TextOffsetStateCommandExtensions
• TextOffsetStateDocumentEditingExtensions

Constructors

TextOffsetStateSnapshot({required int cursorOffset, int? selectionBaseOffset, int? selectionExtentOffset})

const

TextOffsetStateSnapshot.collapsed({required int cursorOffset})

factory

TextOffsetStateSnapshot.selection({required int baseOffset, required int extentOffset, int? cursorOffset, bool preserveCollapsedSelection = false})

factory

Properties

cursorOffset → int

final

hashCode → int

The hash code for this object.

no setter, inherited

hasSelection → bool

no setter

normalizedSelectionRange → ({int end, int start})?

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selectionBaseOffset → int?

final

selectionExtentOffset → int?

final

Methods

clamp(int textLength, {bool preserveCollapsedSelection = false}) → TextOffsetStateSnapshot

clearSelection({int? cursorOffset}) → TextOffsetStateSnapshot

deleteNextCommand(List<String> graphemes) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

deleteNextDocumentCommand(TextDocument document) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

deleteNextOrSelectionCommand(List<String> graphemes) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

deletePreviousCommand(List<String> graphemes) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

deletePreviousDocumentCommand(TextDocument document) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

deletePreviousOrSelectionCommand(List<String> graphemes) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

deleteSelectionCommand(List<String> graphemes) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

deleteSelectionDocumentCommand(TextDocument document) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

deleteSurroundingPairCommand(List<String> graphemes, {required Map<String, String> surroundPairs}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

deleteToLineEndCommand(List<String> graphemes, {required int lineEndOffset}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

deleteToLineEndDocumentCommand(TextDocument document) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

deleteToLineStartCommand(List<String> graphemes, {required int lineStartOffset}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

deleteToLineStartDocumentCommand(TextDocument document) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

deleteWordBackwardCommand(List<String> graphemes, {required GraphemePredicate isWord}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

deleteWordBackwardDocumentCommand(TextDocument document, {GraphemePredicate isWord = _isWordGrapheme}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

deleteWordForwardCommand(List<String> graphemes, {required GraphemePredicate isWord}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

deleteWordForwardDocumentCommand(TextDocument document, {GraphemePredicate isWord = _isWordGrapheme}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

insertAutoPairCommand(List<String> graphemes, {required List<String> opening, required List<String> closing}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

insertIndentedNewlineCommand(List<String> graphemes, {required List<String> baseIndent, List<String> additionalIndent = const <String>[], List<String> trailingSuffix = const <String>[], int trailingSuffixReplaceCount = 0}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

insertTextDocumentCommand(TextDocument document, {required String text, bool replaceSelection = true}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

moveByCharacterCommand(List<String> graphemes, {required bool forward, bool extendSelection = false, bool clearSelection = true, bool preserveCollapsedSelection = false}) → TextCursorCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

moveByCharacterDocumentCommand(TextDocument document, {required bool forward, bool extendSelection = false, bool clearSelection = false}) → TextCursorCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

moveByVisualLineCommand(TextDocument document, EditorState state, TextView view, {required int lineDelta, int desiredDisplayColumn = -1, bool extendSelection = false, bool clearSelection = true, bool preserveCollapsedSelection = false}) → TextCursorCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

moveByWordCommand(List<String> graphemes, {required bool forward, required GraphemePredicate isWord, bool extendSelection = false, bool clearSelection = true, bool preserveCollapsedSelection = false}) → TextCursorCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

moveByWordDocumentCommand(TextDocument document, {required bool forward, GraphemePredicate isWord = _isWordGrapheme, bool extendSelection = false, bool clearSelection = false}) → TextCursorCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

moveToDocumentBoundaryCommand(List<String> graphemes, {required bool forward, bool extendSelection = false, bool clearSelection = true, bool preserveCollapsedSelection = false}) → TextCursorCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

moveToDocumentBoundaryDocumentCommand(TextDocument document, {required bool forward, bool extendSelection = false, bool clearSelection = false}) → TextCursorCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

moveToVisualLineBoundaryCommand(TextDocument document, EditorState state, TextView view, {required bool end, bool extendSelection = false, bool clearSelection = true, bool preserveCollapsedSelection = false}) → TextCursorCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

replaceSelectionOrInsertCommand(List<String> graphemes, {List<String> replacement = const <String>[], bool replaceSelection = true}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

replaceSelectionOrInsertDocumentCommand(TextDocument document, {List<String> replacement = const <String>[], bool replaceSelection = true}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

skipClosingDelimiterCommand(List<String> graphemes, {required List<String> closing, bool clearSelection = false}) → TextCursorCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

splitLineDocumentCommand(TextDocument document) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

toggleDelimitedSegmentCommand(List<String> graphemes, {required int rangeStartOffset, required int rangeEndOffset, required String startDelimiter, required String endDelimiter}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

toString() → String

A string representation of this object.

inherited

transformSelectionOrLineCommand(List<String> graphemes, {required int lineStartOffset, required int lineEndOffset, required String transform(String text)}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

transformSelectionOrLineDocumentCommand(TextDocument document, {required String transform(String text)}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

transformWordOrAdjacentCommand(List<String> graphemes, {required GraphemePredicate isWord, required String transform(String text)}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

transformWordOrAdjacentDocumentCommand(TextDocument document, {required String transform(String text)}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

transposeBackwardDocumentCommand(TextDocument document) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

unwrapSelectionCommand(List<String> graphemes, {required Map<String, String> surroundPairs}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

unwrapSelectionDocumentCommand(TextDocument document, {required Map<String, String> surroundPairs}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

wrapSelectionCommand(List<String> graphemes, {required List<String> before, List<String>? after}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateCommandExtensions extension

wrapSelectionDocumentCommand(TextDocument document, {required String before, String? after}) → TextCommandResult

Available on TextOffsetStateSnapshot, provided by the TextOffsetStateDocumentEditingExtensions extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited