[−]Struct cat_engine::ModifiersState
Represents the current state of the keyboard modifiers
Each flag represents a modifier and is set if this modifier is active.
Implementations
impl ModifiersState
pub fn shift(&self) -> bool
Returns true
if the shift key is pressed.
pub fn ctrl(&self) -> bool
Returns true
if the control key is pressed.
pub fn alt(&self) -> bool
Returns true
if the alt key is pressed.
pub fn logo(&self) -> bool
Returns true
if the logo key is pressed.
impl ModifiersState
pub const SHIFT: ModifiersState
The "shift" key.
pub const CTRL: ModifiersState
The "control" key.
pub const ALT: ModifiersState
The "alt" key.
pub const LOGO: ModifiersState
This is the "windows" key on PC and "command" key on Mac.
pub const fn empty() -> ModifiersState
Returns an empty set of flags
pub const fn all() -> ModifiersState
Returns the set containing all flags.
pub const fn bits(&self) -> u32
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u32) -> Option<ModifiersState>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub const fn from_bits_truncate(bits: u32) -> ModifiersState
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u32) -> ModifiersState
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
pub const fn is_empty(&self) -> bool
Returns true
if no flags are currently stored.
pub const fn is_all(&self) -> bool
Returns true
if all flags are currently set.
pub const fn intersects(&self, other: ModifiersState) -> bool
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: ModifiersState) -> bool
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: ModifiersState)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: ModifiersState)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: ModifiersState)
Toggles the specified flags in-place.
pub fn set(&mut self, other: ModifiersState, value: bool)
Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl Binary for ModifiersState
impl BitAnd<ModifiersState> for ModifiersState
type Output = ModifiersState
The resulting type after applying the &
operator.
pub fn bitand(self, other: ModifiersState) -> ModifiersState
Returns the intersection between the two sets of flags.
impl BitAndAssign<ModifiersState> for ModifiersState
pub fn bitand_assign(&mut self, other: ModifiersState)
Disables all flags disabled in the set.
impl BitOr<ModifiersState> for ModifiersState
type Output = ModifiersState
The resulting type after applying the |
operator.
pub fn bitor(self, other: ModifiersState) -> ModifiersState
Returns the union of the two sets of flags.
impl BitOrAssign<ModifiersState> for ModifiersState
pub fn bitor_assign(&mut self, other: ModifiersState)
Adds the set of flags.
impl BitXor<ModifiersState> for ModifiersState
type Output = ModifiersState
The resulting type after applying the ^
operator.
pub fn bitxor(self, other: ModifiersState) -> ModifiersState
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign<ModifiersState> for ModifiersState
pub fn bitxor_assign(&mut self, other: ModifiersState)
Toggles the set of flags.
impl Clone for ModifiersState
pub fn clone(&self) -> ModifiersState
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for ModifiersState
impl Debug for ModifiersState
impl Default for ModifiersState
pub fn default() -> ModifiersState
impl Eq for ModifiersState
impl Extend<ModifiersState> for ModifiersState
pub fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = ModifiersState>,
T: IntoIterator<Item = ModifiersState>,
pub fn extend_one(&mut self, item: A)
[src]
pub fn extend_reserve(&mut self, additional: usize)
[src]
impl From<ModifiersState> for ModifiersState
pub fn from(mods: ModifiersState) -> ModifiersState
impl FromIterator<ModifiersState> for ModifiersState
pub fn from_iter<T>(iterator: T) -> ModifiersState where
T: IntoIterator<Item = ModifiersState>,
T: IntoIterator<Item = ModifiersState>,
impl Hash for ModifiersState
pub fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
__H: Hasher,
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl LowerHex for ModifiersState
impl Not for ModifiersState
type Output = ModifiersState
The resulting type after applying the !
operator.
pub fn not(self) -> ModifiersState
Returns the complement of this set of flags.
impl Octal for ModifiersState
impl Ord for ModifiersState
pub fn cmp(&self, other: &ModifiersState) -> Ordering
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
[src]
impl PartialEq<ModifiersState> for ModifiersState
pub fn eq(&self, other: &ModifiersState) -> bool
pub fn ne(&self, other: &ModifiersState) -> bool
impl PartialOrd<ModifiersState> for ModifiersState
pub fn partial_cmp(&self, other: &ModifiersState) -> Option<Ordering>
pub fn lt(&self, other: &ModifiersState) -> bool
pub fn le(&self, other: &ModifiersState) -> bool
pub fn gt(&self, other: &ModifiersState) -> bool
pub fn ge(&self, other: &ModifiersState) -> bool
impl StructuralEq for ModifiersState
impl StructuralPartialEq for ModifiersState
impl Sub<ModifiersState> for ModifiersState
type Output = ModifiersState
The resulting type after applying the -
operator.
pub fn sub(self, other: ModifiersState) -> ModifiersState
Returns the set difference of the two sets of flags.
impl SubAssign<ModifiersState> for ModifiersState
pub fn sub_assign(&mut self, other: ModifiersState)
Disables all flags enabled in the set.
impl UpperHex for ModifiersState
Auto Trait Implementations
impl RefUnwindSafe for ModifiersState
impl Send for ModifiersState
impl Sync for ModifiersState
impl Unpin for ModifiersState
impl UnwindSafe for ModifiersState
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Content for T where
T: Copy,
[src]
T: Copy,
type Owned = T
A type that holds a sized version of the content.
pub fn read<F, E>(size: usize, f: F) -> Result<T, E> where
F: FnOnce(&mut T) -> Result<(), E>,
[src]
F: FnOnce(&mut T) -> Result<(), E>,
pub fn get_elements_size() -> usize
[src]
pub fn to_void_ptr(&self) -> *const ()
[src]
pub fn ref_from_ptr(ptr: *mut (), size: usize) -> Option<*mut T>
[src]
pub fn is_size_suitable(size: usize) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,