mouse-codes 0.1.0

Cross-platform mouse button code mapping and conversion
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

//! Mouse button code mapping implementations
//!
//! This module provides standard and custom mapping functionality for
//! converting between mouse buttons and platform-specific codes.

/// Custom mouse button mapping support
pub mod custom;
/// Standard mouse button code mappings for cross-platform compatibility
pub mod standard;

use crate::CodeMapper;

/// Re-export key types and traits from submodules
pub use custom::{CustomButton, CustomButtonMap};
pub use standard::parse_button_from_str;

/// Helper function to get platform-specific code for a button
///
/// Uses the standard mapping by default
pub fn get_code(button: &crate::types::Button, platform: crate::types::Platform) -> usize {
    CodeMapper::to_code(button, platform)
}

/// Helper function to get button from platform-specific code
///
/// Uses the standard mapping by default
pub fn get_button(code: usize, platform: crate::types::Platform) -> Option<crate::types::Button> {
    CodeMapper::from_code(code, platform)
}

/// Get all standard button mappings for a platform as a hashmap
pub fn standard_mapping(
    platform: crate::types::Platform,
) -> std::collections::HashMap<crate::types::Button, usize> {
    crate::utils::platform_button_mapping(platform)
}

/// Get reverse standard mapping (code to button) for a platform
pub fn reverse_standard_mapping(
    platform: crate::types::Platform,
) -> std::collections::HashMap<usize, crate::types::Button> {
    crate::utils::platform_code_mapping(platform)
}