f6216bb621
This adds the Mouseable interface. When this is implemented for a component that item can accept and process mouseevents. At the top level when a mouse event is received it is passed to the grid's handler and then it trickles down until it reaches a component that can actually handle it, such as the tablist, dirlist or msglist. A mouse event is passed so that components can handle other things such as scrolling with the mousewheel. The components themselves then perform the necessary actions. Clicking emails in the messagelist opens them in a new tab. Textinputs can be clicked to position the cursor inside them. Mouseevents are not forwarded to the terminal at the moment. Elements which do not handle mouse events are not required to implement the Mouseable interface.
68 lines
1.6 KiB
Go
68 lines
1.6 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
|
|
}
|
|
|
|
type MouseHandler interface {
|
|
// Handle a mouse event which occurred at the local x and y positions
|
|
MouseEvent(localX int, localY int, event tcell.Event)
|
|
}
|
|
|
|
// A drawable that can be interacted with by the mouse
|
|
type Mouseable interface {
|
|
Drawable
|
|
MouseHandler
|
|
}
|
|
|
|
type MouseableDrawableInteractive interface {
|
|
DrawableInteractive
|
|
MouseHandler
|
|
}
|