evdev/types/events.d.lua at main · BlueLua/evdev · GitHub

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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
---@meta evdev.events

---
---Event value constants and event predicates.
---
---## Usage
---
---```lua
---local e = {
---  type = evdev.ecodes.EV_KEY,
---  value = evdev.events.RELEASE
---}
---
---print(evdev.events.is_release(e)) --> true
---print(evdev.events.is_press(e))   --> false
---print(evdev.events.is_repeat(e))  --> false
---```
---
---@class evdev.events
---@field RELEASE 0 Key or button release value.
---@field PRESS 1 Key or button press value.
---@field REPEAT 2 Key repeat value.
local M = {}

---
---Return whether an event is a key/button release.
---
---```lua
---local e = { type = evdev.ecodes.EV_KEY, value = evdev.events.RELEASE }
---print(evdev.events.is_release(e)) --> true
---```
---
---@param event evdev.event
---@return boolean
---@nodiscard
function M.is_release(event) end

---
---Return whether an event is a key/button press.
---
---```lua
---local e = { type = evdev.ecodes.EV_KEY, value = evdev.events.PRESS }
---print(evdev.events.is_press(e)) --> true
---```
---
---@param event evdev.event
---@return boolean
---@nodiscard
function M.is_press(event) end

---
---Return whether an event is a key repeat.
---
---```lua
---local e = { type = evdev.ecodes.EV_KEY, value = evdev.events.REPEAT }
---print(evdev.events.is_repeat(e)) --> true
---```
---
---@param event evdev.event
---@return boolean
---@nodiscard
function M.is_repeat(event) end

---
---Return whether an event has type `EV_KEY`.
---
---```lua
---local e = { type = evdev.ecodes.EV_KEY }
---print(evdev.events.is_key(e)) --> true
---```
---
---@param event evdev.event
---@return boolean
---@nodiscard
function M.is_key(event) end

---
---Return whether an event has type `EV_REL`.
---
---```lua
---local e = { type = evdev.ecodes.EV_REL }
---print(evdev.events.is_rel(e)) --> true
---```
---
---@param event evdev.event
---@return boolean
---@nodiscard
function M.is_rel(event) end

---
---Return whether an event has type `EV_ABS`.
---
---```lua
---local e = { type = evdev.ecodes.EV_ABS }
---print(evdev.events.is_abs(e)) --> true
---```
---
---@param event evdev.event
---@return boolean
---@nodiscard
function M.is_abs(event) end

---
---Return whether an event has type `EV_SYN`.
---
---```lua
---local e = { type = evdev.ecodes.EV_SYN }
---print(evdev.events.is_syn(e)) --> true
---```
---
---@param event evdev.event
---@return boolean
---@nodiscard
function M.is_syn(event) end

return M