components

Documentation

Index

• type MainMenu
  • func NewMainMenu() *MainMenu
  • func (m *MainMenu) AddItem(text string, shortcut rune) *MainMenu
  • func (m *MainMenu) Clear() *MainMenu
  • func (m *MainMenu) Draw(screen tcell.Screen)
  • func (m *MainMenu) InputHandler() func(event *tcell.EventKey, setFocus func(p tview.Primitive))
  • func (m *MainMenu) SetMainTextColor(c tcell.Color) *MainMenu
  • func (m *MainMenu) SetSelectedBackgroundColor(c tcell.Color) *MainMenu
  • func (m *MainMenu) SetSelectedFunc(handler func(int, string, rune)) *MainMenu
  • func (m *MainMenu) SetSelectedTextColor(c tcell.Color) *MainMenu
• type Menubar
  • func NewMenubar(app *tview.Application) *Menubar
  • func (m *Menubar) Draw(screen tcell.Screen)
  • func (m *Menubar) SetDisplayTime(b bool) *Menubar
  • func (m *Menubar) SetSlot(idx int, text string, selected func()) *Menubar

Types

type MainMenu

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

MainMenu is our main menu

func NewMainMenu

func NewMainMenu() *MainMenu

NewMainMenu creates an empty main menu

func (*MainMenu) AddItem

func (m *MainMenu) AddItem(text string, shortcut rune) *MainMenu

AddItem adds a new item to the main menu

func (*MainMenu) Clear

func (m *MainMenu) Clear() *MainMenu

Clear will remove all menu items

func (*MainMenu) Draw

func (m *MainMenu) Draw(screen tcell.Screen)

Draw will draw the main menu on screen

func (*MainMenu) InputHandler

func (m *MainMenu) InputHandler() func(event *tcell.EventKey, setFocus func(p tview.Primitive))

InputHandler will be called when the main menu is active and we have an input. It will deal with navigating through the main menu

func (*MainMenu) SetMainTextColor

func (m *MainMenu) SetMainTextColor(c tcell.Color) *MainMenu

SetMainTextColor sets the main text color

func (*MainMenu) SetSelectedBackgroundColor

func (m *MainMenu) SetSelectedBackgroundColor(c tcell.Color) *MainMenu

SetSelectedBackgroundColor is the selected background color

func (*MainMenu) SetSelectedFunc

func (m *MainMenu) SetSelectedFunc(handler func(int, string, rune)) *MainMenu

SetSelectedFunc sets the function that is called when an item is selected

func (*MainMenu) SetSelectedTextColor

func (m *MainMenu) SetSelectedTextColor(c tcell.Color) *MainMenu

SetSelectedTextColor is the selected text color

type Menubar

type Menubar struct {
	*tview.Box
	DisplayTime bool
	Slots       [10]*menubarSlot
}

Menubar is a structure that holds a menu bar in the bottom

func NewMenubar

func NewMenubar(app *tview.Application) *Menubar

NewMenubar creates a new menu bar

func (*Menubar) Draw

func (m *Menubar) Draw(screen tcell.Screen)

Draw will draw the menubar on the screen

func (*Menubar) SetDisplayTime

func (m *Menubar) SetDisplayTime(b bool) *Menubar

SetDisplayTime will display or undisplay the time

func (*Menubar) SetSlot

func (m *Menubar) SetSlot(idx int, text string, selected func()) *Menubar

SetSlot set the given menubar index with a menu item. It will call the selected() function whenever we select the given function from the menubar.