virtualterm

Documentation

Overview

Package virtualterm provides a virtual terminal and some terminal emulation functions

Index

• type Term
  • func NewTerminal(renderer types.Renderer, size *types.XY, visible bool) *Term
  • func (term *Term) Bg() *types.Colour
  • func (term *Term) CopyLines(top, bottom int32) []byte
  • func (term *Term) CopyRange(topLeft, bottomRight *types.XY) []byte
  • func (term *Term) CopySquare(begin *types.XY, end *types.XY) []byte
  • func (term *Term) GetSize() *types.XY
  • func (term *Term) HasFocus(state bool)
  • func (term *Term) IsAltBuf() bool
  • func (term *Term) MakeVisible(visible bool)
  • func (term *Term) Match(pos *types.XY)
  • func (term *Term) MouseClick(pos *types.XY, button uint8, clicks uint8, pressed bool, ...)
  • func (term *Term) MouseMotion(pos *types.XY, movement *types.XY, callback types.EventIgnoredCallback)
  • func (term *Term) MouseWheel(pos *types.XY, movement *types.XY)
  • func (term *Term) Render()
  • func (term *Term) Reply(b []byte)
  • func (term *Term) Resize(size *types.XY)
  • func (term *Term) Search()
  • func (term *Term) ShowCursor(v bool)
  • func (term *Term) Start(pty types.Pty)

Types

type Term

type Term struct {
	Pty types.Pty
	// contains filtered or unexported fields
}

Term is the display state of the virtual term

func NewTerminal

func NewTerminal(renderer types.Renderer, size *types.XY, visible bool) *Term

NewTerminal creates a new virtual term

func (*Term) Bg

func (term *Term) Bg() *types.Colour

func (*Term) CopyLines

func (term *Term) CopyLines(top, bottom int32) []byte

func (*Term) CopyRange

func (term *Term) CopyRange(topLeft, bottomRight *types.XY) []byte

func (*Term) CopySquare

func (term *Term) CopySquare(begin *types.XY, end *types.XY) []byte

func (*Term) GetSize

func (term *Term) GetSize() *types.XY

func (*Term) HasFocus

func (term *Term) HasFocus(state bool)

func (*Term) IsAltBuf

func (term *Term) IsAltBuf() bool

func (*Term) MakeVisible

func (term *Term) MakeVisible(visible bool)

func (*Term) Match

func (term *Term) Match(pos *types.XY)

func (*Term) MouseClick

func (term *Term) MouseClick(pos *types.XY, button uint8, clicks uint8, pressed bool, callback types.EventIgnoredCallback)

func (*Term) MouseMotion

func (term *Term) MouseMotion(pos *types.XY, movement *types.XY, callback types.EventIgnoredCallback)

func (*Term) MouseWheel

func (term *Term) MouseWheel(pos *types.XY, movement *types.XY)

func (*Term) Render

func (term *Term) Render()

func (*Term) Reply

func (term *Term) Reply(b []byte)

func (*Term) Resize

func (term *Term) Resize(size *types.XY)

func (*Term) Search

func (term *Term) Search()

func (*Term) ShowCursor

func (term *Term) ShowCursor(v bool)

func (*Term) Start

func (term *Term) Start(pty types.Pty)