pub struct EventMask { /* private fields */ }
Expand description
A set of bit-flags to indicate which events a window is to receive.
Most of these masks map onto one or more of the EventType
event types
above.
See the [input handling overview][chap-input-handling] for details of [event masks][event-masks] and [event propagation][event-propagation].
POINTER_MOTION_HINT_MASK
is deprecated. It is a special mask
to reduce the number of EventType::MotionNotify
events received. When using
POINTER_MOTION_HINT_MASK
, fewer EventType::MotionNotify
events will
be sent, some of which are marked as a hint (the is_hint member is
true
). To receive more motion events after a motion hint event,
the application needs to asks for more, by calling
gdk_event_request_motions()
.
Since GTK 3.8, motion events are already compressed by default, independent
of this mechanism. This compression can be disabled with
Window::set_event_compression()
. See the documentation of that function
for details.
If TOUCH_MASK
is enabled, the window will receive touch events
from touch-enabled devices. Those will come as sequences of EventTouch
with type EventType::TouchUpdate
, enclosed by two events with
type EventType::TouchBegin
and EventType::TouchEnd
(or EventType::TouchCancel
).
gdk_event_get_event_sequence()
returns the event sequence for these
events, so different sequences may be distinguished.
Implementations
sourceimpl EventMask
impl EventMask
sourcepub const EXPOSURE_MASK: Self = _
pub const EXPOSURE_MASK: Self = _
receive expose events
sourcepub const POINTER_MOTION_MASK: Self = _
pub const POINTER_MOTION_MASK: Self = _
receive all pointer motion events
sourcepub const POINTER_MOTION_HINT_MASK: Self = _
pub const POINTER_MOTION_HINT_MASK: Self = _
deprecated. see the explanation above
sourcepub const BUTTON_MOTION_MASK: Self = _
pub const BUTTON_MOTION_MASK: Self = _
receive pointer motion events while any button is pressed
sourcepub const BUTTON1_MOTION_MASK: Self = _
pub const BUTTON1_MOTION_MASK: Self = _
receive pointer motion events while 1 button is pressed
sourcepub const BUTTON2_MOTION_MASK: Self = _
pub const BUTTON2_MOTION_MASK: Self = _
receive pointer motion events while 2 button is pressed
sourcepub const BUTTON3_MOTION_MASK: Self = _
pub const BUTTON3_MOTION_MASK: Self = _
receive pointer motion events while 3 button is pressed
sourcepub const BUTTON_PRESS_MASK: Self = _
pub const BUTTON_PRESS_MASK: Self = _
receive button press events
sourcepub const BUTTON_RELEASE_MASK: Self = _
pub const BUTTON_RELEASE_MASK: Self = _
receive button release events
sourcepub const KEY_PRESS_MASK: Self = _
pub const KEY_PRESS_MASK: Self = _
receive key press events
sourcepub const KEY_RELEASE_MASK: Self = _
pub const KEY_RELEASE_MASK: Self = _
receive key release events
sourcepub const ENTER_NOTIFY_MASK: Self = _
pub const ENTER_NOTIFY_MASK: Self = _
receive window enter events
sourcepub const LEAVE_NOTIFY_MASK: Self = _
pub const LEAVE_NOTIFY_MASK: Self = _
receive window leave events
sourcepub const FOCUS_CHANGE_MASK: Self = _
pub const FOCUS_CHANGE_MASK: Self = _
receive focus change events
sourcepub const STRUCTURE_MASK: Self = _
pub const STRUCTURE_MASK: Self = _
receive events about window configuration change
sourcepub const PROPERTY_CHANGE_MASK: Self = _
pub const PROPERTY_CHANGE_MASK: Self = _
receive property change events
sourcepub const VISIBILITY_NOTIFY_MASK: Self = _
pub const VISIBILITY_NOTIFY_MASK: Self = _
receive visibility change events
sourcepub const PROXIMITY_IN_MASK: Self = _
pub const PROXIMITY_IN_MASK: Self = _
receive proximity in events
sourcepub const PROXIMITY_OUT_MASK: Self = _
pub const PROXIMITY_OUT_MASK: Self = _
receive proximity out events
sourcepub const SUBSTRUCTURE_MASK: Self = _
pub const SUBSTRUCTURE_MASK: Self = _
receive events about window configuration changes of child windows
sourcepub const SCROLL_MASK: Self = _
pub const SCROLL_MASK: Self = _
receive scroll events
sourcepub const TOUCH_MASK: Self = _
pub const TOUCH_MASK: Self = _
receive touch events. Since 3.4
sourcepub const SMOOTH_SCROLL_MASK: Self = _
pub const SMOOTH_SCROLL_MASK: Self = _
receive smooth scrolling events. Since 3.4
sourcepub const TOUCHPAD_GESTURE_MASK: Self = _
pub const TOUCHPAD_GESTURE_MASK: Self = _
receive touchpad gesture events. Since 3.18
sourcepub const TABLET_PAD_MASK: Self = _
pub const TABLET_PAD_MASK: Self = _
receive tablet pad events. Since 3.22
sourcepub const ALL_EVENTS_MASK: Self = _
pub const ALL_EVENTS_MASK: Self = _
the combination of all the above event masks.
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 BitAndAssign<EventMask> for EventMask
impl BitAndAssign<EventMask> for EventMask
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOrAssign<EventMask> for EventMask
impl BitOrAssign<EventMask> for EventMask
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXorAssign<EventMask> for EventMask
impl BitXorAssign<EventMask> for EventMask
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Extend<EventMask> for EventMask
impl Extend<EventMask> for EventMask
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<EventMask> for EventMask
impl FromIterator<EventMask> for EventMask
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 EventMask
impl<'a> FromValue<'a> for EventMask
type Checker = GenericValueTypeChecker<EventMask>
type Checker = GenericValueTypeChecker<EventMask>
sourceunsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresourceimpl Ord for EventMask
impl Ord for EventMask
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 PartialOrd<EventMask> for EventMask
impl PartialOrd<EventMask> for EventMask
sourcefn partial_cmp(&self, other: &EventMask) -> Option<Ordering>
fn partial_cmp(&self, other: &EventMask) -> 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 EventMask
impl StaticType for EventMask
sourcefn static_type() -> Type
fn static_type() -> Type
Self
.sourceimpl SubAssign<EventMask> for EventMask
impl SubAssign<EventMask> for EventMask
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
impl Copy for EventMask
impl Eq for EventMask
impl StructuralEq for EventMask
impl StructuralPartialEq for EventMask
Auto Trait Implementations
impl RefUnwindSafe for EventMask
impl Send for EventMask
impl Sync for EventMask
impl Unpin for EventMask
impl UnwindSafe for EventMask
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
.