list

Documentation

Index

• type BuilderFunc
• type Dynamic
  • func (d *Dynamic) CaptureEvent(ev vaxis.Event) (vxfw.Command, error)
  • func (d *Dynamic) Cursor() uint
  • func (d *Dynamic) Draw(ctx vxfw.DrawContext) (vxfw.Surface, error)
  • func (d *Dynamic) HandleEvent(ev vaxis.Event, ph vxfw.EventPhase) (vxfw.Command, error)
  • func (d *Dynamic) NextItem() vxfw.Command
  • func (d *Dynamic) Offset() int
  • func (d *Dynamic) PrevItem() vxfw.Command
  • func (d *Dynamic) SetCursor(c uint)
  • func (d *Dynamic) SetPendingScroll(lines int)

Types

type BuilderFunc

type BuilderFunc func(i uint, cursor uint) vxfw.Widget

BuilderFunc is a function which takes

type Dynamic

type Dynamic struct {
	// Builder is the function Dynamic calls to get a widget at a location
	Builder BuilderFunc
	// DrawCursor indicates if the view should draw it's own cursor
	DrawCursor bool
	// DisableEventHandlers prevents the widget from handling key or mouse
	// events. Set this to true to use custom event handlers
	DisableEventHandlers bool

	// Distance between each list item
	Gap int
	// contains filtered or unexported fields
}

Dynamic is a dynamic list. It does not contain a slice of Widgets, but instead obtains them from a BuilderFunc

func (*Dynamic) CaptureEvent

func (d *Dynamic) CaptureEvent(ev vaxis.Event) (vxfw.Command, error)

func (*Dynamic) Cursor

func (d *Dynamic) Cursor() uint

Cursor returns the index of the cursor

func (*Dynamic) Draw

func (d *Dynamic) Draw(ctx vxfw.DrawContext) (vxfw.Surface, error)

func (*Dynamic) HandleEvent

func (d *Dynamic) HandleEvent(ev vaxis.Event, ph vxfw.EventPhase) (vxfw.Command, error)

func (*Dynamic) NextItem

func (d *Dynamic) NextItem() vxfw.Command

func (*Dynamic) Offset

func (d *Dynamic) Offset() int

Offset returns the rendered offset of the list

func (*Dynamic) PrevItem

func (d *Dynamic) PrevItem() vxfw.Command

func (*Dynamic) SetCursor

func (d *Dynamic) SetCursor(c uint)

func (*Dynamic) SetPendingScroll

func (d *Dynamic) SetPendingScroll(lines int)

SetPendingScroll sets a pending scroll amount, by lines. Positive numbers indicate a scroll down