caret

Documentation

Index

• type Direction
• type Modifier
• type Selection

Types

type Direction

type Direction int

const (
	// NoDirection means that there was no Direction used
	// to move the caret.  It does not necessarily mean
	// that it didn't move.
	NoDirection Direction = iota

	Up
	Down
	Left
	Right
)

type Modifier

type Modifier int

const (
	// Select means that a caret movement should add to a selection.
	Select Modifier = 1 << iota

	// Multi means that caret movement should move multiple carets.
	Multi

	NoMod Modifier = 0
)

type Selection

type Selection struct {
	// At is the start of the selection. If Length == 0, then this is the caret
	// position.
	At int

	// Len is how many characters after At are also selected.
	Len int
}

A Selection is a position and length representing a range of selected text. Length == 0 means that this Selection is simply a caret.

Some UI libraries choose to display the caret at the beginning or end of a selection, but vidar will always treat a selection as if it does not have a caret. By default, caret movement left or right will deselect, leaving the caret at either the beginning or the end of the selection, respectively.