gui

package
v0.10.3 Latest Latest
Warning

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

 Go to latest Published: Sep 30, 2021 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// Quit Quit
	Quit = &Action{
		Name: "Quit",
		Key:  gocui.KeyCtrlC,
		Handler: func(*Gui, *View) error {
			return gocui.ErrQuit
		},
		Mod: gocui.ModNone,
	}

	// ClickView ClickView
	ClickView = &Action{
		Name:    "clickView",
		Key:     gocui.MouseLeft,
		Handler: ViewClickHandler,
		Mod:     gocui.ModNone,
	}
)
View Source 
var (
	// ErrNotEnoughSpace ErrNotEnoughSpace
	ErrNotEnoughSpace = errors.New("not enough space")
)
View Source 
var (
	// StateKeyError StateKeyError
	StateKeyError = errors.New("State key not existed. ")
)

Functions

func BeneathView 

func BeneathView(aboveViewNameFunc func(*Gui, *View) string, heightFunc func(*Gui, *View) int, marginTopFunc func(*Gui, *View) int) func(gui *Gui, view *View) (int, int, int, int)

BeneathView BeneathView

func NewViewEditor added in v0.2.0 

func NewViewEditor(gui *Gui, view *View) gocui.Editor

NewViewEditor NewViewEditor

func ViewClickHandler 

func ViewClickHandler(gui *Gui, view *View) error

func ViewEditorFunc added in v0.2.0 

func ViewEditorFunc(gui *Gui, view *View) func(v *gocui.View, key gocui.Key, ch rune, mod gocui.Modifier)

ViewEditorFunc ViewEditorFunc

Types

type Action 

type Action struct {
	Keys            []interface{}
	Name            string
	Key             interface{}
	Handler         ViewHandler
	ReRenderAllView bool
	Mod             gocui.Modifier
}

Action Action

func (Action) ActionName added in v0.3.0 

func (a Action) ActionName() string

func (Action) BindKey added in v0.3.0 

func (a Action) BindKey() interface{}

func (Action) BindKeys added in v0.3.0 

func (a Action) BindKeys() []interface{}

func (Action) HandlerFunc added in v0.3.0 

func (a Action) HandlerFunc(gui *Gui, view *View) error

func (Action) Modifier added in v0.3.0 

func (a Action) Modifier() gocui.Modifier

func (Action) ReRenderAll added in v0.3.0 

func (a Action) ReRenderAll() bool

type ActionHandler 

type ActionHandler func(gui *Gui) func(*gocui.Gui, *gocui.View) error

type ActionInterface added in v0.3.0 

type ActionInterface interface {
	ActionName() string
	HandlerFunc(*Gui, *View) error
	Modifier() gocui.Modifier
	BindKey() interface{}
	BindKeys() []interface{}
	ReRenderAll() bool
}

ActionInterface ActionInterface

func ToActionInterfaceArr added in v0.3.0 

func ToActionInterfaceArr(actions []*Action) []ActionInterface

type DimensionFunc 

type DimensionFunc func(gui *Gui, view *View) (int, int, int, int)

DimensionFunc DimensionFunc

type Gui 

type Gui struct {
	Actions []*Action

	OnSizeChange    func(gui *Gui) error
	OnRender        func(gui *Gui) error
	OnRenderOptions func(gui *Gui) error

	Config config.GuiConfig
	// contains filtered or unexported fields
}

Gui Gui

func NewGui 

func NewGui(config config.GuiConfig, views ...*View) *Gui

NewGui NewGui

func (*Gui) AddView 

func (gui *Gui) AddView(view *View) error

AddView AddView

func (*Gui) BindAction 

func (gui *Gui) BindAction(viewName string, action ActionInterface)

BindAction BindAction

func (*Gui) Clear 

func (gui *Gui) Clear() error

Clear Clear

func (*Gui) ClearViews added in v0.3.0 

func (gui *Gui) ClearViews(viewNames ...string)

ClearViews ClearViews

func (*Gui) Close 

func (gui *Gui) Close()

Close Close

func (*Gui) Configure 

func (gui *Gui) Configure()

Configure Configure

func (*Gui) CurrentView 

func (gui *Gui) CurrentView() *View

CurrentView CurrentView

func (*Gui) DeleteView 

func (gui *Gui) DeleteView(name string) error

DeleteView DeleteView

func (*Gui) FocusView 

func (gui *Gui) FocusView(name string, canReturn bool) error

func (*Gui) ForceFlush added in v0.3.0 

func (gui *Gui) ForceFlush() error

ForceFlush ForceFlush

func (*Gui) GetState added in v0.5.0 

func (gui *Gui) GetState(key string) (interface{}, error)

func (*Gui) GetTopView added in v0.8.2 

func (gui *Gui) GetTopView() *View

func (*Gui) GetView 

func (gui *Gui) GetView(name string) (*View, error)

GetView GetView

func (*Gui) GetViews 

func (gui *Gui) GetViews() []*View

GetViews GetViews

func (*Gui) HasPreviousView 

func (gui *Gui) HasPreviousView() bool

HasPreviousView HasPreviousView

func (*Gui) MaxHeight 

func (gui *Gui) MaxHeight() int

MaxHeight MaxHeight

func (*Gui) MaxWidth 

func (gui *Gui) MaxWidth() int

MaxWidth MaxWidth

func (*Gui) PeekPreviousView 

func (gui *Gui) PeekPreviousView() string

func (*Gui) ReInitTermBox added in v0.7.0 

func (gui *Gui) ReInitTermBox() error

func (*Gui) ReRenderAll added in v0.3.0 

func (gui *Gui) ReRenderAll()

ReRenderAll ReRenderAll

func (*Gui) ReRenderViews added in v0.2.0 

func (gui *Gui) ReRenderViews(viewNames ...string)

ReRenderViews ReRenderViews

func (*Gui) RenderString 

func (gui *Gui) RenderString(viewName, s string) error

RenderString RenderString

func (*Gui) RenderView 

func (gui *Gui) RenderView(view *View) error

RenderView RenderView

func (*Gui) ReturnPreviousView 

func (gui *Gui) ReturnPreviousView() error

ReturnPreviousView ReturnPreviousView

func (*Gui) Run 

func (gui *Gui) Run()

Run Run

func (*Gui) SetAlwaysOnTopViews added in v0.4.0 

func (gui *Gui) SetAlwaysOnTopViews()

SetAlwaysOnTopViews SetAlwaysOnTopViews

func (*Gui) SetCurrentView 

func (gui *Gui) SetCurrentView(name string) (*View, error)

SetCurrentView SetCurrentView

func (*Gui) SetKeybinding 

func (gui *Gui) SetKeybinding(viewName string, key interface{}, mod gocui.Modifier, handler func(*gocui.Gui, *gocui.View) error)

SetKeybinding SetKeybinding

func (*Gui) SetRune 

func (gui *Gui) SetRune(x, y int, ch rune, fgColor, bgColor gocui.Attribute) error

SetRune SetRune

func (*Gui) SetState added in v0.5.0 

func (gui *Gui) SetState(key string, value interface{}, reRenderAll bool, reRenderViews ...string) error

func (*Gui) SetView 

func (gui *Gui) SetView(view *View, x0, y0, x1, y1 int) (*View, error)

SetView SetView

func (*Gui) SetViewOnTop 

func (gui *Gui) SetViewOnTop(name string) (*View, error)

SetViewOnTop SetViewOnTop

func (*Gui) Size 

func (gui *Gui) Size() (int, int)

Size Size

func (*Gui) SortViewsByZIndex added in v0.4.0 

func (gui *Gui) SortViewsByZIndex()

SortViewsByZIndex SortViewsByZIndex

func (*Gui) Update 

func (gui *Gui) Update(f func(*gocui.Gui) error)

Update Update

func (*Gui) ViewColors 

func (gui *Gui) ViewColors(view *View) (gocui.Attribute, gocui.Attribute)

ViewColors ViewColors

func (*Gui) ViewDimensionValidated 

func (gui *Gui) ViewDimensionValidated(x0, y0, x1, y1 int) bool

ViewDimensionValidated ViewDimensionValidated

func (*Gui) ViewExisted 

func (gui *Gui) ViewExisted(name string) error

ViewExisted ViewExisted

type Plot 

type Plot struct {
	Name string

	DataGetter     func() []float64
	Height         func(plot *Plot) int
	Width          func(plot *Plot) int
	Max            func(plot *Plot) float64
	Min            func(plot *Plot) float64
	Caption        func(plot *Plot) string
	GraphFormatter func(graph string) string
	// contains filtered or unexported fields
}

Plot Plot

func NewPlot 

func NewPlot(
	name string,
	dataGetter func() []float64,
	height func(plot *Plot) int,
	width func(plot *Plot) int,
	max func(plot *Plot) float64,
	min func(plot *Plot) float64,
	caption func(plot *Plot) string,
	graphFormatter func(string) string,
) *Plot

NewPlot NewPlot

func (*Plot) Data 

func (plot *Plot) Data() []float64

Data Data

func (*Plot) Graph 

func (plot *Plot) Graph() string

Graph Graph

func (*Plot) Render 

func (plot *Plot) Render(io io.Writer)

Render Render

func (*Plot) Since 

func (plot *Plot) Since() time.Time

Since Since

type Queue 

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

Queue Queue

func NewQueue 

func NewQueue() *Queue

NewQueue NewQueue

func (*Queue) IsEmpty 

func (q *Queue) IsEmpty() bool

IsEmpty IsEmpty

func (*Queue) Len 

func (q *Queue) Len() int

Len Len

func (*Queue) Peek 

func (q *Queue) Peek() interface{}

Peek Peek

func (*Queue) Pop 

func (q *Queue) Pop() interface{}

Pop Pop

func (*Queue) PopTail 

func (q *Queue) PopTail() interface{}

PopTail PopTail

func (*Queue) Push 

func (q *Queue) Push(el interface{})

Push Push

func (*Queue) Tail 

func (q *Queue) Tail() interface{}

Tail Tail

type State 

type State interface {
	Set(key string, val interface{}) error
	Get(Ket string) (interface{}, error)
}

State State

type StateMap 

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

StateMap StateMap

func NewStateMap 

func NewStateMap() *StateMap

NewStateMap NewStateMap

func (*StateMap) Get 

func (s *StateMap) Get(key string) (interface{}, error)

Get Get

func (*StateMap) Set 

func (s *StateMap) Set(key string, val interface{}) error

Set Set

type TowHeadQueue 

type TowHeadQueue interface {
	Pop() interface{}
	Peek() interface{}
	Tail() interface{}
	Push(interface{})
	PopTail() interface{}
	Len() int
	IsEmpty() bool
}

TowHeadQueue TowHeadQueue

type View 

type View struct {
	Actions              []ActionInterface
	Name                 string
	Title                string
	SelectedLine         string
	OnClick              ViewHandler
	OnLineClick          func(gui *Gui, view *View, cy int, lineString string) error
	OnRender             ViewHandler
	OnRenderOptions      ViewHandler
	OnFocus              ViewHandler
	OnFocusLost          ViewHandler
	OnCursorChange       func(gui *Gui, view *View, x, y int) error
	OnEditedChange       func(gui *Gui, view *View, key gocui.Key, ch rune, mod gocui.Modifier)
	OnSelectedLineChange func(gui *Gui, view *View, selectedLine string) error
	DimensionFunc        DimensionFunc
	UpperLeftPointXFunc  ViewPointFunc
	UpperLeftPointYFunc  ViewPointFunc
	LowerRightPointXFunc ViewPointFunc
	LowerRightPointYFunc ViewPointFunc
	ZIndex               int

	FgColor               gocui.Attribute
	BgColor               gocui.Attribute
	SelBgColor            gocui.Attribute
	SelFgColor            gocui.Attribute
	Clickable             bool
	Editable              bool
	Wrap                  bool
	Autoscroll            bool
	IgnoreCarriageReturns bool
	Highlight             bool
	NoFrame               bool
	MouseDisable          bool
	// When the "CanNotReturn" parameter is true, it will not be placed in previousViews where the view was clicked.
	CanNotReturn bool

	AlwaysOnTop bool
	// contains filtered or unexported fields
}

View View 

var (
	NotEnoughSpace *View
)

func (*View) BindGui 

func (view *View) BindGui(gui *Gui)

BindGui BindGui

func (*View) Clear 

func (view *View) Clear()

Clear Clear

func (*View) Cursor 

func (view *View) Cursor() (int, int)

Cursor Cursor

func (*View) GetDimensions 

func (view *View) GetDimensions() (int, int, int, int)

GetDimensions GetDimensions

func (*View) GetState added in v0.5.0 

func (view *View) GetState(key string) (interface{}, error)

func (*View) InitDimension 

func (view *View) InitDimension()

InitDimension InitDimension

func (*View) InitView 

func (view *View) InitView()

InitView InitView

func (*View) IsBindingGui 

func (view *View) IsBindingGui() bool

IsBindingGui IsBindingGui

func (*View) Line 

func (view *View) Line(y int) (string, error)

Line Line

func (*View) LowerRightPointX 

func (view *View) LowerRightPointX() int

LowerRightPointX LowerRightPointX

func (*View) LowerRightPointY 

func (view *View) LowerRightPointY() int

LowerRightPointY LowerRightPointY

func (*View) MoveCursor 

func (view *View) MoveCursor(dx, dy int, writeMode bool)

MoveCursor MoveCursor

func (*View) Origin added in v0.2.0 

func (view *View) Origin() (int, int)

Origin Origin

func (*View) ReRender 

func (view *View) ReRender()

ReRender ReRender

func (*View) ReRenderTimes added in v0.8.0 

func (view *View) ReRenderTimes(times int)

ReRenderTimes ReRenderTimes

func (*View) Rendered 

func (view *View) Rendered() bool

Rendered Rendered

func (*View) ResetCursorOrigin added in v0.2.0 

func (view *View) ResetCursorOrigin() error

ResetCursorOrigin ResetCursorOrigin

func (*View) SetCursor 

func (view *View) SetCursor(x, y int) error

SetCursor SetCursor

func (*View) SetOrigin 

func (view *View) SetOrigin(x, y int) error

SetOrigin SetOrigin

func (*View) SetState added in v0.5.0 

func (view *View) SetState(key string, value interface{}, reRender bool) error

func (*View) SetViewContent 

func (view *View) SetViewContent(s string) error

SetViewContent SetViewContent

func (*View) Size 

func (view *View) Size() (int, int)

func (*View) UpperLeftPointX 

func (view *View) UpperLeftPointX() int

UpperLeftPointX UpperLeftPointX

func (*View) UpperLeftPointY 

func (view *View) UpperLeftPointY() int

UpperLeftPointY UpperLeftPointY

func (*View) ViewBuffer added in v0.7.0 

func (view *View) ViewBuffer() string

ViewBuffer ViewBuffer

func (*View) ViewBufferLines 

func (view *View) ViewBufferLines() []string

ViewBufferLines ViewBufferLines

func (*View) WhichLine added in v0.2.0 

func (view *View) WhichLine(s string) int

WhichLine WhichLine

func (*View) Write 

func (view *View) Write(p []byte) (n int, err error)

type ViewHandler added in v0.4.1 

type ViewHandler func(gui *Gui, view *View) error

type ViewPointFunc 

type ViewPointFunc func(gui *Gui, view *View) int

ViewPointFunc ViewPointFunc

type ViewsZIndexSorter added in v0.4.0 

type ViewsZIndexSorter []*View

func (ViewsZIndexSorter) Len added in v0.4.0 

func (views ViewsZIndexSorter) Len() int

Len Len

func (ViewsZIndexSorter) Less added in v0.4.0 

func (views ViewsZIndexSorter) Less(i, j int) bool

Less Less

func (ViewsZIndexSorter) Swap added in v0.4.0 

func (views ViewsZIndexSorter) Swap(i, j int)

Swap Swap

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.