forked from joejulian/gio
Elias Naur
cb1e605203
In the early days of Gio, FrameEvent was part of package app. It was moved to package system to enable layout.NewContext be a convenient short-hand for constructing a layout. However, it seems the better design to leave FrameEvent (and Insets) in package app, and move layout.NewContext there as well. More importantly, the move allows us to replace the event.Queue interface with a concrete type. Signed-off-by: Elias Naur <mail@eliasnaur.com>
65 lines
1.5 KiB
Go
65 lines
1.5 KiB
Go
// SPDX-License-Identifier: Unlicense OR MIT
|
|
|
|
package layout
|
|
|
|
import (
|
|
"time"
|
|
|
|
"gioui.org/io/event"
|
|
"gioui.org/io/system"
|
|
"gioui.org/op"
|
|
"gioui.org/unit"
|
|
)
|
|
|
|
// Context carries the state needed by almost all layouts and widgets.
|
|
// A zero value Context never returns events, map units to pixels
|
|
// with a scale of 1.0, and returns the zero time from Now.
|
|
type Context struct {
|
|
// Constraints track the constraints for the active widget or
|
|
// layout.
|
|
Constraints Constraints
|
|
|
|
Metric unit.Metric
|
|
// By convention, a nil Queue is a signal to widgets to draw themselves
|
|
// in a disabled state.
|
|
Queue event.Queue
|
|
// Now is the animation time.
|
|
Now time.Time
|
|
|
|
// Locale provides information on the system's language preferences.
|
|
// BUG(whereswaldon): this field is not currently populated automatically.
|
|
// Interested users must look up and populate these values manually.
|
|
Locale system.Locale
|
|
|
|
*op.Ops
|
|
}
|
|
|
|
// Dp converts v to pixels.
|
|
func (c Context) Dp(v unit.Dp) int {
|
|
return c.Metric.Dp(v)
|
|
}
|
|
|
|
// Sp converts v to pixels.
|
|
func (c Context) Sp(v unit.Sp) int {
|
|
return c.Metric.Sp(v)
|
|
}
|
|
|
|
// Events returns the events available for the key. If no
|
|
// queue is configured, Events returns nil.
|
|
func (c Context) Events(k event.Tag) []event.Event {
|
|
if c.Queue == nil {
|
|
return nil
|
|
}
|
|
return c.Queue.Events(k)
|
|
}
|
|
|
|
// Disabled returns a copy of this context with a nil Queue,
|
|
// blocking events to widgets using it.
|
|
//
|
|
// By convention, a nil Queue is a signal to widgets to draw themselves
|
|
// in a disabled state.
|
|
func (c Context) Disabled() Context {
|
|
c.Queue = nil
|
|
return c
|
|
}
|