Struct gdk4::ModifierType
source · pub struct ModifierType { /* private fields */ }
Expand description
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§
source§impl 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 ALT_MASK: Self = _
pub const ALT_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 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 SUPER_MASK: Self = _
pub const SUPER_MASK: Self = _
the Super modifier
sourcepub const HYPER_MASK: Self = _
pub const HYPER_MASK: Self = _
the Hyper modifier
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§
source§impl Binary for ModifierType
impl Binary for ModifierType
source§impl BitAnd<ModifierType> for ModifierType
impl BitAnd<ModifierType> for ModifierType
source§impl BitAndAssign<ModifierType> for ModifierType
impl BitAndAssign<ModifierType> for ModifierType
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<ModifierType> for ModifierType
impl BitOr<ModifierType> for ModifierType
source§fn 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.source§impl BitOrAssign<ModifierType> for ModifierType
impl BitOrAssign<ModifierType> for ModifierType
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<ModifierType> for ModifierType
impl BitXor<ModifierType> for ModifierType
source§impl BitXorAssign<ModifierType> for ModifierType
impl BitXorAssign<ModifierType> for ModifierType
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ModifierType
impl Clone for ModifierType
source§fn clone(&self) -> ModifierType
fn clone(&self) -> ModifierType
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ModifierType
impl Debug for ModifierType
source§impl Display for ModifierType
impl Display for ModifierType
source§impl Extend<ModifierType> for ModifierType
impl Extend<ModifierType> for ModifierType
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl From<ModifierType> for Value
impl From<ModifierType> for Value
source§fn from(v: ModifierType) -> Self
fn from(v: ModifierType) -> Self
source§impl FromIterator<ModifierType> for ModifierType
impl FromIterator<ModifierType> for ModifierType
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl<'a> FromValue<'a> for ModifierType
impl<'a> FromValue<'a> for ModifierType
§type Checker = GenericValueTypeChecker<ModifierType>
type Checker = GenericValueTypeChecker<ModifierType>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl HasParamSpec for ModifierType
impl HasParamSpec for ModifierType
type ParamSpec = ParamSpecFlags
§type SetValue = ModifierType
type SetValue = ModifierType
type BuilderFn = fn(_: &str) -> ParamSpecFlagsBuilder<'_, ModifierType>
fn param_spec_builder() -> Self::BuilderFn
source§impl Hash for ModifierType
impl Hash for ModifierType
source§impl LowerHex for ModifierType
impl LowerHex for ModifierType
source§impl Not for ModifierType
impl Not for ModifierType
source§impl Octal for ModifierType
impl Octal for ModifierType
source§impl Ord for ModifierType
impl Ord for ModifierType
source§fn cmp(&self, other: &ModifierType) -> Ordering
fn cmp(&self, other: &ModifierType) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<ModifierType> for ModifierType
impl PartialEq<ModifierType> for ModifierType
source§fn eq(&self, other: &ModifierType) -> bool
fn eq(&self, other: &ModifierType) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<ModifierType> for ModifierType
impl PartialOrd<ModifierType> for ModifierType
source§fn partial_cmp(&self, other: &ModifierType) -> Option<Ordering>
fn partial_cmp(&self, other: &ModifierType) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl StaticType for ModifierType
impl StaticType for ModifierType
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl Sub<ModifierType> for ModifierType
impl Sub<ModifierType> for ModifierType
source§impl SubAssign<ModifierType> for ModifierType
impl SubAssign<ModifierType> for ModifierType
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl ToValue for ModifierType
impl ToValue for ModifierType
source§impl UpperHex for ModifierType
impl UpperHex for ModifierType
source§impl 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§
source§impl<T> IntoClosureReturnValue for Twhere
T: Into<Value>,
impl<T> IntoClosureReturnValue for Twhere T: Into<Value>,
fn into_closure_return_value(self) -> Option<Value>
source§impl<T> PropertyGet for Twhere
T: HasParamSpec,
impl<T> PropertyGet for Twhere T: HasParamSpec,
source§impl<T> StaticTypeExt for Twhere
T: StaticType,
impl<T> StaticTypeExt for Twhere T: StaticType,
source§fn ensure_type()
fn ensure_type()
source§impl<T> ToSendValue for Twhere
T: Send + ToValue + ?Sized,
impl<T> ToSendValue for Twhere T: Send + ToValue + ?Sized,
source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
SendValue
clone of self
.