withscrollbar

Documentation

Overview

Package withscrollbar provides a widget that renders with a scrollbar on the right

Index

• func CalculateMenuRows(vals IScrollValues, rows int, focus gowid.Selector, app gowid.IApp) (int, int, int)
• type IScrollHome
• type IScrollOneLine
• type IScrollOnePage
• type IScrollSubWidget
• type IScrollToEnd
• type IScrollValues
• type Options
• type Widget
  • func New(w IScrollSubWidget, opts ...Options) *Widget
  • 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) UserInput(ev interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) bool

Functions

func CalculateMenuRows

func CalculateMenuRows(vals IScrollValues, rows int, focus gowid.Selector, app gowid.IApp) (int, int, int)

Don't attempt to calculate actual rendered rows - it's terribly slow, and O(n) rows.

Types

type IScrollHome

type IScrollHome interface {
	GoHome(size gowid.IRenderSize, app gowid.IApp)
}

type IScrollOneLine

type IScrollOneLine interface {
	Up(lines int, size gowid.IRenderSize, app gowid.IApp)
	Down(lines int, size gowid.IRenderSize, app gowid.IApp)
}

Implemented by widgets that can scroll

type IScrollOnePage

type IScrollOnePage interface {
	UpPage(num int, size gowid.IRenderSize, app gowid.IApp)
	DownPage(num int, size gowid.IRenderSize, app gowid.IApp)
}

type IScrollSubWidget

type IScrollSubWidget interface {
	gowid.IWidget
	IScrollValues
	IScrollOneLine
	IScrollOnePage
}

type IScrollToEnd

type IScrollToEnd interface {
	GoToEnd(size gowid.IRenderSize, app gowid.IApp)
}

type IScrollValues

type IScrollValues interface {
	ScrollPosition() int
	ScrollLength() int
}

type Options

type Options struct {
	HideIfContentFits bool
}

type Widget

type Widget struct {
	// contains filtered or unexported fields
}

func New

func New(w IScrollSubWidget, opts ...Options) *Widget

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

func (w *Widget) Selectable() bool

func (*Widget) UserInput

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