ui

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 26, 2025 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type IWindow

type IWindow interface {
	Setup(ui *UI, w *Window)
	Update(ui UI, w Window)
	OnSelect(ui UI, w Window) error
	OnDeselect(ui UI, w Window) error
	Size() (x, y, w, h int)
	Name() string
	SetKeybindings(ui *UI, w *Window) error
	ReloadContent(ui *UI, w *Window)
}

Size and name should be a Window attribute not a IWindow

type UI

type UI struct {
	// contains filtered or unexported fields
}

func NewUI

func NewUI() (*UI, error)

func (*UI) AddWindow

func (ui *UI) AddWindow(window *Window)

func (*UI) Close

func (ui *UI) Close()

func (*UI) DeleteWindow

func (ui *UI) DeleteWindow(window *Window) error

func (*UI) DeleteWindowByName

func (ui *UI) DeleteWindowByName(wName string) error

func (*UI) GetWindow

func (ui *UI) GetWindow(wName string) (*Window, error)

func (*UI) Mouse

func (ui *UI) Mouse(b bool)

func (*UI) NewKeyBinding

func (ui *UI) NewKeyBinding(name string, key interface{}, callback func(g *gocui.Gui, v *gocui.View) error) error

func (*UI) SelectWindow

func (ui *UI) SelectWindow(window *Window) (*Window, error)

This method doest need window return Isnt better to pass window name string and get the actual Window inside here?

func (*UI) SelectWindowByName

func (ui *UI) SelectWindowByName(wName string) (*Window, error)

func (*UI) SetCursor

func (ui *UI) SetCursor(b bool)

func (*UI) SetFgColor

func (ui *UI) SetFgColor(color gocui.Attribute)

func (*UI) SetGlobalKeybindings

func (ui *UI) SetGlobalKeybindings() error

func (*UI) SetHightlight

func (ui *UI) SetHightlight(e bool)

func (*UI) SetSelectedFgColor

func (ui *UI) SetSelectedFgColor(color gocui.Attribute)

func (*UI) Size

func (ui *UI) Size() (int, int)

func (*UI) Start

func (ui *UI) Start() error

func (*UI) StartUI

func (ui *UI) StartUI()

func (*UI) Update

func (ui *UI) Update(f func())

type Window

type Window struct {
	Window IWindow
	// contains filtered or unexported fields
}

func NewWindow

func NewWindow(iw IWindow, ia bool) *Window

TODO: Builder pattern

func (*Window) AutoScroll

func (w *Window) AutoScroll()

func (*Window) ClearWindow

func (v *Window) ClearWindow()

func (*Window) GetWindowContent

func (v *Window) GetWindowContent() string

func (*Window) IsActive

func (w *Window) IsActive() bool

func (*Window) IsTained

func (v *Window) IsTained() bool

func (*Window) MoveCursorHalfWindowDown

func (v *Window) MoveCursorHalfWindowDown()

func (*Window) MoveCursorHalfWindowUp

func (v *Window) MoveCursorHalfWindowUp()

func (*Window) OpenWindow

func (w *Window) OpenWindow()

func (*Window) SetCursor

func (v *Window) SetCursor(x, y int) error

func (*Window) SetEditable

func (v *Window) SetEditable(b bool)

func (*Window) SetHightlight

func (v *Window) SetHightlight(b bool)

func (*Window) SetSelectedBgColor

func (v *Window) SetSelectedBgColor(col gocui.Attribute)

func (*Window) SetTitle

func (v *Window) SetTitle(title string)

func (*Window) Wrap

func (v *Window) Wrap(b bool)

func (*Window) Write

func (v *Window) Write(text string)

func (*Window) WriteHighlight

func (v *Window) WriteHighlight(text string)

func (*Window) WriteLines

func (v *Window) WriteLines(text []string)

func (*Window) WriteLn

func (v *Window) WriteLn(text string)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL