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 NO_MODIFIER_MASK: Self = _
Available on crate feature v4_14
only.
pub const NO_MODIFIER_MASK: Self = _
v4_14
only.No modifier.
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.
source§impl ModifierType
impl ModifierType
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl ModifierType
impl ModifierType
sourcepub const fn iter(&self) -> Iter<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.
sourcepub const fn iter_names(&self) -> IterNames<ModifierType>
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§
source§impl Binary for ModifierType
impl Binary for ModifierType
source§impl BitAnd for ModifierType
impl BitAnd for ModifierType
source§impl BitAndAssign for ModifierType
impl BitAndAssign for ModifierType
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for ModifierType
impl BitOr for ModifierType
source§fn bitor(self, other: ModifierType) -> Self
fn bitor(self, other: ModifierType) -> Self
The bitwise or (|
) of the bits in two flags values.
source§type Output = ModifierType
type Output = ModifierType
|
operator.source§impl BitOrAssign for ModifierType
impl BitOrAssign for ModifierType
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for ModifierType
impl BitXor for ModifierType
source§impl BitXorAssign for ModifierType
impl BitXorAssign for ModifierType
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for ModifierType
impl Clone for ModifierType
source§fn clone(&self) -> ModifierType
fn clone(&self) -> ModifierType
1.6.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 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)
The bitwise or (|
) of the bits in each flags value.
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 Flags for ModifierType
impl Flags for ModifierType
source§const FLAGS: &'static [Flag<ModifierType>] = _
const FLAGS: &'static [Flag<ModifierType>] = _
source§fn from_bits_retain(bits: u32) -> ModifierType
fn from_bits_retain(bits: u32) -> ModifierType
§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read more§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where
Self: Sized,
Flags::insert
] when value
is true
or [Flags::remove
] when value
is false
.§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read more§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.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
The bitwise or (|
) of the bits in each flags value.
source§impl<'a> FromValue<'a> for ModifierType
impl<'a> FromValue<'a> for ModifierType
source§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
source§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 IntoIterator for ModifierType
impl IntoIterator 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 PartialEq for ModifierType
impl PartialEq for ModifierType
source§impl PublicFlags for ModifierType
impl PublicFlags for ModifierType
source§impl StaticType for ModifierType
impl StaticType for ModifierType
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl Sub for ModifierType
impl Sub for ModifierType
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
source§type Output = ModifierType
type Output = ModifierType
-
operator.source§impl SubAssign for ModifierType
impl SubAssign for ModifierType
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
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
source§type Type = ModifierType
type Type = ModifierType
Type
from. Read moreimpl Copy for ModifierType
impl Eq for ModifierType
impl StructuralPartialEq for ModifierType
Auto Trait Implementations§
impl Freeze for ModifierType
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> IntoClosureReturnValue for T
impl<T> IntoClosureReturnValue for T
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 T
impl<T> ToSendValue for T
source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
SendValue
clone of self
.