byteplug 0.0.1

Minimalistic Multimedia Library
Documentation 
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

// Copyright (c) 2020 - Jonathan De Wachter
//
// This source file is part of the Byteplug framework which is released under the MIT license.
// Please refer to the LICENSE file that can be found at the root of the project directory.
//
// Written by Jonathan De Wachter <dewachter.jonathan@gmail.com>, January 2020

//! Give access to the real-time state of the mouse.
//!
//! Additional documentation is to be written here.

/// # An enumeration of the mouse buttons.
///
/// The **Component struct** is not documented yet. Pull requests are welcome.
///
pub enum Button {
    /// The left button
    Left,

    /// The right button
    Right,

    /// The middle button (usually is the wheel itself)
    Middle,

    /// The extra buttons (variadic, usually on the side of the mouse)
    Extra(u8)
}

/// # An enumeration of the mouse wheels.
///
/// Long description.
///
pub enum Wheel {
    Horizontal,
    Vertical
}

/// # Brief description
///
/// Long description.
///
pub struct Mouse {
}