txtview

Documentation

Index

• type Options
  • func NewDefaultOpts() *Options
• type Viewer
  • func NewViewer(opts ...*Options) *Viewer
  • func (v *Viewer) App() *tview.Application
  • func (v *Viewer) Run() error
  • func (v *Viewer) SetOpts(opts *Options) *Viewer
  • func (v *Viewer) Stop()
  • func (v *Viewer) View() *tview.TextView
  • func (v *Viewer) Write(p []byte) (n int, err error)

Types

type Options

type Options struct {
	Title *string

	BgColor       tcell.Color
	Wrap          bool
	DynamicColors bool
	Regions       bool
	FullScreen    bool

	X, Y, Rows, Cols int // Position and size of the viewer when FullScreen is false

	Border      bool
	BorderAttr  *tcell.AttrMask
	BorderStyle *tcell.Style

	DoneFunc func(tcell.Key, *Viewer)
}

func NewDefaultOpts

func NewDefaultOpts() *Options

type Viewer

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

func NewViewer

func NewViewer(opts ...*Options) *Viewer

func (*Viewer) App

func (v *Viewer) App() *tview.Application

func (*Viewer) Run

func (v *Viewer) Run() error

func (*Viewer) SetOpts

func (v *Viewer) SetOpts(opts *Options) *Viewer

func (*Viewer) Stop

func (v *Viewer) Stop()

func (*Viewer) View

func (v *Viewer) View() *tview.TextView

func (*Viewer) Write

func (v *Viewer) Write(p []byte) (n int, err error)