framed

package

v1.0.0 Latest Latest Go to latest Published: Apr 18, 2019 License: MIT Imports: 6 Imported by: 19

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gcla/gowid

Links

Open Source Insights

Documentation ¶

Overview ¶

Package framed provides a widget that draws a frame around an inner widget.

Index ¶

Variables
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 interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderSize
func UserInput(w IWidget, ev interface{}, size gowid.IRenderSize, focus gowid.Selector, ...) bool
type FrameIfSelectedForCopy
- func (r FrameIfSelectedForCopy) AlterWidget(w gowid.IWidget, app gowid.IApp) gowid.IWidget
type FrameRunes
type IFramed
type IWidget
type Options
type Title
type Widget

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	AsciiFrame      = FrameRunes{'-', '-', '-', '-', '-', '-', '|', '|'}
	UnicodeFrame    = FrameRunes{'┏', '┓', '┗', '┛', '━', '━', '┃', '┃'}
	UnicodeAltFrame = FrameRunes{'▛', '▜', '▙', '▟', '▀', '▄', '▌', '▐'}
	SpaceFrame      = FrameRunes{' ', ' ', ' ', ' ', ' ', ' ', ' ', ' '}
)

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 interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderSize

func UserInput ¶

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

Types ¶

type FrameIfSelectedForCopy ¶

type FrameIfSelectedForCopy struct{}

func (FrameIfSelectedForCopy) AlterWidget ¶

func (r FrameIfSelectedForCopy) AlterWidget(w gowid.IWidget, app gowid.IApp) gowid.IWidget

type FrameRunes ¶

type FrameRunes struct {
	Tl, Tr, Bl, Br rune
	T, B, L, R     rune
}

type IFramed ¶

type IFramed interface {
	Opts() Options
}

type IWidget ¶

type IWidget interface {
	gowid.ICompositeWidget
	IFramed
}

type Options ¶

type Options struct {
	Frame       FrameRunes
	Title       string
	TitleWidget gowid.IWidget
	Style       gowid.ICellStyler
}

type Title ¶

type Title struct{}

For callback identification

type Widget ¶

type Widget struct {
	gowid.IWidget // Embed for Selectable method
	Params        Options
	Callbacks     *gowid.Callbacks
	gowid.SubWidgetCallbacks
}

func New ¶

func New(inner gowid.IWidget, opts ...Options) *Widget

func NewSpace ¶

func NewSpace(inner gowid.IWidget) *Widget

func NewUnicode ¶

func NewUnicode(inner gowid.IWidget) *Widget

func NewUnicodeAlt ¶

func NewUnicodeAlt(inner gowid.IWidget) *Widget

func (w *Widget) GetTitle() string

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

func (w *Widget) OnSetTitle(f gowid.IWidgetChangedCallback)

func (w *Widget) Opts() Options

func (w *Widget) RemoveOnSetAlign(f gowid.IIdentity)

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) SetSubWidget(wi gowid.IWidget, app gowid.IApp)

func (w *Widget) SetTitle(title string, app gowid.IApp)

Call from Render thread

func (w *Widget) SetTitleWidget(widget 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

Source Files ¶

View all Source files

framed.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

framed

Documentation ¶

Overview ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func Render ¶

func RenderSize ¶

func SubWidgetSize ¶

func UserInput ¶

Types ¶

type FrameIfSelectedForCopy ¶

func (FrameIfSelectedForCopy) AlterWidget ¶

type FrameRunes ¶

type IFramed ¶

type IWidget ¶

type Options ¶

type Title ¶

type Widget ¶

func New ¶

func NewSpace ¶

func NewUnicode ¶

func NewUnicodeAlt ¶

func (*Widget) GetTitle ¶

func (*Widget) GetTitleWidget ¶

func (*Widget) OnSetTitle ¶

func (*Widget) Opts ¶

func (*Widget) RemoveOnSetAlign ¶

func (*Widget) Render ¶

func (*Widget) RenderSize ¶

func (*Widget) SetSubWidget ¶

func (*Widget) SetTitle ¶

func (*Widget) SetTitleWidget ¶

func (*Widget) String ¶

func (*Widget) SubWidget ¶

func (*Widget) SubWidgetSize ¶

func (*Widget) UserInput ¶

Source Files ¶