term

Documentation

Index

• type EventAPC
• type EventBell
• type EventClosed
• type EventNotify
• type EventPanic
• type EventTitle
• type Image
• type Model
  • func New() *Model
  • func (vt *Model) Attach(fn func(ev vaxis.Event))
  • func (vt *Model) Blur()
  • func (vt *Model) Close()
  • func (vt *Model) Detach()
  • func (vt *Model) Draw(win vaxis.Window)
  • func (vt *Model) Focus()
  • func (vt *Model) Resize(w int, h int)
  • func (vt *Model) Start(cmd *exec.Cmd) error
  • func (vt *Model) StartWithSize(cmd *exec.Cmd, width int, height int) error
  • func (vt *Model) String() string
  • func (vt *Model) Update(msg vaxis.Event)

Types

type EventAPC

type EventAPC struct {
	Payload string
}

EventAPC is emitted when an APC sequence is received in the terminal

type EventBell

type EventBell struct{}

EventBell is emitted when BEL is received

type EventClosed

type EventClosed struct {
	Term  *Model
	Error error
}

type EventNotify

type EventNotify struct {
	Title string
	Body  string
}

type EventPanic

type EventPanic error

type EventTitle

type EventTitle string

type Image

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

type Model

type Model struct {
	// If true, OSC8 enables the output of OSC8 strings. Otherwise, any OSC8
	// sequences will be stripped
	OSC8 bool
	// Set the TERM environment variable to be passed to the command's
	// environment. If not set, xterm-256color will be used
	TERM string
	// contains filtered or unexported fields
}

Model models a virtual terminal

func New

func New() *Model

func (*Model) Attach

func (vt *Model) Attach(fn func(ev vaxis.Event))

func (*Model) Blur

func (vt *Model) Blur()

func (*Model) Close

func (vt *Model) Close()

func (*Model) Detach

func (vt *Model) Detach()

func (*Model) Draw

func (vt *Model) Draw(win vaxis.Window)

func (*Model) Focus

func (vt *Model) Focus()

func (*Model) Resize

func (vt *Model) Resize(w int, h int)

func (*Model) Start

func (vt *Model) Start(cmd *exec.Cmd) error

Start starts the terminal with the specified command. Start returns when the command has been successfully started.

func (*Model) StartWithSize

func (vt *Model) StartWithSize(cmd *exec.Cmd, width int, height int) error

func (*Model) String

func (vt *Model) String() string

func (*Model) Update

func (vt *Model) Update(msg vaxis.Event)

Update is called from the host application. This is user input