climenu

Documentation

Index

• Constants
• func GetText(message string, defaultText string) string
• type ButtonMenu
  • func NewButtonMenu(heading string, question string) *ButtonMenu
  • func (m *ButtonMenu) Run() (string, bool)
• type CheckboxMenu
  • func NewCheckboxMenu(heading string, question string, yes string, no string) *CheckboxMenu
  • func (m *CheckboxMenu) Run() ([]string, bool)
• type Menu
  • func NewMenu(heading string, question string, menuType int) *Menu
  • func (m *Menu) AddMenuItem(text string, id string) *MenuItem
  • func (m *Menu) CursorDown()
  • func (m *Menu) CursorUp()
  • func (m *Menu) DrawMenuItems(redraw bool)
  • func (m *Menu) Dump()
  • func (m *Menu) DumpIndent(indent int)
  • func (m *Menu) Render()
  • func (m *Menu) RunInternal() (results []string, escape bool)
  • func (m *Menu) ToggleSelection()
• type MenuItem
  • func (mi *MenuItem) SetSubMenu(menu *Menu)

Constants

const (
	ButtonType = iota
	CheckboxType
)

Functions

func GetText

func GetText(message string, defaultText string) string

Types

type ButtonMenu

type ButtonMenu struct {
	Menu
}

func NewButtonMenu

func NewButtonMenu(heading string, question string) *ButtonMenu

func (*ButtonMenu) Run

func (m *ButtonMenu) Run() (string, bool)

type CheckboxMenu

type CheckboxMenu struct {
	Menu
	Yes string
	No  string
}

func NewCheckboxMenu

func NewCheckboxMenu(heading string, question string, yes string, no string) *CheckboxMenu

func (*CheckboxMenu) Run

func (m *CheckboxMenu) Run() ([]string, bool)

type Menu

type Menu struct {
	Type      int
	Heading   string
	Question  string
	CursorPos int
	MenuItems []*MenuItem
}

func NewMenu

func NewMenu(heading string, question string, menuType int) *Menu

func (*Menu) AddMenuItem

func (m *Menu) AddMenuItem(text string, id string) *MenuItem

func (*Menu) CursorDown

func (m *Menu) CursorDown()

func (*Menu) CursorUp

func (m *Menu) CursorUp()

func (*Menu) DrawMenuItems

func (m *Menu) DrawMenuItems(redraw bool)

func (*Menu) Dump

func (m *Menu) Dump()

func (*Menu) DumpIndent

func (m *Menu) DumpIndent(indent int)

func (*Menu) Render

func (m *Menu) Render()

func (*Menu) RunInternal

func (m *Menu) RunInternal() (results []string, escape bool)

func (*Menu) ToggleSelection

func (m *Menu) ToggleSelection()

type MenuItem

type MenuItem struct {
	Text     string
	ID       string
	SubMenu  *Menu
	Selected bool // For checkboxes.
}

func (*MenuItem) SetSubMenu

func (mi *MenuItem) SetSubMenu(menu *Menu)