Module prelude

Expand description

§Common set of types used for describing actions

§Overview

These types are used to specify the details of how to execute Action and the more specific actions that it encompasses.

Usually you will just want to import everything in this module into your application via:

use editor_types::prelude::*;

Structs§

BoundaryTestContext: Contextual information given while searching for the boundary of a range.
CloseFlags: These flags are used to specify the behaviour while closing a window.
CursorMovementsContext: This context object wraps information used when calculating what text covered by cursor movements.
EditRange: Description of a textual range within a buffer.
OpenFlags: These flags are used to specify the behaviour while writing a window.
RangeEnding: One of the sides of a range.
TargetShapeFilter: Bitmask that specifies what shapes are targeted by an action.
ViewportContext: Information about what portion of a buffer is being displayed in a window.
WriteFlags: These flags are used to specify the behaviour while writing a window.

Enums§

Axis: This represents a selection of a 2-dimensional axis.
Case: Specify how to change the case of a string.
Char: A character.
CommandType: When focusing on the command bar, this is the type of command that should be submitted.
CompletionDisplay: How to display completion candidates.
CompletionScope: The source to search for completion candidates.
CompletionSelection: What type of phrase we are completing.
CompletionType: What type of phrase we are completing.
Count: This represents how to determine what count argument should be applied to an action.
CursorCloseTarget: Target cursors in a cursor group.
CursorEnd: Determines where to leave the cursor after editing text.
CursorGroupCombineStyle: Ways to combine a newer cursor group with an already existing one.
CursorMergeStyle: Ways to combine two selections.
EditTarget: Specify what is targeted by an editing action.
FocusChange: This represents what UI element is targeted during an Action.
IndentChange: This represents how to change the indentation of a range.
InfoMessage: Information to show the user at the bottom of the screen after an action.
InsertStyle: This specifies the behaviour of entering and backspacing over characters.
JoinStyle: Specify how to join lines together.
Mark: Saved cursor positions.
MoveDir1D: Represent movement along a 1-dimensional line.
MoveDir2D: Represent movement along the horizontal or vertical axes.
MoveDirMod: Represents a modification of a previous MoveDir1D movement.
MovePosition: Represent movement to a position along a 1-dimensional line.
MoveTerminus: Represents the two sides of a range that has no meaningful middle.
MoveType: Specify a movement away from the current cursor position.
NumberChange: This represents how to change a number in text.
OpenTarget: Targets for WindowAction::Open and WindowAction::Switch.
PasteStyle: Specify how to insert register contents into a buffer.
PositionList: This specifies which list of cursors to use when jumping, the change list or the jump list.
Radix: Specify the base for a number.
RangeEndingModifier: Modifier to a range ending.
RangeEndingType: Methods for determining the start and end of a RangeSpec.
RangeSearchInit: Position to begin a search in a range.
RangeSpec: A range specification.
RangeType: Specify a range within the text around the current cursor position.
Register: Locations for temporarily storing text shared between buffers.
RepeatType: Different action sequences that can be repeated.
ScrollSize: This represents the units used when scrolling.
ScrollStyle: This represents the way in which the viewport should be scrolled.
SearchType: Specify a range within the text around the current cursor position.
SelectionBoundary: Different ways to expand or trim selections.
SelectionCursorChange: Place the cursor at a specified position in a visual selection, with the anchor now at the opposite end.
SelectionResizeStyle: Different ways to change the boundaries of a visual selection.
SelectionSplitStyle: Different ways to split existing selections into new ones.
SizeChange: This represents how to change the size of a window.
Specifier: A value that may not be known now, but is present in the context.
TabTarget: This represents what tabs are targeted by a tab command.
TargetShape: This specifies either the shape of a visual selection, or a forced motion.
WindowTarget: This represents what windows are targeted by a window command.
WordStyle: The different ways of grouping a buffer’s contents into words.

Traits§

BoundaryTest: Trait for types which have simple start and end boundaries within a text document.
CursorMovements: Trait for objects capable of calculating contextual offsets from a cursor.
CursorSearch: Trait for objects capable of searching text.
Flip: Trait for directions capable of being flipped.
Wrappable: Trait for objects that allow toggling line wrapping.

Type Aliases§

EditInfo: An optional, information message provided during editing.