Struct input::keyboard::ModifierKey
[−]
pub struct ModifierKey { /* fields omitted */ }
Methods
impl ModifierKey
pub const NO_MODIFIER: ModifierKey
NO_MODIFIER: ModifierKey = ModifierKey{bits: 0,}
No modifier.
pub const CTRL: ModifierKey
CTRL: ModifierKey = ModifierKey{bits: 1,}
Ctrl.
pub const SHIFT: ModifierKey
SHIFT: ModifierKey = ModifierKey{bits: 2,}
Shift.
pub const ALT: ModifierKey
ALT: ModifierKey = ModifierKey{bits: 4,}
Alt.
pub const GUI: ModifierKey
GUI: ModifierKey = ModifierKey{bits: 8,}
Gui.
pub const CTRL_SHIFT: ModifierKey
CTRL_SHIFT: ModifierKey = ModifierKey{bits: <ModifierKey>::CTRL.bits | <ModifierKey>::SHIFT.bits,}
Ctrl + Shift.
pub const CTRL_ALT: ModifierKey
CTRL_ALT: ModifierKey = ModifierKey{bits: <ModifierKey>::CTRL.bits | <ModifierKey>::ALT.bits,}
Ctrl + Alt.
pub const CTRL_GUI: ModifierKey
CTRL_GUI: ModifierKey = ModifierKey{bits: <ModifierKey>::CTRL.bits | <ModifierKey>::GUI.bits,}
Ctrl + Gui.
pub const CTRL_SHIFT_ALT: ModifierKey
CTRL_SHIFT_ALT: ModifierKey = ModifierKey{bits: <ModifierKey>::CTRL.bits | <ModifierKey>::SHIFT.bits | <ModifierKey>::ALT.bits,}
Ctrl + Shift + Alt.
pub const CTRL_SHIFT_GUI: ModifierKey
CTRL_SHIFT_GUI: ModifierKey = ModifierKey{bits: <ModifierKey>::CTRL.bits | <ModifierKey>::SHIFT.bits | <ModifierKey>::GUI.bits,}
Ctrl + Shift + Gui.
pub const CTRL_SHIFT_ALT_GUI: ModifierKey
CTRL_SHIFT_ALT_GUI: ModifierKey = ModifierKey{bits: <ModifierKey>::CTRL.bits | <ModifierKey>::SHIFT.bits | <ModifierKey>::ALT.bits | <ModifierKey>::GUI.bits,}
Ctrl + Shift + Alt + Gui.
pub const SHIFT_ALT: ModifierKey
SHIFT_ALT: ModifierKey = ModifierKey{bits: <ModifierKey>::SHIFT.bits | <ModifierKey>::ALT.bits,}
Shift + Alt.
pub const SHIFT_GUI: ModifierKey
SHIFT_GUI: ModifierKey = ModifierKey{bits: <ModifierKey>::SHIFT.bits | <ModifierKey>::GUI.bits,}
Shift + Gui.
pub const SHIFT_ALT_GUI: ModifierKey
SHIFT_ALT_GUI: ModifierKey = ModifierKey{bits: <ModifierKey>::SHIFT.bits | <ModifierKey>::ALT.bits | <ModifierKey>::GUI.bits,}
Shift + Alt + Gui.
pub const ALT_GUI: ModifierKey
ALT_GUI: ModifierKey = ModifierKey{bits: <ModifierKey>::ALT.bits | <ModifierKey>::GUI.bits,}
Alt + Gui.
pub fn empty() -> ModifierKey
Returns an empty set of flags.
pub fn all() -> ModifierKey
Returns the set containing all flags.
pub fn bits(&self) -> u8
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u8) -> Option<ModifierKey>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub fn from_bits_truncate(bits: u8) -> ModifierKey
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub fn is_empty(&self) -> bool
Returns true
if no flags are currently stored.
pub fn is_all(&self) -> bool
Returns true
if all flags are currently set.
pub fn intersects(&self, other: ModifierKey) -> bool
Returns true
if there are flags common to both self
and other
.
pub fn contains(&self, other: ModifierKey) -> bool
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: ModifierKey)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: ModifierKey)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: ModifierKey)
Toggles the specified flags in-place.
pub fn set(&mut self, other: ModifierKey, value: bool)
Inserts or removes the specified flags depending on the passed value.
impl ModifierKey
[src]
pub fn event<E: GenericEvent>(&mut self, e: &E)
[src]
Change modifier key state depending on input.
If the left or side button is released, it counts as a release.
Trait Implementations
impl Copy for ModifierKey
impl PartialEq for ModifierKey
fn eq(&self, __arg_0: &ModifierKey) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &ModifierKey) -> bool
This method tests for !=
.
impl Eq for ModifierKey
impl Clone for ModifierKey
fn clone(&self) -> ModifierKey
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialOrd for ModifierKey
fn partial_cmp(&self, __arg_0: &ModifierKey) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &ModifierKey) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &ModifierKey) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &ModifierKey) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &ModifierKey) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for ModifierKey
fn cmp(&self, __arg_0: &ModifierKey) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
impl Hash for ModifierKey
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Debug for ModifierKey
impl Binary for ModifierKey
impl Octal for ModifierKey
impl LowerHex for ModifierKey
impl UpperHex for ModifierKey
impl BitOr for ModifierKey
type Output = ModifierKey
The resulting type after applying the |
operator.
fn bitor(self, other: ModifierKey) -> ModifierKey
Returns the union of the two sets of flags.
impl BitOrAssign for ModifierKey
fn bitor_assign(&mut self, other: ModifierKey)
Adds the set of flags.
impl BitXor for ModifierKey
type Output = ModifierKey
The resulting type after applying the ^
operator.
fn bitxor(self, other: ModifierKey) -> ModifierKey
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign for ModifierKey
fn bitxor_assign(&mut self, other: ModifierKey)
Toggles the set of flags.
impl BitAnd for ModifierKey
type Output = ModifierKey
The resulting type after applying the &
operator.
fn bitand(self, other: ModifierKey) -> ModifierKey
Returns the intersection between the two sets of flags.
impl BitAndAssign for ModifierKey
fn bitand_assign(&mut self, other: ModifierKey)
Disables all flags disabled in the set.
impl Sub for ModifierKey
type Output = ModifierKey
The resulting type after applying the -
operator.
fn sub(self, other: ModifierKey) -> ModifierKey
Returns the set difference of the two sets of flags.
impl SubAssign for ModifierKey
fn sub_assign(&mut self, other: ModifierKey)
Disables all flags enabled in the set.
impl Not for ModifierKey
type Output = ModifierKey
The resulting type after applying the !
operator.
fn not(self) -> ModifierKey
Returns the complement of this set of flags.
impl Extend<ModifierKey> for ModifierKey
fn extend<T: IntoIterator<Item = ModifierKey>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
impl FromIterator<ModifierKey> for ModifierKey
fn from_iter<T: IntoIterator<Item = ModifierKey>>(iterator: T) -> ModifierKey
Creates a value from an iterator. Read more
impl Default for ModifierKey
[src]
fn default() -> ModifierKey
[src]
Returns the "default value" for a type. Read more