component

Documentation

Index

• Constants
• func NewBlock(title string, border bool, palette console.Palette) *ui.Block
• func RenderAlert(alert *data.Alert, area image.Rectangle, buffer *ui.Buffer)
• type Component
  • func NewComponent(dbl ui.Drawable, cmr *data.Consumer, cfg config.ComponentConfig) *Component
  • func (c *Component) Move(x, y int)
  • func (c *Component) Resize(x, y int)
• type Menu
  • func NewMenu(palette console.Palette) *Menu
  • func (m *Menu) Choose()
  • func (m *Menu) Down()
  • func (m *Menu) Draw(buffer *ui.Buffer)
  • func (m *Menu) GetSelectedOption() menuOption
  • func (m *Menu) Highlight(component *Component)
  • func (m *Menu) Idle()
  • func (m *Menu) MoveOrResize()
  • func (m *Menu) Up()
• type StatusBar
  • func NewStatusBar(configFileName string, palette console.Palette) *StatusBar
  • func (s *StatusBar) Draw(buffer *ui.Buffer)
  • func (s *StatusBar) TogglePause()

Constants

const (
	MenuOptionMove     menuOption = "MOVE"
	MenuOptionResize   menuOption = "RESIZE"
	MenuOptionPinpoint menuOption = "PINPOINT"
	MenuOptionResume   menuOption = "RESUME"
)

Functions

func NewBlock

func NewBlock(title string, border bool, palette console.Palette) *ui.Block

func RenderAlert

func RenderAlert(alert *data.Alert, area image.Rectangle, buffer *ui.Buffer)

Types

type Component

type Component struct {
	ui.Drawable
	*data.Consumer
	Type     config.ComponentType
	Title    string
	Location config.Location
	Size     config.Size
	RateMs   int
}

func NewComponent

func NewComponent(dbl ui.Drawable, cmr *data.Consumer, cfg config.ComponentConfig) *Component

func (*Component) Move

func (c *Component) Move(x, y int)

func (*Component) Resize

func (c *Component) Resize(x, y int)

type Menu

type Menu struct {
	*ui.Block
	// contains filtered or unexported fields
}

func NewMenu

func NewMenu(palette console.Palette) *Menu

func (*Menu) Choose

func (m *Menu) Choose()

func (*Menu) Down

func (m *Menu) Down()

func (*Menu) Draw

func (m *Menu) Draw(buffer *ui.Buffer)

func (*Menu) GetSelectedOption

func (m *Menu) GetSelectedOption() menuOption

func (*Menu) Highlight

func (m *Menu) Highlight(component *Component)

func (*Menu) Idle

func (m *Menu) Idle()

func (*Menu) MoveOrResize

func (m *Menu) MoveOrResize()

func (*Menu) Up

func (m *Menu) Up()

type StatusBar

type StatusBar struct {
	*ui.Block
	// contains filtered or unexported fields
}

func NewStatusBar

func NewStatusBar(configFileName string, palette console.Palette) *StatusBar

func (*StatusBar) Draw

func (s *StatusBar) Draw(buffer *ui.Buffer)

func (*StatusBar) TogglePause

func (s *StatusBar) TogglePause()