Struct winit::event::ModifiersState[][src]

pub struct ModifiersState {
    bits: u32,
}

Represents the current state of the keyboard modifiers

Each flag represents a modifier and is set if this modifier is active.

Fields

bits: u32

Implementations

impl ModifiersState[src]

pub fn shift(&self) -> bool[src]

Returns true if the shift key is pressed.

pub fn ctrl(&self) -> bool[src]

Returns true if the control key is pressed.

pub fn alt(&self) -> bool[src]

Returns true if the alt key is pressed.

Returns true if the logo key is pressed.

impl ModifiersState[src]

pub const SHIFT: ModifiersState[src]

The “shift” key.

pub const CTRL: ModifiersState[src]

The “control” key.

pub const ALT: ModifiersState[src]

The “alt” key.

This is the “windows” key on PC and “command” key on Mac.

pub const fn empty() -> ModifiersState[src]

Returns an empty set of flags

pub const fn all() -> ModifiersState[src]

Returns the set containing all flags.

pub const fn bits(&self) -> u32[src]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<ModifiersState>[src]

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[src]

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> ModifiersState[src]

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool[src]

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool[src]

Returns true if all flags are currently set.

pub const fn intersects(&self, other: ModifiersState) -> bool[src]

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: ModifiersState) -> bool[src]

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: ModifiersState)[src]

Inserts the specified flags in-place.

pub fn remove(&mut self, other: ModifiersState)[src]

Removes the specified flags in-place.

pub fn toggle(&mut self, other: ModifiersState)[src]

Toggles the specified flags in-place.

pub fn set(&mut self, other: ModifiersState, value: bool)[src]

Inserts or removes the specified flags depending on the passed value.

impl ModifiersState[src]

pub(crate) fn from_x11(state: &XIModifierState) -> Self[src]

pub(crate) fn from_x11_mask(mask: c_uint) -> Self[src]

Trait Implementations

impl Binary for ModifiersState[src]

impl BitAnd<ModifiersState> for ModifiersState[src]

type Output = ModifiersState

The resulting type after applying the & operator.

fn bitand(self, other: ModifiersState) -> ModifiersState[src]

Returns the intersection between the two sets of flags.

impl BitAndAssign<ModifiersState> for ModifiersState[src]

fn bitand_assign(&mut self, other: ModifiersState)[src]

Disables all flags disabled in the set.

impl BitOr<ModifiersState> for ModifiersState[src]

type Output = ModifiersState

The resulting type after applying the | operator.

fn bitor(self, other: ModifiersState) -> ModifiersState[src]

Returns the union of the two sets of flags.

impl BitOrAssign<ModifiersState> for ModifiersState[src]

fn bitor_assign(&mut self, other: ModifiersState)[src]

Adds the set of flags.

impl BitXor<ModifiersState> for ModifiersState[src]

type Output = ModifiersState

The resulting type after applying the ^ operator.

fn bitxor(self, other: ModifiersState) -> ModifiersState[src]

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<ModifiersState> for ModifiersState[src]

fn bitxor_assign(&mut self, other: ModifiersState)[src]

Toggles the set of flags.

impl Clone for ModifiersState[src]

impl Copy for ModifiersState[src]

impl Debug for ModifiersState[src]

impl Default for ModifiersState[src]

impl Eq for ModifiersState[src]

impl Extend<ModifiersState> for ModifiersState[src]

impl From<ModifiersState> for ModifiersState[src]

impl FromIterator<ModifiersState> for ModifiersState[src]

impl Hash for ModifiersState[src]

impl LowerHex for ModifiersState[src]

impl Not for ModifiersState[src]

type Output = ModifiersState

The resulting type after applying the ! operator.

fn not(self) -> ModifiersState[src]

Returns the complement of this set of flags.

impl Octal for ModifiersState[src]

impl Ord for ModifiersState[src]

impl PartialEq<ModifiersState> for ModifiersState[src]

impl PartialOrd<ModifiersState> for ModifiersState[src]

impl StructuralEq for ModifiersState[src]

impl StructuralPartialEq for ModifiersState[src]

impl Sub<ModifiersState> for ModifiersState[src]

type Output = ModifiersState

The resulting type after applying the - operator.

fn sub(self, other: ModifiersState) -> ModifiersState[src]

Returns the set difference of the two sets of flags.

impl SubAssign<ModifiersState> for ModifiersState[src]

fn sub_assign(&mut self, other: ModifiersState)[src]

Disables all flags enabled in the set.

impl UpperHex for ModifiersState[src]

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]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.