Struct gdk4::ModifierType

pub struct ModifierType { /* fields omitted */ }

Flags to indicate the state of modifier keys and mouse buttons in events.

Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.

Note that GDK may add internal values to events which include values outside of this enumeration. Your code should preserve and ignore them. You can use GDK_MODIFIER_MASK to remove all private values.

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

the Super modifier

pub const HYPER_MASK: ModifierType

the Hyper modifier

pub const META_MASK: ModifierType

the Meta modifier

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

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

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

Disables all flags disabled in the set.

impl BitOr<ModifierType> for ModifierType

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

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

Adds the set of flags.

impl BitXor<ModifierType> for ModifierType

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

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

type Checker = GenericValueTypeChecker<Self>

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

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

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

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

Type to get the Type from.

impl Copy for ModifierType

impl Eq for ModifierType

impl StructuralEq for ModifierType

impl StructuralPartialEq for ModifierType