Struct gdk::ModifierType

pub struct ModifierType { /* private fields */ }

A set of bit-flags to indicate the state of modifier keys and mouse buttons in various event types. Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.

Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.

Since 2.10, GDK recognizes which of the Meta, Super or Hyper keys are mapped to Mod2 - Mod5, and indicates this by setting SUPER_MASK, HYPER_MASK or META_MASK in the state field of key events.

Note that GDK may add internal values to events which include reserved values such as MODIFIER_RESERVED_13_MASK. Your code should preserve and ignore them. You can use MODIFIER_MASK to remove all reserved values.

Also note that the GDK X backend interprets button press events for button 4-7 as scroll events, so BUTTON4_MASK and BUTTON5_MASK will never be set.

Implementations

impl ModifierType

pub const SHIFT_MASK: Self = Self{bits: ffi::GDK_SHIFT_MASK as u32,}

the Shift key.

pub const LOCK_MASK: Self = Self{bits: ffi::GDK_LOCK_MASK as u32,}

a Lock key (depending on the modifier mapping of the X server this may either be CapsLock or ShiftLock).

pub const CONTROL_MASK: Self = Self{bits: ffi::GDK_CONTROL_MASK as u32,}

the Control key.

pub const MOD1_MASK: Self = Self{bits: ffi::GDK_MOD1_MASK as u32,}

the fourth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier, but normally it is the Alt key).

pub const MOD2_MASK: Self = Self{bits: ffi::GDK_MOD2_MASK as u32,}

the fifth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).

pub const MOD3_MASK: Self = Self{bits: ffi::GDK_MOD3_MASK as u32,}

the sixth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).

pub const MOD4_MASK: Self = Self{bits: ffi::GDK_MOD4_MASK as u32,}

the seventh modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).

pub const MOD5_MASK: Self = Self{bits: ffi::GDK_MOD5_MASK as u32,}

the eighth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier).

pub const BUTTON1_MASK: Self = Self{bits: ffi::GDK_BUTTON1_MASK as u32,}

the first mouse button.

pub const BUTTON2_MASK: Self = Self{bits: ffi::GDK_BUTTON2_MASK as u32,}

the second mouse button.

pub const BUTTON3_MASK: Self = Self{bits: ffi::GDK_BUTTON3_MASK as u32,}

the third mouse button.

pub const BUTTON4_MASK: Self = Self{bits: ffi::GDK_BUTTON4_MASK as u32,}

the fourth mouse button.

pub const BUTTON5_MASK: Self = Self{bits: ffi::GDK_BUTTON5_MASK as u32,}

the fifth mouse button.

pub const MODIFIER_RESERVED_13_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_13_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const MODIFIER_RESERVED_14_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_14_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const MODIFIER_RESERVED_15_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_15_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const MODIFIER_RESERVED_16_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_16_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const MODIFIER_RESERVED_17_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_17_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const MODIFIER_RESERVED_18_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_18_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const MODIFIER_RESERVED_19_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_19_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const MODIFIER_RESERVED_20_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_20_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const MODIFIER_RESERVED_21_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_21_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const MODIFIER_RESERVED_22_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_22_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const MODIFIER_RESERVED_23_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_23_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const MODIFIER_RESERVED_24_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_24_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const MODIFIER_RESERVED_25_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_25_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const SUPER_MASK: Self = Self{bits: ffi::GDK_SUPER_MASK as u32,}

the Super modifier. Since 2.10

pub const HYPER_MASK: Self = Self{bits: ffi::GDK_HYPER_MASK as u32,}

the Hyper modifier. Since 2.10

pub const META_MASK: Self = Self{bits: ffi::GDK_META_MASK as u32,}

the Meta modifier. Since 2.10

pub const MODIFIER_RESERVED_29_MASK: Self = Self{bits: ffi::GDK_MODIFIER_RESERVED_29_MASK as u32,}

A reserved bit flag; do not use in your own code

pub const RELEASE_MASK: Self = Self{bits: ffi::GDK_RELEASE_MASK as u32,}

not used in GDK itself. GTK+ uses it to differentiate between (keyval, modifiers) pairs from key press and release events.

pub const MODIFIER_MASK: Self = Self{bits: ffi::GDK_MODIFIER_MASK as u32,}

a mask covering all modifier types.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<Self>

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) -> Self

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> Self

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

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

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: Self) -> bool

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

pub const fn contains(&self, other: Self) -> bool

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

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

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

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for ModifierType

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

Formats the value using the given formatter.

impl BitAnd<ModifierType> for ModifierType

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

type Output = ModifierType

The resulting type after applying the & operator.

impl BitAndAssign<ModifierType> for ModifierType

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<ModifierType> for ModifierType

fn bitor(self, other: ModifierType) -> Self

Returns the union of the two sets of flags.

type Output = ModifierType

The resulting type after applying the | operator.

impl BitOrAssign<ModifierType> for ModifierType

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<ModifierType> for ModifierType

fn bitxor(self, other: Self) -> Self

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

type Output = ModifierType

The resulting type after applying the ^ operator.

impl BitXorAssign<ModifierType> for ModifierType

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for ModifierType

fn clone(&self) -> ModifierType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifierType

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

Formats the value using the given formatter.

impl Display for ModifierType

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

Formats the value using the given formatter.

impl Extend<ModifierType> for ModifierType

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<ModifierType> for ModifierType

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl<'a> FromValue<'a> for ModifierType

type Checker = GenericValueTypeChecker<ModifierType>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl Hash for ModifierType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for ModifierType

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

Formats the value using the given formatter.

impl Not for ModifierType

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = ModifierType

The resulting type after applying the ! operator.

impl Octal for ModifierType

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

Formats the value using the given formatter.

impl Ord for ModifierType

fn cmp(&self, other: &ModifierType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ModifierType> for ModifierType

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ModifierType> for ModifierType

fn partial_cmp(&self, other: &ModifierType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ModifierType

fn static_type() -> Type

Returns the type identifier of Self.

impl Sub<ModifierType> for ModifierType

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

type Output = ModifierType

The resulting type after applying the - operator.

impl SubAssign<ModifierType> for ModifierType

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl ToValue for ModifierType

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl UpperHex for ModifierType

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

Formats the value using the given formatter.

impl ValueType for ModifierType

type Type = ModifierType

Type to get the Type from.

impl Copy for ModifierType

impl Eq for ModifierType

impl StructuralEq for ModifierType

impl StructuralPartialEq for ModifierType