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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
// This file is auto-generated by rute_gen. DO NOT EDIT.
use std::cell::Cell;
use std::rc::Rc;
#[allow(unused_imports)]
use std::marker::PhantomData;
#[allow(unused_imports)]
use std::os::raw::c_void;
#[allow(unused_imports)]
use std::mem::transmute;
#[allow(unused_imports)]
use std::ffi::{CStr, CString};
use rute_ffi_base::*;
#[allow(unused_imports)]
use auto::*;
/// **Notice these docs are heavy WIP and not very relevent yet**
///
/// Key events are sent to the widget with keyboard input focus
/// when keys are pressed or released.
///
/// A key event contains a special accept flag that indicates whether
/// the receiver will handle the key event. This flag is set by default
/// for QEvent::KeyPress and QEvent::KeyRelease, so there is no need to
/// call accept() when acting on a key event. For QEvent::ShortcutOverride
/// the receiver needs to explicitly accept the event to trigger the override.
/// Calling ignore() on a key event will propagate it to the parent widget.
/// The event is propagated up the parent widget chain until a widget
/// accepts it or an event filter consumes it.
///
/// The QWidget::setEnabled() function can be used to enable or disable
/// mouse and keyboard events for a widget.
///
/// The event handlers QWidget::keyPressEvent(), QWidget::keyReleaseEvent(),
/// QGraphicsItem::keyPressEvent() and QGraphicsItem::keyReleaseEvent()
/// receive key events.
///
/// **See also:** [`FocusEvent`]
/// [`Widget::grab_keyboard`]
/// # Licence
///
/// The documentation is an adoption of the original [Qt Documentation](http://doc.qt.io/) and provided herein is licensed under the terms of the [GNU Free Documentation License version 1.3](http://www.gnu.org/licenses/fdl.html) as published by the Free Software Foundation.
#[derive(Clone)]
pub struct KeyEvent<'a> {
#[doc(hidden)]
pub data: Rc<Cell<Option<*const RUBase>>>,
#[doc(hidden)]
pub all_funcs: *const RUKeyEventAllFuncs,
#[doc(hidden)]
pub owned: bool,
#[doc(hidden)]
pub _marker: PhantomData<::std::cell::Cell<&'a ()>>,
}
impl<'a> KeyEvent<'a> {
#[allow(dead_code)]
pub(crate) fn new_from_rc(ffi_data: RUKeyEvent) -> KeyEvent<'a> {
KeyEvent {
data: unsafe { Rc::from_raw(ffi_data.host_data as *const Cell<Option<*const RUBase>>) },
all_funcs: ffi_data.all_funcs,
owned: false,
_marker: PhantomData,
}
}
#[allow(dead_code)]
pub(crate) fn new_from_owned(ffi_data: RUKeyEvent) -> KeyEvent<'a> {
KeyEvent {
data: Rc::new(Cell::new(Some(ffi_data.qt_data as *const RUBase))),
all_funcs: ffi_data.all_funcs,
owned: true,
_marker: PhantomData,
}
}
#[allow(dead_code)]
pub(crate) fn new_from_temporary(ffi_data: RUKeyEvent) -> KeyEvent<'a> {
KeyEvent {
data: Rc::new(Cell::new(Some(ffi_data.qt_data as *const RUBase))),
all_funcs: ffi_data.all_funcs,
owned: false,
_marker: PhantomData,
}
}
///
/// Returns the code of the key that was pressed or released.
///
/// See [Qt::Key](Qt::Key)
/// for the list of keyboard codes. These codes are
/// independent of the underlying window system. Note that this
/// function does not distinguish between capital and non-capital
/// letters, use the text() function (returning the Unicode text the
/// key generated) for this purpose.
///
/// A value of either 0 or Qt::Key_unknown means that the event is not
/// the result of a known key; for example, it may be the result of
/// a compose sequence, a keyboard macro, or due to key event
/// compression.
///
/// **See also:** [`t::wa_key_compression()`]
pub fn key(&self) -> i32 {
let (obj_data, funcs) = self.get_key_event_obj_funcs();
unsafe {
let ret_val = ((*funcs).key)(obj_data);
ret_val
}
}
///
/// Returns `true` if the key event matches the given standard *key;*
/// otherwise returns `false.`
pub fn matches(&self, key: StandardKey) -> bool {
let enum_key_1 = key as u32;
let (obj_data, funcs) = self.get_key_event_obj_funcs();
unsafe {
let ret_val = ((*funcs).matches)(obj_data, enum_key_1);
ret_val
}
}
///
/// Returns the keyboard modifier flags that existed immediately
/// after the event occurred.
///
/// **Warning**: This function cannot always be trusted. The user can
/// confuse it by pressing both **{Shift}** keys simultaneously and
/// releasing one of them, for example.
///
/// **See also:** [`GuiApplication::keyboard_modifiers`]
pub fn modifiers(&self) -> KeyboardModifiers {
let (obj_data, funcs) = self.get_key_event_obj_funcs();
unsafe {
let ret_val = ((*funcs).modifiers)(obj_data);
let ret_val = KeyboardModifiers::from_bits_truncate(ret_val);
ret_val
}
}
///
/// Returns the Unicode text that this key generated.
///
/// Return values when modifier keys such as
/// Shift, Control, Alt, and Meta are pressed
/// differ among platforms and could return an empty string.
///
/// **Note**: [key()](key())
/// will always return a valid value,
/// independent of modifier keys.
///
/// **See also:** [`t::wa_key_compression()`]
pub fn text(&self) -> String {
let (obj_data, funcs) = self.get_key_event_obj_funcs();
unsafe {
let ret_val = ((*funcs).text)(obj_data);
let ret_val = CStr::from_ptr(ret_val).to_string_lossy().into_owned();
ret_val
}
}
///
/// Returns `true` if this event comes from an auto-repeating key;
/// returns `false` if it comes from an initial key press.
///
/// Note that if the event is a multiple-key compressed event that is
/// partly due to auto-repeat, this function could return either true
/// or false indeterminately.
pub fn is_auto_repeat(&self) -> bool {
let (obj_data, funcs) = self.get_key_event_obj_funcs();
unsafe {
let ret_val = ((*funcs).is_auto_repeat)(obj_data);
ret_val
}
}
///
/// Returns the number of keys involved in this event. If text()
/// is not empty, this is simply the length of the string.
///
/// **See also:** [`t::wa_key_compression()`]
pub fn count(&self) -> i32 {
let (obj_data, funcs) = self.get_key_event_obj_funcs();
unsafe {
let ret_val = ((*funcs).count)(obj_data);
ret_val
}
}
///
/// Returns the native scan code of the key event. If the key event
/// does not contain this data 0 is returned.
///
/// Note: The native scan code may be 0, even if the key event contains
/// extended information.
///
/// Note: On Mac OS/X, this function is not useful, because there is no
/// way to get the scan code from Carbon or Cocoa. The function always
/// returns 1 (or 0 in the case explained above).
pub fn native_scan_code(&self) -> u32 {
let (obj_data, funcs) = self.get_key_event_obj_funcs();
unsafe {
let ret_val = ((*funcs).native_scan_code)(obj_data);
ret_val
}
}
///
/// Returns the native virtual key, or key sym of the key event.
/// If the key event does not contain this data 0 is returned.
///
/// Note: The native virtual key may be 0, even if the key event contains extended information.
pub fn native_virtual_key(&self) -> u32 {
let (obj_data, funcs) = self.get_key_event_obj_funcs();
unsafe {
let ret_val = ((*funcs).native_virtual_key)(obj_data);
ret_val
}
}
///
/// Returns the native modifiers of a key event.
/// If the key event does not contain this data 0 is returned.
///
/// Note: The native modifiers may be 0, even if the key event contains extended information.
pub fn native_modifiers(&self) -> u32 {
let (obj_data, funcs) = self.get_key_event_obj_funcs();
unsafe {
let ret_val = ((*funcs).native_modifiers)(obj_data);
ret_val
}
}
#[doc(hidden)]
pub fn set_modifiers(&self, amodifiers: KeyboardModifiers) -> &Self {
let enum_amodifiers_1 = amodifiers.bits();
let (obj_data, funcs) = self.get_input_event_obj_funcs();
unsafe {
((*funcs).set_modifiers)(obj_data, enum_amodifiers_1);
}
self
}
#[doc(hidden)]
pub fn timestamp(&self) -> u64 {
let (obj_data, funcs) = self.get_input_event_obj_funcs();
unsafe {
let ret_val = ((*funcs).timestamp)(obj_data);
ret_val
}
}
#[doc(hidden)]
pub fn set_timestamp(&self, atimestamp: u64) -> &Self {
let (obj_data, funcs) = self.get_input_event_obj_funcs();
unsafe {
((*funcs).set_timestamp)(obj_data, atimestamp);
}
self
}
#[doc(hidden)]
pub fn spontaneous(&self) -> bool {
let (obj_data, funcs) = self.get_event_obj_funcs();
unsafe {
let ret_val = ((*funcs).spontaneous)(obj_data);
ret_val
}
}
#[doc(hidden)]
pub fn set_accepted(&self, accepted: bool) -> &Self {
let (obj_data, funcs) = self.get_event_obj_funcs();
unsafe {
((*funcs).set_accepted)(obj_data, accepted);
}
self
}
#[doc(hidden)]
pub fn is_accepted(&self) -> bool {
let (obj_data, funcs) = self.get_event_obj_funcs();
unsafe {
let ret_val = ((*funcs).is_accepted)(obj_data);
ret_val
}
}
#[doc(hidden)]
pub fn accept(&self) -> &Self {
let (obj_data, funcs) = self.get_event_obj_funcs();
unsafe {
((*funcs).accept)(obj_data);
}
self
}
#[doc(hidden)]
pub fn ignore(&self) -> &Self {
let (obj_data, funcs) = self.get_event_obj_funcs();
unsafe {
((*funcs).ignore)(obj_data);
}
self
}
pub fn build(&self) -> Self {
self.clone()
}
}
pub trait KeyEventTrait<'a> {
#[inline]
#[doc(hidden)]
fn get_key_event_obj_funcs(&self) -> (*const RUBase, *const RUKeyEventFuncs);
}
impl<'a> EventTrait<'a> for KeyEvent<'a> {
#[doc(hidden)]
fn get_event_obj_funcs(&self) -> (*const RUBase, *const RUEventFuncs) {
let obj = self.data.get().unwrap();
unsafe { (obj, (*self.all_funcs).event_funcs) }
}
}
impl<'a> InputEventTrait<'a> for KeyEvent<'a> {
#[doc(hidden)]
fn get_input_event_obj_funcs(&self) -> (*const RUBase, *const RUInputEventFuncs) {
let obj = self.data.get().unwrap();
unsafe { (obj, (*self.all_funcs).input_event_funcs) }
}
}
impl<'a> KeyEventTrait<'a> for KeyEvent<'a> {
#[doc(hidden)]
fn get_key_event_obj_funcs(&self) -> (*const RUBase, *const RUKeyEventFuncs) {
let obj = self.data.get().unwrap();
unsafe { (obj, (*self.all_funcs).key_event_funcs) }
}
}