overlay

type Bottom ¶

type Bottom struct{}

type IIgnoreLowerStyle ¶ added in v1.4.0

type IIgnoreLowerStyle interface {
	IgnoreLowerStyle() bool
}

type IOverlay ¶

type IOverlay interface {
	Top() gowid.IWidget
	Bottom() gowid.IWidget
	VAlign() gowid.IVAlignment
	Height() gowid.IWidgetDimension
	HAlign() gowid.IHAlignment
	Width() gowid.IWidgetDimension
	BottomGetsFocus() bool
	TopGetsFocus() bool
	BottomGetsCursor() bool
}

type IWidget ¶

type IWidget interface {
	gowid.IWidget
	IOverlay
}

type IWidgetSettable ¶

type IWidgetSettable interface {
	IWidget
	SetTop(gowid.IWidget, gowid.IApp)
	SetBottom(gowid.IWidget, gowid.IApp)
	SetVAlign(gowid.IVAlignment, gowid.IApp)
	SetHeight(gowid.IWidgetDimension, gowid.IApp)
	SetHAlign(gowid.IHAlignment, gowid.IApp)
	SetWidth(gowid.IWidgetDimension, gowid.IApp)
}

type MouseCheckerWidget ¶

type MouseCheckerWidget struct {
	gowid.IWidget
	ClickWasInBounds func()
}

Utility widget, used only to determine if a user input mouse event is within the bounds of a widget. This is different from whether or not a widget handles an event. In the case of overlay, an overlaid widget may not handle a mouse event, but if it occludes the widget underneath, that lower widget should not accept the mouse event (since it ought to be hidden). So the callback is expected to set a flag in the composite overlay widget to say the click was within bounds of the upper layer.

func NewMouseChecker(inner gowid.IWidget, clickWasInBounds func()) *MouseCheckerWidget

func (w *MouseCheckerWidget) SetSubWidget(inner gowid.IWidget, app gowid.IApp)

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

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

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

type Options ¶

type Options struct {
	BottomGetsFocus  bool
	TopGetsNoFocus   bool
	BottomGetsCursor bool
	IgnoreLowerStyle bool
}

type Top ¶

type Top struct{}

For callback registration

type Widget ¶

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

Widget overlays one widget on top of another. The bottom widget is rendered without the focus at full size. The bottom widget is rendered between a horizontal and vertical padding widget set up with the sizes provided.

func New(top, bottom gowid.IWidget,
	valign gowid.IVAlignment, height gowid.IWidgetDimension,
	halign gowid.IHAlignment, width gowid.IWidgetDimension,
	opts ...Options) *Widget

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

func (w *Widget) BottomGetsCursor() bool

func (w *Widget) BottomGetsFocus() bool

func (w *Widget) HAlign() gowid.IHAlignment

func (w *Widget) Height() gowid.IWidgetDimension

func (w *Widget) IgnoreLowerStyle() bool

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) Selectable() bool

func (w *Widget) SetBottom(w2 gowid.IWidget, app gowid.IApp)

func (w *Widget) SetHAlign(halign gowid.IHAlignment, app gowid.IApp)

func (w *Widget) SetHeight(height gowid.IWidgetDimension, app gowid.IApp)

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

func (w *Widget) SetTop(w2 gowid.IWidget, app gowid.IApp)

func (w *Widget) SetVAlign(valign gowid.IVAlignment, app gowid.IApp)

func (w *Widget) SetWidth(width gowid.IWidgetDimension, app gowid.IApp)

func (w *Widget) String() string

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

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

func (w *Widget) TopGetsFocus() bool

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

func (w *Widget) VAlign() gowid.IVAlignment

func (w *Widget) Width() gowid.IWidgetDimension