Struct gdk::ModifierType

pub struct ModifierType { /* fields omitted */ }

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 ModifierType::SuperMask, ModifierType::HyperMask or ModifierType::MetaMask in the state field of key events.

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

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

Implementations

impl ModifierType

pub const SHIFT_MASK: ModifierType

the Shift key.

pub const LOCK_MASK: ModifierType

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

pub const CONTROL_MASK: ModifierType

the Control key.

pub const MOD1_MASK: ModifierType

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: ModifierType

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: ModifierType

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: ModifierType

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: ModifierType

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: ModifierType

the first mouse button.

pub const BUTTON2_MASK: ModifierType

the second mouse button.

pub const BUTTON3_MASK: ModifierType

the third mouse button.

pub const BUTTON4_MASK: ModifierType

the fourth mouse button.

pub const BUTTON5_MASK: ModifierType

the fifth mouse button.

pub const MODIFIER_RESERVED_13_MASK: ModifierType

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

pub const MODIFIER_RESERVED_14_MASK: ModifierType

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

pub const MODIFIER_RESERVED_15_MASK: ModifierType

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

pub const MODIFIER_RESERVED_16_MASK: ModifierType

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

pub const MODIFIER_RESERVED_17_MASK: ModifierType

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

pub const MODIFIER_RESERVED_18_MASK: ModifierType

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

pub const MODIFIER_RESERVED_19_MASK: ModifierType

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

pub const MODIFIER_RESERVED_20_MASK: ModifierType

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

pub const MODIFIER_RESERVED_21_MASK: ModifierType

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

pub const MODIFIER_RESERVED_22_MASK: ModifierType

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

pub const MODIFIER_RESERVED_23_MASK: ModifierType

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

pub const MODIFIER_RESERVED_24_MASK: ModifierType

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

pub const MODIFIER_RESERVED_25_MASK: ModifierType

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

pub const SUPER_MASK: ModifierType

the Super modifier. Since 2.10

pub const HYPER_MASK: ModifierType

the Hyper modifier. Since 2.10

pub const META_MASK: ModifierType

the Meta modifier. Since 2.10

pub const MODIFIER_RESERVED_29_MASK: ModifierType

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

pub const RELEASE_MASK: ModifierType

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

pub const MODIFIER_MASK: ModifierType

a mask covering all modifier types.

pub const fn empty() -> ModifierType

Returns an empty set of flags

pub const fn all() -> ModifierType

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<ModifierType>

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

type Output = ModifierType

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<ModifierType> for ModifierType

fn bitand_assign(&mut self, other: ModifierType)

Disables all flags disabled in the set.

impl BitOr<ModifierType> for ModifierType

type Output = ModifierType

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<ModifierType> for ModifierType

fn bitor_assign(&mut self, other: ModifierType)

Adds the set of flags.

impl BitXor<ModifierType> for ModifierType

type Output = ModifierType

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<ModifierType> for ModifierType

fn bitxor_assign(&mut self, other: ModifierType)

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 Copy for ModifierType

impl Debug for ModifierType

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

Formats the value using the given formatter.

impl Eq for ModifierType

impl Extend<ModifierType> for ModifierType

fn extend<T: IntoIterator<Item = ModifierType>>(&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 = ModifierType>>(iterator: T) -> ModifierType

Creates a value from an iterator.

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

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

Safety

impl<'a> FromValueOptional<'a> for ModifierType

unsafe fn from_value_optional(value: &Value) -> Option<Self>

Safety

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

type Output = ModifierType

The resulting type after applying the ! operator.

fn not(self) -> ModifierType

Returns the complement of this set of flags.

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

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: &ModifierType) -> bool

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

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

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

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

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

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

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

impl SetValue for ModifierType

unsafe fn set_value(value: &mut Value, this: &Self)

Safety

impl StaticType for ModifierType

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for ModifierType

impl StructuralPartialEq for ModifierType

impl Sub<ModifierType> for ModifierType

type Output = ModifierType

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<ModifierType> for ModifierType

fn sub_assign(&mut self, other: ModifierType)

Disables all flags enabled in the set.

impl UpperHex for ModifierType

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

Formats the value using the given formatter.