Struct gdk::EventMask

pub struct EventMask { /* fields omitted */ }

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].

EventMask::PointerMotionHintMask is deprecated. It is a special mask to reduce the number of EventType::MotionNotify events received. When using EventMask::PointerMotionHintMask, 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 WindowExt::set_event_compression. See the documentation of that function for details.

If EventMask::TouchMask 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

impl EventMask

pub const EXPOSURE_MASK: EventMask

receive expose events

pub const POINTER_MOTION_MASK: EventMask

receive all pointer motion events

pub const POINTER_MOTION_HINT_MASK: EventMask

deprecated. see the explanation above

pub const BUTTON_MOTION_MASK: EventMask

receive pointer motion events while any button is pressed

pub const BUTTON1_MOTION_MASK: EventMask

receive pointer motion events while 1 button is pressed

pub const BUTTON2_MOTION_MASK: EventMask

receive pointer motion events while 2 button is pressed

pub const BUTTON3_MOTION_MASK: EventMask

receive pointer motion events while 3 button is pressed

pub const BUTTON_PRESS_MASK: EventMask

receive button press events

pub const BUTTON_RELEASE_MASK: EventMask

receive button release events

pub const KEY_PRESS_MASK: EventMask

receive key press events

pub const KEY_RELEASE_MASK: EventMask

receive key release events

pub const ENTER_NOTIFY_MASK: EventMask

receive window enter events

pub const LEAVE_NOTIFY_MASK: EventMask

receive window leave events

pub const FOCUS_CHANGE_MASK: EventMask

receive focus change events

pub const STRUCTURE_MASK: EventMask

receive events about window configuration change

pub const PROPERTY_CHANGE_MASK: EventMask

receive property change events

pub const VISIBILITY_NOTIFY_MASK: EventMask

receive visibility change events

pub const PROXIMITY_IN_MASK: EventMask

receive proximity in events

pub const PROXIMITY_OUT_MASK: EventMask

receive proximity out events

pub const SUBSTRUCTURE_MASK: EventMask

receive events about window configuration changes of child windows

pub const SCROLL_MASK: EventMask

receive scroll events

pub const TOUCH_MASK: EventMask

receive touch events. Since 3.4

pub const SMOOTH_SCROLL_MASK: EventMask

receive smooth scrolling events. Since 3.4

pub const TOUCHPAD_GESTURE_MASK: EventMask

receive touchpad gesture events. Since 3.18

pub const TABLET_PAD_MASK: EventMask

receive tablet pad events. Since 3.22

pub const ALL_EVENTS_MASK: EventMask

the combination of all the above event masks.

pub const fn empty() -> EventMask

Returns an empty set of flags

pub const fn all() -> EventMask

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<EventMask>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> EventMask

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> EventMask

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: EventMask) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: EventMask) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: EventMask)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: EventMask)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: EventMask)

Toggles the specified flags in-place.

pub fn set(&mut self, other: EventMask, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for EventMask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd<EventMask> for EventMask

type Output = EventMask

The resulting type after applying the & operator.

fn bitand(self, other: EventMask) -> EventMask

Returns the intersection between the two sets of flags.

impl BitAndAssign<EventMask> for EventMask

fn bitand_assign(&mut self, other: EventMask)

Disables all flags disabled in the set.

impl BitOr<EventMask> for EventMask

type Output = EventMask

The resulting type after applying the | operator.

fn bitor(self, other: EventMask) -> EventMask

Returns the union of the two sets of flags.

impl BitOrAssign<EventMask> for EventMask

fn bitor_assign(&mut self, other: EventMask)

Adds the set of flags.

impl BitXor<EventMask> for EventMask

type Output = EventMask

The resulting type after applying the ^ operator.

fn bitxor(self, other: EventMask) -> EventMask

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<EventMask> for EventMask

fn bitxor_assign(&mut self, other: EventMask)

Toggles the set of flags.

impl Clone for EventMask

fn clone(&self) -> EventMask

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for EventMask

impl Debug for EventMask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for EventMask

impl Extend<EventMask> for EventMask

fn extend<T: IntoIterator<Item = EventMask>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<EventMask> for EventMask

fn from_iter<T: IntoIterator<Item = EventMask>>(iterator: T) -> EventMask

Creates a value from an iterator.

impl<'a> FromValue<'a> for EventMask

unsafe fn from_value(value: &Value) -> Self

Safety

impl<'a> FromValueOptional<'a> for EventMask

unsafe fn from_value_optional(value: &Value) -> Option<Self>

Safety

impl Hash for EventMask

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for EventMask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for EventMask

type Output = EventMask

The resulting type after applying the ! operator.

fn not(self) -> EventMask

Returns the complement of this set of flags.

impl Octal for EventMask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for EventMask

fn cmp(&self, other: &EventMask) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<EventMask> for EventMask

fn eq(&self, other: &EventMask) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &EventMask) -> bool

This method tests for !=.

impl PartialOrd<EventMask> for EventMask

fn partial_cmp(&self, other: &EventMask) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &EventMask) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &EventMask) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &EventMask) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &EventMask) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl SetValue for EventMask

unsafe fn set_value(value: &mut Value, this: &Self)

Safety

impl StaticType for EventMask

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for EventMask

impl StructuralPartialEq for EventMask

impl Sub<EventMask> for EventMask

type Output = EventMask

The resulting type after applying the - operator.

fn sub(self, other: EventMask) -> EventMask

Returns the set difference of the two sets of flags.

impl SubAssign<EventMask> for EventMask

fn sub_assign(&mut self, other: EventMask)

Disables all flags enabled in the set.

impl UpperHex for EventMask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.