appkeys

Documentation

Overview

Package appkeys provides a widget which responds to keyboard input.

Index

• func Render(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.ICanvas
• func RenderSize(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderBox
• func SubWidgetSize(w gowid.ICompositeWidget, size gowid.IRenderSize, focus gowid.Selector, ...) gowid.IRenderSize
• func UserInput(w IAppInput, ev interface{}, size gowid.IRenderSize, focus gowid.Selector, ...) bool
• type IAppInput
• type IAppKeys
• type IAppMouse
• type IWidget
• type KeyInputFn
• type KeyWidget
  • func New(inner gowid.IWidget, fn KeyInputFn, opts ...Options) *KeyWidget
  • func (w *KeyWidget) KeyInput(k *tcell.EventKey, app gowid.IApp) bool
  • func (w *KeyWidget) UserInput(ev interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) bool
• type MouseInputFn
• type MouseWidget
  • func NewMouse(inner gowid.IWidget, fn MouseInputFn, opts ...Options) *MouseWidget
  • func (w *MouseWidget) MouseInput(k *tcell.EventMouse, app gowid.IApp) bool
  • func (w *MouseWidget) UserInput(ev interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) bool
• type Options
• type Widget
  • func (w *Widget) ApplyBefore() bool
  • func (w *Widget) SetSubWidget(wi gowid.IWidget, app gowid.IApp)
  • func (w *Widget) String() string
  • func (w *Widget) SubWidget() gowid.IWidget
  • func (w *Widget) SubWidgetSize(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderSize

Functions

func Render

func Render(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.ICanvas

func RenderSize

func RenderSize(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderBox

func SubWidgetSize

func SubWidgetSize(w gowid.ICompositeWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderSize

func UserInput

func UserInput(w IAppInput, ev interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) bool

Types

type IAppInput

type IAppInput interface {
	gowid.IComposite
	ApplyBefore() bool
}

type IAppKeys

type IAppKeys interface {
	KeyInput(ev *tcell.EventKey, app gowid.IApp) bool
}

type IAppMouse

type IAppMouse interface {
	MouseInput(ev *tcell.EventMouse, app gowid.IApp) bool
}

type IWidget

type IWidget interface {
	gowid.ICompositeWidget
}

type KeyInputFn

type KeyInputFn func(ev *tcell.EventKey, app gowid.IApp) bool

type KeyWidget

type KeyWidget struct {
	*Widget
	// contains filtered or unexported fields
}

func New

func New(inner gowid.IWidget, fn KeyInputFn, opts ...Options) *KeyWidget

func (*KeyWidget) KeyInput

func (w *KeyWidget) KeyInput(k *tcell.EventKey, app gowid.IApp) bool

func (*KeyWidget) UserInput

func (w *KeyWidget) UserInput(ev interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) bool

type MouseInputFn

type MouseInputFn func(ev *tcell.EventMouse, app gowid.IApp) bool

type MouseWidget

type MouseWidget struct {
	*Widget
	// contains filtered or unexported fields
}

func NewMouse

func NewMouse(inner gowid.IWidget, fn MouseInputFn, opts ...Options) *MouseWidget

func (*MouseWidget) MouseInput

func (w *MouseWidget) MouseInput(k *tcell.EventMouse, app gowid.IApp) bool

func (*MouseWidget) UserInput

func (w *MouseWidget) UserInput(ev interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) bool

type Options

type Options struct {
	ApplyBefore bool
}

type Widget

type Widget struct {
	gowid.IWidget
	// contains filtered or unexported fields
}

func (*Widget) ApplyBefore

func (w *Widget) ApplyBefore() bool

func (*Widget) SetSubWidget

func (w *Widget) SetSubWidget(wi gowid.IWidget, app gowid.IApp)

func (*Widget) String

func (w *Widget) String() string

func (*Widget) SubWidget

func (w *Widget) SubWidget() gowid.IWidget

func (*Widget) SubWidgetSize

func (w *Widget) SubWidgetSize(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderSize