Struct gdk::ModifierType
source · [−]pub struct ModifierType { /* private fields */ }
Expand description
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
sourceimpl ModifierType
impl ModifierType
sourcepub const SHIFT_MASK: Self = _
pub const SHIFT_MASK: Self = _
the Shift key.
sourcepub const LOCK_MASK: Self = _
pub const LOCK_MASK: Self = _
a Lock key (depending on the modifier mapping of the X server this may either be CapsLock or ShiftLock).
sourcepub const CONTROL_MASK: Self = _
pub const CONTROL_MASK: Self = _
the Control key.
sourcepub const MOD1_MASK: Self = _
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).
sourcepub const MOD2_MASK: Self = _
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).
sourcepub const MOD3_MASK: Self = _
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).
sourcepub const MOD4_MASK: Self = _
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).
sourcepub const MOD5_MASK: Self = _
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).
sourcepub const BUTTON1_MASK: Self = _
pub const BUTTON1_MASK: Self = _
the first mouse button.
sourcepub const BUTTON2_MASK: Self = _
pub const BUTTON2_MASK: Self = _
the second mouse button.
sourcepub const BUTTON3_MASK: Self = _
pub const BUTTON3_MASK: Self = _
the third mouse button.
sourcepub const BUTTON4_MASK: Self = _
pub const BUTTON4_MASK: Self = _
the fourth mouse button.
sourcepub const BUTTON5_MASK: Self = _
pub const BUTTON5_MASK: Self = _
the fifth mouse button.
sourcepub const MODIFIER_RESERVED_13_MASK: Self = _
pub const MODIFIER_RESERVED_13_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const MODIFIER_RESERVED_14_MASK: Self = _
pub const MODIFIER_RESERVED_14_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const MODIFIER_RESERVED_15_MASK: Self = _
pub const MODIFIER_RESERVED_15_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const MODIFIER_RESERVED_16_MASK: Self = _
pub const MODIFIER_RESERVED_16_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const MODIFIER_RESERVED_17_MASK: Self = _
pub const MODIFIER_RESERVED_17_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const MODIFIER_RESERVED_18_MASK: Self = _
pub const MODIFIER_RESERVED_18_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const MODIFIER_RESERVED_19_MASK: Self = _
pub const MODIFIER_RESERVED_19_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const MODIFIER_RESERVED_20_MASK: Self = _
pub const MODIFIER_RESERVED_20_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const MODIFIER_RESERVED_21_MASK: Self = _
pub const MODIFIER_RESERVED_21_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const MODIFIER_RESERVED_22_MASK: Self = _
pub const MODIFIER_RESERVED_22_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const MODIFIER_RESERVED_23_MASK: Self = _
pub const MODIFIER_RESERVED_23_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const MODIFIER_RESERVED_24_MASK: Self = _
pub const MODIFIER_RESERVED_24_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const MODIFIER_RESERVED_25_MASK: Self = _
pub const MODIFIER_RESERVED_25_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const SUPER_MASK: Self = _
pub const SUPER_MASK: Self = _
the Super modifier. Since 2.10
sourcepub const HYPER_MASK: Self = _
pub const HYPER_MASK: Self = _
the Hyper modifier. Since 2.10
sourcepub const MODIFIER_RESERVED_29_MASK: Self = _
pub const MODIFIER_RESERVED_29_MASK: Self = _
A reserved bit flag; do not use in your own code
sourcepub const RELEASE_MASK: Self = _
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.
sourcepub const MODIFIER_MASK: Self = _
pub const MODIFIER_MASK: Self = _
a mask covering all modifier types.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
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
sourceimpl Binary for ModifierType
impl Binary for ModifierType
sourceimpl BitAnd<ModifierType> for ModifierType
impl BitAnd<ModifierType> for ModifierType
type Output = ModifierType
type Output = ModifierType
&
operator.sourceimpl BitAndAssign<ModifierType> for ModifierType
impl BitAndAssign<ModifierType> for ModifierType
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<ModifierType> for ModifierType
impl BitOr<ModifierType> for ModifierType
sourcefn bitor(self, other: ModifierType) -> Self
fn bitor(self, other: ModifierType) -> Self
Returns the union of the two sets of flags.
type Output = ModifierType
type Output = ModifierType
|
operator.sourceimpl BitOrAssign<ModifierType> for ModifierType
impl BitOrAssign<ModifierType> for ModifierType
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<ModifierType> for ModifierType
impl BitXor<ModifierType> for ModifierType
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = ModifierType
type Output = ModifierType
^
operator.sourceimpl BitXorAssign<ModifierType> for ModifierType
impl BitXorAssign<ModifierType> for ModifierType
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for ModifierType
impl Clone for ModifierType
sourcefn clone(&self) -> ModifierType
fn clone(&self) -> ModifierType
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for ModifierType
impl Debug for ModifierType
sourceimpl Display for ModifierType
impl Display for ModifierType
sourceimpl Extend<ModifierType> for ModifierType
impl Extend<ModifierType> for ModifierType
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)sourceimpl FromIterator<ModifierType> for ModifierType
impl FromIterator<ModifierType> for ModifierType
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
sourceimpl<'a> FromValue<'a> for ModifierType
impl<'a> FromValue<'a> for ModifierType
type Checker = GenericValueTypeChecker<ModifierType>
type Checker = GenericValueTypeChecker<ModifierType>
sourceunsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresourceimpl Hash for ModifierType
impl Hash for ModifierType
sourceimpl LowerHex for ModifierType
impl LowerHex for ModifierType
sourceimpl Not for ModifierType
impl Not for ModifierType
type Output = ModifierType
type Output = ModifierType
!
operator.sourceimpl Octal for ModifierType
impl Octal for ModifierType
sourceimpl Ord for ModifierType
impl Ord for ModifierType
sourcefn cmp(&self, other: &ModifierType) -> Ordering
fn cmp(&self, other: &ModifierType) -> Ordering
1.21.0 · sourceconst fn max(self, other: Self) -> Self
const fn max(self, other: Self) -> Self
1.21.0 · sourceconst fn min(self, other: Self) -> Self
const fn min(self, other: Self) -> Self
1.50.0 · sourceconst fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
const fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
sourceimpl PartialEq<ModifierType> for ModifierType
impl PartialEq<ModifierType> for ModifierType
sourcefn eq(&self, other: &ModifierType) -> bool
fn eq(&self, other: &ModifierType) -> bool
sourceimpl PartialOrd<ModifierType> for ModifierType
impl PartialOrd<ModifierType> for ModifierType
sourcefn partial_cmp(&self, other: &ModifierType) -> Option<Ordering>
fn partial_cmp(&self, other: &ModifierType) -> Option<Ordering>
1.0.0 · sourceconst fn le(&self, other: &Rhs) -> bool
const fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl StaticType for ModifierType
impl StaticType for ModifierType
sourcefn static_type() -> Type
fn static_type() -> Type
Self
.sourceimpl Sub<ModifierType> for ModifierType
impl Sub<ModifierType> for ModifierType
type Output = ModifierType
type Output = ModifierType
-
operator.sourceimpl SubAssign<ModifierType> for ModifierType
impl SubAssign<ModifierType> for ModifierType
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl ToValue for ModifierType
impl ToValue for ModifierType
sourceimpl UpperHex for ModifierType
impl UpperHex for ModifierType
sourceimpl ValueType for ModifierType
impl ValueType for ModifierType
type Type = ModifierType
type Type = ModifierType
Type
from. Read moreimpl Copy for ModifierType
impl Eq for ModifierType
impl StructuralEq for ModifierType
impl StructuralPartialEq for ModifierType
Auto Trait Implementations
impl RefUnwindSafe for ModifierType
impl Send for ModifierType
impl Sync for ModifierType
impl Unpin for ModifierType
impl UnwindSafe for ModifierType
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<T> StaticTypeExt for Twhere
T: StaticType,
impl<T> StaticTypeExt for Twhere
T: StaticType,
sourcefn ensure_type()
fn ensure_type()
sourceimpl<T> ToClosureReturnValue for Twhere
T: ToValue,
impl<T> ToClosureReturnValue for Twhere
T: ToValue,
fn to_closure_return_value(&self) -> Option<Value>
sourceimpl<T> ToSendValue for Twhere
T: Send + ToValue + ?Sized,
impl<T> ToSendValue for Twhere
T: Send + ToValue + ?Sized,
sourcefn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
SendValue
clone of self
.