Struct Editor

texteditor/editor.go:56–207

Editor is a widget for editing multiple lines of complicated text (as compared to [core.TextField] for a single line of simple text). The Editor is driven by a [Buffer] buffer which contains all the text, and manages all the edits, sending update events out to the editors. Use NeedsRender to drive

// Editor should be within a single goroutine, as it would require
// extensive protections throughout code otherwise.
type Editor struct { //core:embedder
	core.Frame

	// Buffer is the text buffer being edited.
	Buffer *Buffer `set:"-" json:"-" xml:"-"`

	// CursorWidth is the width of the cursor.
	// This should be set in Stylers like all other style properties.
	CursorWidth units.Value

	// LineNumberColor is the color used for the side bar containing the line numbers.
	// This should be set in Stylers like all other style properties.
	LineNumberColor image.Image

	// SelectColor is the color used for the user text selection background color.
	// This should be set in Stylers like all other style properties.
	SelectColor image.Image

	// HighlightColor is the color used for the text highlight background color (like in find).
	// This should be set in Stylers like all other style properties.
	HighlightColor image.Image

	// CursorColor is the color used for the text editor cursor bar.
	// This should be set in Stylers like all other style properties.
	CursorColor image.Image

	// NumLines is the number of lines in the view, synced with the [Buffer] after edits,
	// but always reflects the storage size of renders etc.
	NumLines int `set:"-" display:"-" json:"-" xml:"-"`

	// renders is a slice of paint.Text representing the renders of the text lines,
	// with one render per line (each line could visibly wrap-around, so these are logical lines, not display lines).
	renders []paint.Text

	// offsets is a slice of float32 representing the starting render offsets for the top of each line.
	offsets []float32

	// lineNumberDigits is the number of line number digits needed.
	lineNumberDigits int

	// LineNumberOffset is the horizontal offset for the start of text after line numbers.
	LineNumberOffset float32 `set:"-" display:"-" json:"-" xml:"-"`

	// lineNumberRender is the render for line numbers.
	lineNumberRender paint.Text

	// CursorPos is the current cursor position.
	CursorPos lexer.Pos `set:"-" edit:"-" json:"-" xml:"-"`

	// cursorTarget is the target cursor position for externally set targets.
	// It ensures that the target position is visible.
	cursorTarget lexer.Pos

	// cursorColumn is the desired cursor column, where the cursor was last when moved using left / right arrows.
	// It is used when doing up / down to not always go to short line columns.
	cursorColumn int

	// posHistoryIndex is the current index within PosHistory.