help

Documentation

Index

• type Help
  • func NewHelp(appName string, appVersion string) *Help
  • func (help *Help) Draw(screen tcell.Screen)
  • func (help *Help) Focus(delegate func(p tview.Primitive))
  • func (help *Help) GetTitle() string
  • func (help *Help) HasFocus() bool

Types

type Help

type Help struct {
	*tview.Box
	// contains filtered or unexported fields
}

Help is a help primitive dialog.

func NewHelp

func NewHelp(appName string, appVersion string) *Help

NewHelp returns a help screen primitive.

func (*Help) Draw

func (help *Help) Draw(screen tcell.Screen)

Draw draws this primitive onto the screen.

func (*Help) Focus

func (help *Help) Focus(delegate func(p tview.Primitive))

Focus is called when this primitive receives focus.

func (*Help) GetTitle

func (help *Help) GetTitle() string

GetTitle returns primitive title.

func (*Help) HasFocus

func (help *Help) HasFocus() bool

HasFocus returns whether or not this primitive has focus.