shadow

Documentation

Overview

Package shadow adds a drop shadow effect to a widget.

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 IOffset, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderSize
• func UserInput(w gowid.ICompositeWidget, ev interface{}, size gowid.IRenderSize, ...) bool
• type IOffset
• type IWidget
• type Widget
  • func New(inner gowid.IWidget, offset int) *Widget
  • func (w *Widget) Offset() int
  • func (w *Widget) Render(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.ICanvas
  • func (w *Widget) RenderSize(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderBox
  • func (w *Widget) SetOffset(x int, app gowid.IApp)
  • 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
  • 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 RenderSize

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

func SubWidgetSize

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

func UserInput

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

Types

type IOffset

type IOffset interface {
	Offset() int
}

type IWidget

type IWidget interface {
	gowid.ICompositeWidget
	IOffset
}

type Widget

type Widget struct {
	gowid.IWidget

	// we just guess at a reasonable look for a reasonable
	// aspect ratio
	*gowid.Callbacks
	gowid.SubWidgetCallbacks
	// contains filtered or unexported fields
}

Widget will render a drop shadow underneath and to the right of the inner widget, providing a simple 3D effect.

Offset is the number of lines to extend the drop shadow down - it is extended right by 2*Offset because terminal cells aren't square.

func New

func New(inner gowid.IWidget, offset int) *Widget

func (*Widget) Offset

func (w *Widget) Offset() int

func (*Widget) Render

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

func (*Widget) RenderSize

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

func (*Widget) SetOffset

func (w *Widget) SetOffset(x int, app gowid.IApp)

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

func (*Widget) UserInput

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