Documentation ¶
Index ¶
- Variables
- func BeneathView(aboveViewNameFunc func(*Gui, *View) string, heightFunc func(*Gui, *View) int, ...) func(gui *Gui, view *View) (int, int, int, int)
- func NewViewEditor(gui *Gui, view *View) gocui.Editor
- func ViewClickHandler(gui *Gui, view *View) error
- func ViewEditorFunc(gui *Gui, view *View) func(v *gocui.View, key gocui.Key, ch rune, mod gocui.Modifier)
- type Action
- type ActionHandler
- type ActionInterface
- type DimensionFunc
- type Gui
- func (gui *Gui) AddView(view *View) error
- func (gui *Gui) BindAction(viewName string, action ActionInterface)
- func (gui *Gui) Clear() error
- func (gui *Gui) ClearViews(viewNames ...string)
- func (gui *Gui) Close()
- func (gui *Gui) Configure()
- func (gui *Gui) CurrentView() *View
- func (gui *Gui) DeleteView(name string) error
- func (gui *Gui) FocusView(name string, canReturn bool) error
- func (gui *Gui) ForceFlush() error
- func (gui *Gui) GetState(key string) (interface{}, error)
- func (gui *Gui) GetTopView() *View
- func (gui *Gui) GetView(name string) (*View, error)
- func (gui *Gui) GetViews() []*View
- func (gui *Gui) HasPreviousView() bool
- func (gui *Gui) MaxHeight() int
- func (gui *Gui) MaxWidth() int
- func (gui *Gui) PeekPreviousView() string
- func (gui *Gui) ReInitTermBox() error
- func (gui *Gui) ReRenderAll()
- func (gui *Gui) ReRenderViews(viewNames ...string)
- func (gui *Gui) RenderString(viewName, s string) error
- func (gui *Gui) RenderView(view *View) error
- func (gui *Gui) ReturnPreviousView() error
- func (gui *Gui) Run()
- func (gui *Gui) SetAlwaysOnTopViews()
- func (gui *Gui) SetCurrentView(name string) (*View, error)
- func (gui *Gui) SetKeybinding(viewName string, key interface{}, mod gocui.Modifier, ...)
- func (gui *Gui) SetRune(x, y int, ch rune, fgColor, bgColor gocui.Attribute) error
- func (gui *Gui) SetState(key string, value interface{}, reRenderAll bool, reRenderViews ...string) error
- func (gui *Gui) SetView(view *View, x0, y0, x1, y1 int) (*View, error)
- func (gui *Gui) SetViewOnTop(name string) (*View, error)
- func (gui *Gui) Size() (int, int)
- func (gui *Gui) SortViewsByZIndex()
- func (gui *Gui) Update(f func(*gocui.Gui) error)
- func (gui *Gui) ViewColors(view *View) (gocui.Attribute, gocui.Attribute)
- func (gui *Gui) ViewDimensionValidated(x0, y0, x1, y1 int) bool
- func (gui *Gui) ViewExisted(name string) error
- type Plot
- type Queue
- type State
- type StateMap
- type TowHeadQueue
- type View
- func (view *View) BindGui(gui *Gui)
- func (view *View) Clear()
- func (view *View) Cursor() (int, int)
- func (view *View) GetDimensions() (int, int, int, int)
- func (view *View) GetState(key string) (interface{}, error)
- func (view *View) InitDimension()
- func (view *View) InitView()
- func (view *View) IsBindingGui() bool
- func (view *View) Line(y int) (string, error)
- func (view *View) LowerRightPointX() int
- func (view *View) LowerRightPointY() int
- func (view *View) MoveCursor(dx, dy int, writeMode bool)
- func (view *View) Origin() (int, int)
- func (view *View) ReRender()
- func (view *View) ReRenderTimes(times int)
- func (view *View) Rendered() bool
- func (view *View) ResetCursorOrigin() error
- func (view *View) SetCursor(x, y int) error
- func (view *View) SetOrigin(x, y int) error
- func (view *View) SetState(key string, value interface{}, reRender bool) error
- func (view *View) SetViewContent(s string) error
- func (view *View) Size() (int, int)
- func (view *View) UpperLeftPointX() int
- func (view *View) UpperLeftPointY() int
- func (view *View) ViewBuffer() string
- func (view *View) ViewBufferLines() []string
- func (view *View) WhichLine(s string) int
- func (view *View) Write(p []byte) (n int, err error)
- type ViewHandler
- type ViewPointFunc
- type ViewsZIndexSorter
Constants ¶
This section is empty.
Variables ¶
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, } )
var ( // ErrNotEnoughSpace ErrNotEnoughSpace ErrNotEnoughSpace = errors.New("not enough space") )
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
NewViewEditor NewViewEditor
func ViewClickHandler ¶
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 (Action) ReRenderAll ¶ added in v0.3.0
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 ¶
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 (*Gui) BindAction ¶
func (gui *Gui) BindAction(viewName string, action ActionInterface)
BindAction BindAction
func (*Gui) ClearViews ¶ added in v0.3.0
ClearViews ClearViews
func (*Gui) GetTopView ¶ added in v0.8.2
func (*Gui) HasPreviousView ¶
HasPreviousView HasPreviousView
func (*Gui) PeekPreviousView ¶
func (*Gui) ReInitTermBox ¶ added in v0.7.0
func (*Gui) ReRenderViews ¶ added in v0.2.0
ReRenderViews ReRenderViews
func (*Gui) RenderString ¶
RenderString RenderString
func (*Gui) ReturnPreviousView ¶
ReturnPreviousView ReturnPreviousView
func (*Gui) SetAlwaysOnTopViews ¶ added in v0.4.0
func (gui *Gui) SetAlwaysOnTopViews()
SetAlwaysOnTopViews SetAlwaysOnTopViews
func (*Gui) SetCurrentView ¶
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) SetViewOnTop ¶
SetViewOnTop SetViewOnTop
func (*Gui) SortViewsByZIndex ¶ added in v0.4.0
func (gui *Gui) SortViewsByZIndex()
SortViewsByZIndex SortViewsByZIndex
func (*Gui) ViewColors ¶
ViewColors ViewColors
func (*Gui) ViewDimensionValidated ¶
ViewDimensionValidated ViewDimensionValidated
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
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
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) GetDimensions ¶
GetDimensions GetDimensions
func (*View) LowerRightPointX ¶
LowerRightPointX LowerRightPointX
func (*View) LowerRightPointY ¶
LowerRightPointY LowerRightPointY
func (*View) MoveCursor ¶
MoveCursor MoveCursor
func (*View) ReRenderTimes ¶ added in v0.8.0
ReRenderTimes ReRenderTimes
func (*View) ResetCursorOrigin ¶ added in v0.2.0
ResetCursorOrigin ResetCursorOrigin
func (*View) SetViewContent ¶
SetViewContent SetViewContent
func (*View) UpperLeftPointX ¶
UpperLeftPointX UpperLeftPointX
func (*View) UpperLeftPointY ¶
UpperLeftPointY UpperLeftPointY
func (*View) ViewBuffer ¶ added in v0.7.0
ViewBuffer ViewBuffer
func (*View) ViewBufferLines ¶
ViewBufferLines ViewBufferLines
type ViewHandler ¶ added in v0.4.1
type ViewsZIndexSorter ¶ added in v0.4.0
type ViewsZIndexSorter []*View
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