aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ui/interfaces.go
blob: 320183feea8139e58dd9d327f2d763a4eee6c27e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
package ui

import (
	"github.com/gdamore/tcell"
)

type Drawable interface {
	// Called when this renderable should draw itself
	Draw(ctx *Context)
	// Specifies a function to call when this cell needs to be redrawn
	OnInvalidate(callback func(d Drawable))
	// Invalidates the drawable
	Invalidate()
}

type Interactive interface {
	// Returns true if the event was handled by this component
	Event(event tcell.Event) bool
}

type Simulator interface {
	// Queues up the given input events for simulation
	Simulate(events []tcell.Event)
}

type DrawableInteractive interface {
	Drawable
	Interactive
}

// A drawable which contains other drawables
type Container interface {
	Drawable
	// A list of all drawables which are children of this one (do not recurse
	// into your grandchildren).
	Children() []Drawable
	// Return the "focused" child, or none of no preference. Does not actually
	// have to be Interactive. If there is a preferred child, input events will
	// be directed to it. If there's no preference, events will be delivered to
	// all children.
	InteractiveChild() Drawable
}