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 = Self{bits: ffi::GDK_EXPOSURE_MASK as u32,}
pub const EXPOSURE_MASK: Self = Self{bits: ffi::GDK_EXPOSURE_MASK as u32,}
receive expose events
sourcepub const POINTER_MOTION_MASK: Self = Self{bits: ffi::GDK_POINTER_MOTION_MASK as u32,}
pub const POINTER_MOTION_MASK: Self = Self{bits: ffi::GDK_POINTER_MOTION_MASK as u32,}
receive all pointer motion events
sourcepub const POINTER_MOTION_HINT_MASK: Self = Self{bits: ffi::GDK_POINTER_MOTION_HINT_MASK as u32,}
pub const POINTER_MOTION_HINT_MASK: Self = Self{bits: ffi::GDK_POINTER_MOTION_HINT_MASK as u32,}
deprecated. see the explanation above
sourcepub const BUTTON_MOTION_MASK: Self = Self{bits: ffi::GDK_BUTTON_MOTION_MASK as u32,}
pub const BUTTON_MOTION_MASK: Self = Self{bits: ffi::GDK_BUTTON_MOTION_MASK as u32,}
receive pointer motion events while any button is pressed
sourcepub const BUTTON1_MOTION_MASK: Self = Self{bits: ffi::GDK_BUTTON1_MOTION_MASK as u32,}
pub const BUTTON1_MOTION_MASK: Self = Self{bits: ffi::GDK_BUTTON1_MOTION_MASK as u32,}
receive pointer motion events while 1 button is pressed
sourcepub const BUTTON2_MOTION_MASK: Self = Self{bits: ffi::GDK_BUTTON2_MOTION_MASK as u32,}
pub const BUTTON2_MOTION_MASK: Self = Self{bits: ffi::GDK_BUTTON2_MOTION_MASK as u32,}
receive pointer motion events while 2 button is pressed
sourcepub const BUTTON3_MOTION_MASK: Self = Self{bits: ffi::GDK_BUTTON3_MOTION_MASK as u32,}
pub const BUTTON3_MOTION_MASK: Self = Self{bits: ffi::GDK_BUTTON3_MOTION_MASK as u32,}
receive pointer motion events while 3 button is pressed
sourcepub const BUTTON_PRESS_MASK: Self = Self{bits: ffi::GDK_BUTTON_PRESS_MASK as u32,}
pub const BUTTON_PRESS_MASK: Self = Self{bits: ffi::GDK_BUTTON_PRESS_MASK as u32,}
receive button press events
sourcepub const BUTTON_RELEASE_MASK: Self = Self{bits: ffi::GDK_BUTTON_RELEASE_MASK as u32,}
pub const BUTTON_RELEASE_MASK: Self = Self{bits: ffi::GDK_BUTTON_RELEASE_MASK as u32,}
receive button release events
sourcepub const KEY_PRESS_MASK: Self = Self{bits: ffi::GDK_KEY_PRESS_MASK as u32,}
pub const KEY_PRESS_MASK: Self = Self{bits: ffi::GDK_KEY_PRESS_MASK as u32,}
receive key press events
sourcepub const KEY_RELEASE_MASK: Self = Self{bits: ffi::GDK_KEY_RELEASE_MASK as u32,}
pub const KEY_RELEASE_MASK: Self = Self{bits: ffi::GDK_KEY_RELEASE_MASK as u32,}
receive key release events
sourcepub const ENTER_NOTIFY_MASK: Self = Self{bits: ffi::GDK_ENTER_NOTIFY_MASK as u32,}
pub const ENTER_NOTIFY_MASK: Self = Self{bits: ffi::GDK_ENTER_NOTIFY_MASK as u32,}
receive window enter events
sourcepub const LEAVE_NOTIFY_MASK: Self = Self{bits: ffi::GDK_LEAVE_NOTIFY_MASK as u32,}
pub const LEAVE_NOTIFY_MASK: Self = Self{bits: ffi::GDK_LEAVE_NOTIFY_MASK as u32,}
receive window leave events
sourcepub const FOCUS_CHANGE_MASK: Self = Self{bits: ffi::GDK_FOCUS_CHANGE_MASK as u32,}
pub const FOCUS_CHANGE_MASK: Self = Self{bits: ffi::GDK_FOCUS_CHANGE_MASK as u32,}
receive focus change events
sourcepub const STRUCTURE_MASK: Self = Self{bits: ffi::GDK_STRUCTURE_MASK as u32,}
pub const STRUCTURE_MASK: Self = Self{bits: ffi::GDK_STRUCTURE_MASK as u32,}
receive events about window configuration change
sourcepub const PROPERTY_CHANGE_MASK: Self = Self{bits: ffi::GDK_PROPERTY_CHANGE_MASK as u32,}
pub const PROPERTY_CHANGE_MASK: Self = Self{bits: ffi::GDK_PROPERTY_CHANGE_MASK as u32,}
receive property change events
sourcepub const VISIBILITY_NOTIFY_MASK: Self = Self{bits: ffi::GDK_VISIBILITY_NOTIFY_MASK as u32,}
pub const VISIBILITY_NOTIFY_MASK: Self = Self{bits: ffi::GDK_VISIBILITY_NOTIFY_MASK as u32,}
receive visibility change events
sourcepub const PROXIMITY_IN_MASK: Self = Self{bits: ffi::GDK_PROXIMITY_IN_MASK as u32,}
pub const PROXIMITY_IN_MASK: Self = Self{bits: ffi::GDK_PROXIMITY_IN_MASK as u32,}
receive proximity in events
sourcepub const PROXIMITY_OUT_MASK: Self = Self{bits: ffi::GDK_PROXIMITY_OUT_MASK as u32,}
pub const PROXIMITY_OUT_MASK: Self = Self{bits: ffi::GDK_PROXIMITY_OUT_MASK as u32,}
receive proximity out events
sourcepub const SUBSTRUCTURE_MASK: Self = Self{bits: ffi::GDK_SUBSTRUCTURE_MASK as u32,}
pub const SUBSTRUCTURE_MASK: Self = Self{bits: ffi::GDK_SUBSTRUCTURE_MASK as u32,}
receive events about window configuration changes of child windows
sourcepub const SCROLL_MASK: Self = Self{bits: ffi::GDK_SCROLL_MASK as u32,}
pub const SCROLL_MASK: Self = Self{bits: ffi::GDK_SCROLL_MASK as u32,}
receive scroll events
sourcepub const TOUCH_MASK: Self = Self{bits: ffi::GDK_TOUCH_MASK as u32,}
pub const TOUCH_MASK: Self = Self{bits: ffi::GDK_TOUCH_MASK as u32,}
receive touch events. Since 3.4
sourcepub const SMOOTH_SCROLL_MASK: Self = Self{bits: ffi::GDK_SMOOTH_SCROLL_MASK as u32,}
pub const SMOOTH_SCROLL_MASK: Self = Self{bits: ffi::GDK_SMOOTH_SCROLL_MASK as u32,}
receive smooth scrolling events. Since 3.4
sourcepub const TOUCHPAD_GESTURE_MASK: Self = Self{bits: ffi::GDK_TOUCHPAD_GESTURE_MASK as u32,}
pub const TOUCHPAD_GESTURE_MASK: Self = Self{bits: ffi::GDK_TOUCHPAD_GESTURE_MASK as u32,}
receive touchpad gesture events. Since 3.18
sourcepub const TABLET_PAD_MASK: Self = Self{bits: ffi::GDK_TABLET_PAD_MASK as u32,}
pub const TABLET_PAD_MASK: Self = Self{bits: ffi::GDK_TABLET_PAD_MASK as u32,}
receive tablet pad events. Since 3.22
sourcepub const ALL_EVENTS_MASK: Self = Self{bits: ffi::GDK_ALL_EVENTS_MASK as u32,}
pub const ALL_EVENTS_MASK: Self = Self{bits: ffi::GDK_ALL_EVENTS_MASK as u32,}
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)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
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
Creates a value from an iterator. Read more
sourceimpl<'a> FromValue<'a> for EventMask
impl<'a> FromValue<'a> for EventMask
type Checker = GenericValueTypeChecker<EventMask>
type Checker = GenericValueTypeChecker<EventMask>
Value type checker.
sourceunsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Get the contained value from a Value
. Read more
sourceimpl Ord for EventMask
impl Ord for EventMask
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>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl StaticType for EventMask
impl StaticType for EventMask
sourcefn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of 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 T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> StaticTypeExt for T where
T: StaticType,
impl<T> StaticTypeExt for T where
T: StaticType,
sourcefn ensure_type()
fn ensure_type()
Ensures that the type has been registered with the type system.
sourceimpl<T> ToClosureReturnValue for T where
T: ToValue,
impl<T> ToClosureReturnValue for T where
T: ToValue,
fn to_closure_return_value(&self) -> Option<Value>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> ToSendValue for T where
T: Send + ToValue + ?Sized,
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized,
sourcefn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
Returns a SendValue
clone of self
.