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
use crate::enums::MouseButtonState;
use crate::utility::macros::macros::{
get_function_result_bool, get_function_result_pointer, get_function_result_unit,
};
use crate::{EventSource, Mouse, VboxError};
use vbox_raw::sys_lib::IEventSource;
impl Mouse {
/// Initiates a mouse event using relative pointer movements along x and y axis.
///
/// # Arguments
///
///
/// * `dx` - Amount of pixels the mouse should move to the right. Negative values move the mouse to the left.
/// * `dy` - Amount of pixels the mouse should move downwards. Negative values move the mouse upwards.
/// * `dz` - Amount of mouse wheel moves. Positive values describe clockwise wheel rotations, negative values describe counterclockwise rotations.
/// * `dw` - Amount of horizontal mouse wheel moves. Positive values describe a movement to the left, negative values describe a movement to the right.
/// * `button_state` - The current state of mouse buttons.
///
/// # Returns
///
/// Returns Ok(()) success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
/// use virtualbox_rs::enums::{MouseButtonState, SessionType};
///
/// let vbox = VirtualBox::init().unwrap();
/// let mut session = Session::init().unwrap();
/// let machine = vbox.
/// find_machines("Freebsd_14").unwrap();
/// machine.lock_machine(&mut session, SessionType::Shared).unwrap();
///
/// let console = session.get_console().unwrap();
///
/// let mouse = console.get_mouse().unwrap();
/// mouse.put_mouse_event(1,1,1,1,MouseButtonState::Left).unwrap();
pub fn put_mouse_event(
&self,
dx: i32,
dy: i32,
dz: i32,
dw: i32,
button_state: MouseButtonState,
) -> Result<(), VboxError> {
let button_state = button_state.into();
get_function_result_unit!(self.object, PutMouseEvent, dx, dy, dz, dw, button_state)
}
/// Positions the mouse pointer using absolute x and y coordinates.
///
/// # Arguments
///
///
/// * `x` - X coordinate of the pointer in pixels, starting from 1.
/// * `y` - Y coordinate of the pointer in pixels, starting from 1.
/// * `dz` - Amount of mouse wheel moves. Positive values describe clockwise wheel rotations, negative values describe counterclockwise rotations.
/// * `dw` - Amount of horizontal mouse wheel moves. Positive values describe a movement to the left, negative values describe a movement to the right.
/// * `button_state` - The current state of mouse buttons.
///
/// # Returns
///
/// Returns Ok(()) success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
/// use virtualbox_rs::enums::{MouseButtonState, SessionType};
///
/// let vbox = VirtualBox::init().unwrap();
/// let mut session = Session::init().unwrap();
/// let machine = vbox.
/// find_machines("Freebsd_14").unwrap();
/// machine.lock_machine(&mut session, SessionType::Shared).unwrap();
///
/// let console = session.get_console().unwrap();
///
/// let mouse = console.get_mouse().unwrap();
/// mouse.put_mouse_event_absolute(1,1,1,1,MouseButtonState::Left).unwrap();
pub fn put_mouse_event_absolute(
&self,
x: i32,
y: i32,
dz: i32,
dw: i32,
button_state: MouseButtonState,
) -> Result<(), VboxError> {
let button_state = button_state.into();
get_function_result_unit!(
self.object,
PutMouseEventAbsolute,
x,
y,
dz,
dw,
button_state
)
}
/// Whether the guest OS supports absolute mouse pointer positioning or not.
///
/// # Returns
///
/// Returns bool success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
/// use virtualbox_rs::enums::SessionType;
///
/// let vbox = VirtualBox::init().unwrap();
/// let mut session = Session::init().unwrap();
/// let machine = vbox.
/// find_machines("Freebsd_14").unwrap();
/// machine.lock_machine(&mut session, SessionType::Shared).unwrap();
///
/// let console = session.get_console().unwrap();
///
/// let mouse = console.get_mouse().unwrap();
/// let supported = mouse.get_absolute_supported().unwrap();
pub fn get_absolute_supported(&self) -> Result<bool, VboxError> {
get_function_result_bool!(self.object, GetAbsoluteSupported)
}
/// Whether the guest OS supports relative mouse pointer positioning or not.
///
/// # Returns
///
/// Returns bool success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
/// use virtualbox_rs::enums::SessionType;
///
/// let vbox = VirtualBox::init().unwrap();
/// let mut session = Session::init().unwrap();
/// let machine = vbox.
/// find_machines("Freebsd_14").unwrap();
/// machine.lock_machine(&mut session, SessionType::Shared).unwrap();
///
/// let console = session.get_console().unwrap();
///
/// let mouse = console.get_mouse().unwrap();
/// let supported = mouse.get_relative_supported().unwrap();
pub fn get_relative_supported(&self) -> Result<bool, VboxError> {
get_function_result_bool!(self.object, GetRelativeSupported)
}
/// Whether the guest OS has enabled the multi-touch reporting device, touchscreen variant.
/// <div class="warning">
/// This flag only exists for versions 7 and above.
/// For compatibility with earlier versions, this field has been retained, but it always returns false
/// </div>
///
/// # Returns
///
/// Returns bool success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
/// use virtualbox_rs::enums::SessionType;
///
/// let vbox = VirtualBox::init().unwrap();
/// let mut session = Session::init().unwrap();
/// let machine = vbox.
/// find_machines("Freebsd_14").unwrap();
/// machine.lock_machine(&mut session, SessionType::Shared).unwrap();
///
/// let console = session.get_console().unwrap();
///
/// let mouse = console.get_mouse().unwrap();
/// let supported = mouse.get_touch_screen_supported().unwrap();
pub fn get_touch_screen_supported(&self) -> Result<bool, VboxError> {
#[cfg(not(is_v_6_1))]
{
get_function_result_bool!(self.object, GetTouchScreenSupported)
}
// TODO
#[cfg(is_v_6_1)]
{
Ok(false)
}
}
/// Whether the guest OS has enabled the multi-touch reporting device, touchpad variant.
///
/// <div class="warning">
/// This flag only exists for versions 7 and above.
/// For compatibility with earlier versions, this field has been retained, but it always returns false
/// </div>
///
/// # Returns
///
/// Returns bool success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
/// use virtualbox_rs::enums::SessionType;
///
/// let vbox = VirtualBox::init().unwrap();
/// let mut session = Session::init().unwrap();
/// let machine = vbox.
/// find_machines("Freebsd_14").unwrap();
/// machine.lock_machine(&mut session, SessionType::Shared).unwrap();
///
/// let console = session.get_console().unwrap();
///
/// let mouse = console.get_mouse().unwrap();
/// let supported = mouse.get_touch_pad_supported().unwrap();
pub fn get_touch_pad_supported(&self) -> Result<bool, VboxError> {
#[cfg(not(is_v_6_1))]
{
get_function_result_bool!(self.object, GetTouchPadSupported)
}
#[cfg(is_v_6_1)]
{
Ok(false)
}
}
/// Whether the guest OS can currently switch to drawing it's own mouse cursor on demand.
///
/// # Returns
///
/// Returns bool success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
/// use virtualbox_rs::enums::SessionType;
///
/// let vbox = VirtualBox::init().unwrap();
/// let mut session = Session::init().unwrap();
/// let machine = vbox.
/// find_machines("Freebsd_14").unwrap();
/// machine.lock_machine(&mut session, SessionType::Shared).unwrap();
///
/// let console = session.get_console().unwrap();
///
/// let mouse = console.get_mouse().unwrap();
/// let supported = mouse.get_needs_host_cursor().unwrap();
pub fn get_needs_host_cursor(&self) -> Result<bool, VboxError> {
get_function_result_bool!(self.object, GetNeedsHostCursor)
}
/// Event source for mouse events.
///
/// # Returns
///
/// Returns a new instance of the [`EventSource`] class on success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
/// use virtualbox_rs::enums::SessionType;
///
/// let vbox = VirtualBox::init().unwrap();
/// let mut session = Session::init().unwrap();
/// let machine = vbox.
/// find_machines("Freebsd_14").unwrap();
/// machine.lock_machine(&mut session, SessionType::Shared).unwrap();
///
/// let console = session.get_console().unwrap();
/// let mouse = console.get_mouse().unwrap();
///
/// let event_source = mouse.get_event_source().unwrap();
pub fn get_event_source(&self) -> Result<EventSource, VboxError> {
let event_source =
get_function_result_pointer!(self.object, GetEventSource, *mut IEventSource)?;
Ok(EventSource::new(event_source))
}
}