selection

package

v1.3.0 Latest Latest Go to latest Published: Mar 23, 2024 License: GPL-3.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	ModeNone = Mode(iota)
	ModeChar
	ModeLine
)

View Source

var EmptyRegion = Region{}

This section is empty.

type Mode int

Mode controls the selection behavior (charwise or linewise).

type Region struct {
	StartPos uint64 // Inclusive
	EndPos   uint64 // Exclusive
}

Region represents a selection within a document. The zero value represents an empty selection.

func (r Region) Clip(n uint64) Region

Clip ensures that the region is within a document of length n.

func (r Region) ContainsPosition(pos uint64) bool

ContainsPosition returns whether the position is within the region.

type Selector struct {
	// contains filtered or unexported fields
}

Selector tracks the selected region of the document.

func (s *Selector) Clear()

Clear clears the currently selected region, if any.

func (s *Selector) Mode() Mode

Mode returns the current selection mode.

func (s *Selector) Region(tree *text.Tree, cursorPos uint64) Region

Region returns the currently selected region. If nothing is currently selected, the returned region will be empty.

func (s *Selector) SetMode(mode Mode)

SetMode sets the selection mode.

func (s *Selector) Start(mode Mode, cursorPos uint64)

Start begins a new selection from the current cursor position.