Enum PlatformKeymap

Source
pub enum PlatformKeymap {
    LinuxWindows,
    MacOs,
}
Expand description

Platform-specific primary modifier (Ctrl vs Cmd).

§Examples

use ailloli_ui_text::PlatformKeymap;
assert_ne!(PlatformKeymap::LinuxWindows, PlatformKeymap::MacOs);

Variants§

§

LinuxWindows

Treat Control as the primary shortcut modifier.

§

MacOs

Treat Meta/Command as the primary shortcut modifier.

Implementations§

Source§

impl PlatformKeymap

Source

pub fn current() -> Self

Returns the compile-target platform mapping.

macOS targets select Self::MacOs; every other target, including Linux, Windows, and WebAssembly, selects Self::LinuxWindows. This is compile-time selection, not runtime operating-system detection.

§Examples
use ailloli_ui_text::PlatformKeymap;
let current = PlatformKeymap::current();
assert!(matches!(current, PlatformKeymap::LinuxWindows | PlatformKeymap::MacOs));
Source

pub fn is_primary(self, event: &KeyEvent) -> bool

Tests only the platform’s primary modifier on a key event.

Other modifiers and the key state do not affect the result.

§Examples
use ailloli_ui_core::event::{Key, KeyEvent, KeyState, Modifiers};
use ailloli_ui_text::PlatformKeymap;
let event = KeyEvent {
    state: KeyState::Pressed,
    key: Key::Character("c".into()),
    modifiers: Modifiers { ctrl: true, ..Modifiers::default() },
    repeat: false,
    pointer_pos: None,
    text: None,
};
assert!(PlatformKeymap::LinuxWindows.is_primary(&event));
assert!(!PlatformKeymap::MacOs.is_primary(&event));

Trait Implementations§

Source§

impl Clone for PlatformKeymap

Source§

fn clone(&self) -> PlatformKeymap

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PlatformKeymap

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for PlatformKeymap

Source§

fn eq(&self, other: &PlatformKeymap) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for PlatformKeymap

Source§

impl Eq for PlatformKeymap

Source§

impl StructuralPartialEq for PlatformKeymap

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> ErasedDestructor for T
where T: 'static,