vscroll

Documentation

Overview

Package vscroll provides a vertical scrollbar widget with mouse support. See the editor demo for more.

Index

• Variables
• func Render(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.ICanvas
• func RenderSize(w interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderBox
• func UserInput(w IVerticalScrollbar, ev interface{}, size gowid.IRenderSize, ...) bool
• type ClickAbove
• type ClickBelow
• type ClickDown
• type ClickUp
• type IRightMouseClick
• type IVerticalScrollbar
• type IWidget
• type RightClick
• type VerticalScrollbarRunes
• type Widget
  • func New() *Widget
  • func NewExt(runes VerticalScrollbarRunes) *Widget
  • func NewUnicode() *Widget
  • func NewWithChars(runes VerticalScrollbarRunes) *Widget
  • func (w *Widget) ClickAbove(app gowid.IApp)
  • func (w *Widget) ClickBelow(app gowid.IApp)
  • func (w *Widget) ClickDown(app gowid.IApp)
  • func (w *Widget) ClickUp(app gowid.IApp)
  • func (w *Widget) GetBottom() int
  • func (w *Widget) GetMiddle() int
  • func (w *Widget) GetRunes() VerticalScrollbarRunes
  • func (w *Widget) GetTop() int
  • func (w *Widget) OnClickAbove(f gowid.IWidgetChangedCallback)
  • func (w *Widget) OnClickBelow(f gowid.IWidgetChangedCallback)
  • func (w *Widget) OnClickDownArrow(f gowid.IWidgetChangedCallback)
  • func (w *Widget) OnClickUpArrow(f gowid.IWidgetChangedCallback)
  • func (w *Widget) OnRightClick(f gowid.IWidgetChangedCallback)
  • func (w *Widget) RemoveOnClickAbove(f gowid.IIdentity)
  • func (w *Widget) RemoveOnClickBelow(f gowid.IIdentity)
  • func (w *Widget) RemoveOnClickDownArrow(f gowid.IIdentity)
  • func (w *Widget) RemoveOnClickUpArrow(f gowid.IIdentity)
  • func (w *Widget) RemoveOnRightClick(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) RightClick(frac float32, app gowid.IApp)
  • func (w *Widget) String() string
  • func (w *Widget) UserInput(ev interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) bool

Variables

var (
	VerticalScrollbarAsciiRunes   = VerticalScrollbarRunes{'^', 'v', ' ', '#'}
	VerticalScrollbarUnicodeRunes = VerticalScrollbarRunes{'▲', '▼', ' ', '█'}
)

Functions

func Render

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

func RenderSize

func RenderSize(w interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderBox

func UserInput

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

Types

type ClickAbove

type ClickAbove struct{}

type ClickBelow

type ClickBelow struct{}

type ClickDown

type ClickDown struct{}

type ClickUp

type ClickUp struct{}

type IRightMouseClick

type IRightMouseClick interface {
	RightClick(frac float32, app gowid.IApp)
}

type IVerticalScrollbar

type IVerticalScrollbar interface {
	GetTop() int
	GetMiddle() int
	GetBottom() int
	ClickUp(app gowid.IApp)
	ClickDown(app gowid.IApp)
	ClickAbove(app gowid.IApp)
	ClickBelow(app gowid.IApp)
	GetRunes() VerticalScrollbarRunes
}

type IWidget

type IWidget interface {
	gowid.IWidget
	IVerticalScrollbar
}

type RightClick

type RightClick struct{}

type VerticalScrollbarRunes

type VerticalScrollbarRunes struct {
	Up, Down, Space, Handle rune
}

type Widget

type Widget struct {
	Top       int
	Middle    int
	Bottom    int
	Runes     VerticalScrollbarRunes
	Callbacks *gowid.Callbacks
	gowid.IsSelectable
}

func New

func New() *Widget

func NewExt

func NewExt(runes VerticalScrollbarRunes) *Widget

func NewUnicode

func NewUnicode() *Widget

func NewWithChars

func NewWithChars(runes VerticalScrollbarRunes) *Widget

func (*Widget) ClickAbove

func (w *Widget) ClickAbove(app gowid.IApp)

func (*Widget) ClickBelow

func (w *Widget) ClickBelow(app gowid.IApp)

func (*Widget) ClickDown

func (w *Widget) ClickDown(app gowid.IApp)

func (*Widget) ClickUp

func (w *Widget) ClickUp(app gowid.IApp)

func (*Widget) GetBottom

func (w *Widget) GetBottom() int

func (*Widget) GetMiddle

func (w *Widget) GetMiddle() int

func (*Widget) GetRunes

func (w *Widget) GetRunes() VerticalScrollbarRunes

func (*Widget) GetTop

func (w *Widget) GetTop() int

func (*Widget) OnClickAbove

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

func (*Widget) OnClickBelow

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

func (*Widget) OnClickDownArrow

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

func (*Widget) OnClickUpArrow

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

func (*Widget) OnRightClick

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

func (*Widget) RemoveOnClickAbove

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

func (*Widget) RemoveOnClickBelow

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

func (*Widget) RemoveOnClickDownArrow

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

func (*Widget) RemoveOnClickUpArrow

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

func (*Widget) RemoveOnRightClick

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

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) RightClick

func (w *Widget) RightClick(frac float32, app gowid.IApp)

func (*Widget) String

func (w *Widget) String() string

func (*Widget) UserInput

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