tcell

Documentation

Index

• Constants
• type Option
  • func ClearStyle(fg, bg cell.Color) Option
  • func ColorMode(cm terminalapi.ColorMode) Option
• type Terminal
  • func New(opts ...Option) (*Terminal, error)
  • func (t *Terminal) Clear(opts ...cell.Option) error
  • func (t *Terminal) Close()
  • func (t *Terminal) Event(ctx context.Context) terminalapi.Event
  • func (t *Terminal) Flush() error
  • func (t *Terminal) HideCursor()
  • func (t *Terminal) SetCell(p image.Point, r rune, opts ...cell.Option) error
  • func (t *Terminal) SetCursor(p image.Point)
  • func (t *Terminal) Size() image.Point

Constants

const DefaultColorMode = terminalapi.ColorMode256

DefaultColorMode is the default value for the ColorMode option.

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is used to provide options.

func ClearStyle

func ClearStyle(fg, bg cell.Color) Option

ClearStyle sets the style to use for tcell when clearing the screen. Defaults to ColorDefault for foreground and background.

func ColorMode

func ColorMode(cm terminalapi.ColorMode) Option

ColorMode sets the terminal color mode. Defaults to DefaultColorMode.

type Terminal

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

Terminal provides input and output to a real terminal. Wraps the gdamore/tcell terminal implementation. This object is not thread-safe. Implements terminalapi.Terminal.

func New

func New(opts ...Option) (*Terminal, error)

New returns a new tcell based Terminal. Call Close() when the terminal isn't required anymore.

func (*Terminal) Clear

func (t *Terminal) Clear(opts ...cell.Option) error

Clear implements terminalapi.Terminal.Clear.

func (*Terminal) Close

func (t *Terminal) Close()

Close closes the terminal, should be called when the terminal isn't required anymore to return the screen to a sane state. Implements terminalapi.Terminal.Close.

func (*Terminal) Event

func (t *Terminal) Event(ctx context.Context) terminalapi.Event

Event implements terminalapi.Terminal.Event.

func (*Terminal) Flush

func (t *Terminal) Flush() error

Flush implements terminalapi.Terminal.Flush.

func (*Terminal) HideCursor

func (t *Terminal) HideCursor()

HideCursor implements terminalapi.Terminal.HideCursor.

func (*Terminal) SetCell

func (t *Terminal) SetCell(p image.Point, r rune, opts ...cell.Option) error

SetCell implements terminalapi.Terminal.SetCell.

func (*Terminal) SetCursor

func (t *Terminal) SetCursor(p image.Point)

SetCursor implements terminalapi.Terminal.SetCursor.

func (*Terminal) Size

func (t *Terminal) Size() image.Point

Size implements terminalapi.Terminal.Size.