screen

package

v0.0.0-...-2352b81 Latest Latest Go to latest Published: May 25, 2023 License: MIT Imports: 5 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

This section is empty.

This section is empty.

This section is empty.

type Dimension struct {
	X, Y int
}

Dimension is a struct that has X and Y field to represent a rectangle

type Screen struct {
	ScreenDim Dimension
	// contains filtered or unexported fields
}

Screen is a struct that has the logic to display the editor state on the terminal

func NewScreen() (*Screen, error)

NewScreen creates a new screen object

func (s *Screen) Close()

Close - Closes the Screen

func (s *Screen) DisplayCursor(cursor Vertex)

DisplayCursor is used to display cursor on the screen at the given Vertex

func (s *Screen) DisplayStatusBar(text string)

DisplayStatusBar is used to display status bar line on the screen

func (s *Screen) DisplayTextFrame(textFrame [][]rune)

DisplayTextFrame is used to display a textFrame object on the screen

func (s *Screen) TerminalScreen() tcell.Screen

TerminalScreen can be used to get the underlying tcell.Screen object

type Vertex struct {
	X, Y int
}

Vertex is a struct to represent a coord on the terminal