gio/io/event/event.go -rw-r--r-- 1.0 KiB View raw
                                                                                
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
43
44
45
46
47
48
// SPDX-License-Identifier: Unlicense OR MIT

/*
Package event contains the types for event handling.

The Queue interface is the protocol for receiving external events.

For example:

	var queue event.Queue = ...

	for _, e := range queue.Events(h) {
		switch e.(type) {
			...
		}
	}

In general, handlers must be declared before events become
available. Other packages such as pointer and key provide
the means for declaring handlers for specific event types.

The following example declares a handler ready for key input:

	import gioui.org/io/key

	ops := new(op.Ops)
	var h *Handler = ...
	key.InputOp{Key: h}.Add(ops)

*/
package event

// Queue maps an event handler key to the events
// available to the handler.
type Queue interface {
	// Events returns the available events for a
	// Key.
	Events(k Key) []Event
}

// Key is the stable identifier for an event handler.
// For a handler h, the key is typically &h.
type Key interface{}

// Event is the marker interface for events.
type Event interface {
	ImplementsEvent()
}