Struct 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

the Shift key.

pub const LOCK_MASK: Self

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

pub const CONTROL_MASK: Self

the Control key.

pub const MOD1_MASK: Self

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

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

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

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

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

the first mouse button.

pub const BUTTON2_MASK: Self

the second mouse button.

pub const BUTTON3_MASK: Self

the third mouse button.

pub const BUTTON4_MASK: Self

the fourth mouse button.

pub const BUTTON5_MASK: Self

the fifth mouse button.

pub const MODIFIER_RESERVED_13_MASK: Self

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

pub const MODIFIER_RESERVED_14_MASK: Self

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

pub const MODIFIER_RESERVED_15_MASK: Self

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

pub const MODIFIER_RESERVED_16_MASK: Self

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

pub const MODIFIER_RESERVED_17_MASK: Self

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

pub const MODIFIER_RESERVED_18_MASK: Self

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

pub const MODIFIER_RESERVED_19_MASK: Self

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

pub const MODIFIER_RESERVED_20_MASK: Self

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

pub const MODIFIER_RESERVED_21_MASK: Self

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

pub const MODIFIER_RESERVED_22_MASK: Self

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

pub const MODIFIER_RESERVED_23_MASK: Self

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

pub const MODIFIER_RESERVED_24_MASK: Self

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

pub const MODIFIER_RESERVED_25_MASK: Self

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

pub const SUPER_MASK: Self

the Super modifier. Since 2.10

pub const HYPER_MASK: Self

the Hyper modifier. Since 2.10

pub const META_MASK: Self

the Meta modifier. Since 2.10

pub const MODIFIER_RESERVED_29_MASK: Self

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

pub const RELEASE_MASK: Self

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

a mask covering all modifier types.

impl ModifierType

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in other are also set in self.

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

Whether all set bits in other are also set in self.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in self and other.

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

Call insert when value is true or remove when value is false.

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

The bitwise and (&) of the bits in self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl ModifierType

pub const fn iter(&self) -> Iter<ModifierType>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<ModifierType>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for ModifierType

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

Formats the value using the given formatter.

impl BitAnd for ModifierType

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

The bitwise and (&) of the bits in self and other.

type Output = ModifierType

The resulting type after applying the & operator.

impl BitAndAssign for ModifierType

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in self and other.

impl BitOr for ModifierType

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

The bitwise or (|) of the bits in self and other.

type Output = ModifierType

The resulting type after applying the | operator.

impl BitOrAssign for ModifierType

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

impl BitXor for ModifierType

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

The bitwise exclusive-or (^) of the bits in self and other.

type Output = ModifierType

The resulting type after applying the ^ operator.

impl BitXorAssign for ModifierType

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for ModifierType

fn clone(&self) -> ModifierType

Returns a duplicate 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 Display 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 = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

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

const FLAGS: &'static [Flag<ModifierType>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> ModifierType

Convert from a bits value exactly.

fn all_named() -> ModifierType

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by [Self::FLAGS].

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in other are also set in self.

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

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

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

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl From<ModifierType> for Value

fn from(v: ModifierType) -> Self

Converts to this type from the input type.

impl FromIterator<ModifierType> for ModifierType

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

The bitwise or (|) of the bits in each flags value.

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

type ParamSpec = ParamSpecFlags

type SetValue = ModifierType

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecFlagsBuilder<'_, ModifierType>

fn param_spec_builder() -> Self::BuilderFn

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for ModifierType

type Item = ModifierType

The type of the elements being iterated over.

type IntoIter = Iter<ModifierType>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

The bitwise negation (!) of the bits in self, truncating the result.

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

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

Equality operator ==.

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

Inequality operator !=.

impl PublicFlags for ModifierType

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl StaticType for ModifierType

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralPartialEq for ModifierType

impl Sub for ModifierType

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

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = ModifierType

The resulting type after applying the - operator.

impl SubAssign for ModifierType

fn sub_assign(&mut self, other: Self)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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.