ui: documentation tweaks

Signed-off-by: Elias Naur <mail@eliasnaur.com>
This commit is contained in:
Elias Naur
2019-08-11 19:35:29 +02:00
parent 2f9ac5aebb
commit 842d29373f
4 changed files with 9 additions and 7 deletions
+2 -2
View File
@@ -13,7 +13,7 @@ import (
"gioui.org/ui"
)
// UpdateEvent is sent when a Window's Update
// An UpdateEvent is generated when a Window's Update
// method must be called.
type UpdateEvent struct {
Config Config
@@ -42,7 +42,7 @@ type Insets struct {
Top, Bottom, Left, Right ui.Value
}
// StageEvent is sent whenever the stage of a
// A StageEvent is generated whenever the stage of a
// Window changes.
type StageEvent struct {
Stage Stage
+2
View File
@@ -33,6 +33,8 @@ package input
// Queue maps an event handler key to the events
// available to the handler.
type Queue interface {
// Next returns the next available event, or
// false if none are available.
Next(k Key) (Event, bool)
}
+3 -3
View File
@@ -29,13 +29,13 @@ type HandlerOp struct {
// be hidden.
type HideInputOp struct{}
// FocusEvent is sent when a handler gains or loses
// A FocusEvent is generated when a handler gains or loses
// focus.
type FocusEvent struct {
Focus bool
}
// Event is sent when a key is pressed. For text input
// An Event is generated when a key is pressed. For text input
// use EditEvent.
type Event struct {
// Name is the rune character that most closely
@@ -47,7 +47,7 @@ type Event struct {
Modifiers Modifiers
}
// EditEvent is sent when text is input.
// An EditEvent is generated when text is input.
type EditEvent struct {
Text string
}
+2 -2
View File
@@ -90,8 +90,8 @@ type Source uint8
type areaKind uint8
const (
// Cancel is sent when the current gesture is interrupted
// by other handlers or the system.
// A Cancel event is generated when the current gesture is
// interrupted by other handlers or the system.
Cancel Type = iota
// Press of a pointer.
Press