api

Documentation

Index

• Constants
• type Command
• type Commands
• type Page
• type UI
  • func Init() *UI
  • func (ui *UI) AddPage(id string, commands map[string]Command)
  • func (ui *UI) Run() error

Constants

const (
	OtterchatKey  = "otterchat"
	CMDSymbolName = "Commands"
)

OtterchatKey key for the main page

Types

type Command

type Command interface {
	Name() string
	Usage() string
	Desc() string
	Exec(*UI, *Page, []string) error
}

Command represents an executable a command

type Commands

type Commands interface {
	Registry() map[string]Command
}

Commands a plugin that contains one or more command

type Page

type Page struct {
	ChannelInfoView *tview.TextView
	ChatView        *tview.TextView
	InputInfoView   *tview.TextView
	UserInput       *tview.InputField
	UserList        *tview.List
}

Page The elements needed for the page

type UI

type UI struct {
	App            *tview.Application
	AppView        *tview.Flex
	ConnectionList *tview.List
	Pages          *tview.Pages
	PageMap        map[string]*Page
}

UI The User Inteface elements

func Init

func Init() *UI

Init the User Interface

func (*UI) AddPage

func (ui *UI) AddPage(id string, commands map[string]Command)

AddPage adds a next context switcher between channels

func (*UI) Run

func (ui *UI) Run() error

Run the User Interface