aerc/lib/ui/interfaces.go
Ben Burwell 152f8c9519 Ring bell when new messages arrive
Add a "new-message-bell" option to the UI section of aerc.conf. A new
hook into the message store allows the msglist widget to detect new
messages being added to the displayed list. When new messages are
delivered, and the new-message-bell option is enabled (as it is by
default), the terminal will beep.
2019-07-29 15:01:49 -04:00

58 lines
1.3 KiB
Go

package ui
import (
"github.com/gdamore/tcell"
)
// Drawable is a UI component that can draw. Unless specified, all methods must
// only be called from a single goroutine, the UI goroutine.
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. The
// callback may be called in any goroutine.
OnInvalidate(callback func(d Drawable))
// Invalidates the drawable. This can be called from any goroutine.
Invalidate()
}
type Interactive interface {
// Returns true if the event was handled by this component
Event(event tcell.Event) bool
// Indicates whether or not this control will receive input events
Focus(focus bool)
}
type Beeper interface {
OnBeep(func() error)
}
type Simulator interface {
// Queues up the given input events for simulation
Simulate(events []tcell.Event)
}
type DrawableInteractive interface {
Drawable
Interactive
}
type DrawableInteractiveBeeper interface {
DrawableInteractive
Beeper
}
// A drawable which contains other drawables
type Container interface {
Drawable
// Return all of the drawables which are children of this one (do not
// recurse into your grandchildren).
Children() []Drawable
}
// A drawable that can be clicked
type Clickable interface {
Drawable
MouseEvent(event tcell.Event)
}