pile

Documentation

Overview

Package pile provides a widget for organizing other widgets in a vertical stack.

Index

• func Render(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.ICanvas
• func RenderBoxMaker(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp, ...) ([]gowid.IRenderBox, []gowid.IRenderSize)
• func RenderSize(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderBox
• func RenderSubwidgets(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) []gowid.ICanvas
• func RenderedChildrenSizes(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) ([]gowid.IRenderBox, []gowid.IRenderSize)
• type BoxMaker
• type IWidget
• type Widget
  • func New(defaultID string, widgets []gowid.IContainerWidget) *Widget
  • func (w *Widget) Dimensions() []gowid.IWidgetDimension
  • func (w *Widget) Focus(id string) int
  • func (w *Widget) Render(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.ICanvas
  • func (w *Widget) RenderBoxMaker(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp, fn BoxMaker) ([]gowid.IRenderBox, []gowid.IRenderSize)
  • func (w *Widget) RenderSize(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderBox
  • func (w *Widget) RenderSubWidgets(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) []gowid.ICanvas
  • func (w *Widget) RenderedSubWidgetsSizes(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) []gowid.IRenderBox
  • func (w *Widget) ReverseFocus() [][]string
  • func (w *Widget) Selectable() bool
  • func (w *Widget) SetDimensions(dimensions []gowid.IWidgetDimension, app gowid.IApp)
  • func (w *Widget) SetFocus(id string, i int)
  • func (w *Widget) SetSubWidgets(widgets []gowid.IWidget, app gowid.IApp)
  • func (w *Widget) String() string
  • func (w *Widget) SubWidgetSize(size gowid.IRenderSize, newY int, sub gowid.IWidget, ...) gowid.IRenderSize
  • func (w *Widget) SubWidgets() []gowid.IWidget
  • func (w *Widget) UserInput(ev interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) bool

Functions

func Render

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

func RenderBoxMaker

func RenderBoxMaker(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp, fn BoxMaker) ([]gowid.IRenderBox, []gowid.IRenderSize)

func RenderSize

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

func RenderSubwidgets

func RenderSubwidgets(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) []gowid.ICanvas

func RenderedChildrenSizes

func RenderedChildrenSizes(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) ([]gowid.IRenderBox, []gowid.IRenderSize)

Types

type BoxMaker

type BoxMaker func(gowid.IWidget, gowid.IRenderSize, gowid.Selector, int, gowid.IApp) gowid.IRenderBox

type IWidget

type IWidget interface {
	gowid.IWidget
	gowid.ICompositeMultipleDimensions
	gowid.ISettableDimensions
	gowid.ISettableSubWidgets
	gowid.IIdentity
	wid.IFocus
	SubWidgetSize(size gowid.IRenderSize, val int, sub gowid.IWidget, dim gowid.IWidgetDimension) gowid.IRenderSize
	RenderSubWidgets(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) []gowid.ICanvas
	RenderedSubWidgetsSizes(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) []gowid.IRenderBox
	RenderBoxMaker(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp, fn BoxMaker) ([]gowid.IRenderBox, []gowid.IRenderSize)
}

type Widget

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

func New

func New(defaultID string, widgets []gowid.IContainerWidget) *Widget

func (*Widget) Dimensions

func (w *Widget) Dimensions() []gowid.IWidgetDimension

func (*Widget) Focus

func (w *Widget) Focus(id string) int

func (*Widget) Render

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

func (*Widget) RenderBoxMaker

func (w *Widget) RenderBoxMaker(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp, fn BoxMaker) ([]gowid.IRenderBox, []gowid.IRenderSize)

func (*Widget) RenderSize

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

func (*Widget) RenderSubWidgets

func (w *Widget) RenderSubWidgets(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) []gowid.ICanvas

func (*Widget) RenderedSubWidgetsSizes

func (w *Widget) RenderedSubWidgetsSizes(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) []gowid.IRenderBox

func (*Widget) ReverseFocus

func (w *Widget) ReverseFocus() [][]string

func (*Widget) Selectable

func (w *Widget) Selectable() bool

func (*Widget) SetDimensions

func (w *Widget) SetDimensions(dimensions []gowid.IWidgetDimension, app gowid.IApp)

func (*Widget) SetFocus

func (w *Widget) SetFocus(id string, i int)

func (*Widget) SetSubWidgets

func (w *Widget) SetSubWidgets(widgets []gowid.IWidget, app gowid.IApp)

func (*Widget) String

func (w *Widget) String() string

func (*Widget) SubWidgetSize

func (w *Widget) SubWidgetSize(size gowid.IRenderSize, newY int, sub gowid.IWidget, dim gowid.IWidgetDimension) gowid.IRenderSize

SubWidgetSize is the size that should be used to render a child widget, based on the size used to render the parent.

func (*Widget) SubWidgets

func (w *Widget) SubWidgets() []gowid.IWidget

func (*Widget) UserInput

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