Struct gdk::EventMask

pub struct EventMask { /* private fields */ }

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

impl EventMask

pub const EXPOSURE_MASK: Self = Self{bits: ffi::GDK_EXPOSURE_MASK as u32,}

receive expose events

pub const POINTER_MOTION_MASK: Self = Self{bits: ffi::GDK_POINTER_MOTION_MASK as u32,}

receive all pointer motion events

pub const POINTER_MOTION_HINT_MASK: Self = Self{bits: ffi::GDK_POINTER_MOTION_HINT_MASK as u32,}

deprecated. see the explanation above

pub const BUTTON_MOTION_MASK: Self = Self{bits: ffi::GDK_BUTTON_MOTION_MASK as u32,}

receive pointer motion events while any button is pressed

pub const BUTTON1_MOTION_MASK: Self = Self{bits: ffi::GDK_BUTTON1_MOTION_MASK as u32,}

receive pointer motion events while 1 button is pressed

pub const BUTTON2_MOTION_MASK: Self = Self{bits: ffi::GDK_BUTTON2_MOTION_MASK as u32,}

receive pointer motion events while 2 button is pressed

pub const BUTTON3_MOTION_MASK: Self = Self{bits: ffi::GDK_BUTTON3_MOTION_MASK as u32,}

receive pointer motion events while 3 button is pressed

pub const BUTTON_PRESS_MASK: Self = Self{bits: ffi::GDK_BUTTON_PRESS_MASK as u32,}

receive button press events

pub const BUTTON_RELEASE_MASK: Self = Self{bits: ffi::GDK_BUTTON_RELEASE_MASK as u32,}

receive button release events

pub const KEY_PRESS_MASK: Self = Self{bits: ffi::GDK_KEY_PRESS_MASK as u32,}

receive key press events

pub const KEY_RELEASE_MASK: Self = Self{bits: ffi::GDK_KEY_RELEASE_MASK as u32,}

receive key release events

pub const ENTER_NOTIFY_MASK: Self = Self{bits: ffi::GDK_ENTER_NOTIFY_MASK as u32,}

receive window enter events

pub const LEAVE_NOTIFY_MASK: Self = Self{bits: ffi::GDK_LEAVE_NOTIFY_MASK as u32,}

receive window leave events

pub const FOCUS_CHANGE_MASK: Self = Self{bits: ffi::GDK_FOCUS_CHANGE_MASK as u32,}

receive focus change events

pub const STRUCTURE_MASK: Self = Self{bits: ffi::GDK_STRUCTURE_MASK as u32,}

receive events about window configuration change

pub const PROPERTY_CHANGE_MASK: Self = Self{bits: ffi::GDK_PROPERTY_CHANGE_MASK as u32,}

receive property change events

pub const VISIBILITY_NOTIFY_MASK: Self = Self{bits: ffi::GDK_VISIBILITY_NOTIFY_MASK as u32,}

receive visibility change events

pub const PROXIMITY_IN_MASK: Self = Self{bits: ffi::GDK_PROXIMITY_IN_MASK as u32,}

receive proximity in events

pub const PROXIMITY_OUT_MASK: Self = Self{bits: ffi::GDK_PROXIMITY_OUT_MASK as u32,}

receive proximity out events

pub const SUBSTRUCTURE_MASK: Self = Self{bits: ffi::GDK_SUBSTRUCTURE_MASK as u32,}

receive events about window configuration changes of child windows

pub const SCROLL_MASK: Self = Self{bits: ffi::GDK_SCROLL_MASK as u32,}

receive scroll events

pub const TOUCH_MASK: Self = Self{bits: ffi::GDK_TOUCH_MASK as u32,}

receive touch events. Since 3.4

pub const SMOOTH_SCROLL_MASK: Self = Self{bits: ffi::GDK_SMOOTH_SCROLL_MASK as u32,}

receive smooth scrolling events. Since 3.4

pub const TOUCHPAD_GESTURE_MASK: Self = Self{bits: ffi::GDK_TOUCHPAD_GESTURE_MASK as u32,}

receive touchpad gesture events. Since 3.18

pub const TABLET_PAD_MASK: Self = Self{bits: ffi::GDK_TABLET_PAD_MASK as u32,}

receive tablet pad events. Since 3.22

pub const ALL_EVENTS_MASK: Self = Self{bits: ffi::GDK_ALL_EVENTS_MASK as u32,}

the combination of all the above event masks.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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.

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

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

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.

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: Self) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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.

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.

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.

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.

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

impl Binary for EventMask

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

Formats the value using the given formatter.

impl BitAnd<EventMask> for EventMask

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

Returns the intersection between the two sets of flags.

type Output = EventMask

The resulting type after applying the & operator.

impl BitAndAssign<EventMask> for EventMask

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<EventMask> for EventMask

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

Returns the union of the two sets of flags.

type Output = EventMask

The resulting type after applying the | operator.

impl BitOrAssign<EventMask> for EventMask

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<EventMask> for EventMask

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

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

type Output = EventMask

The resulting type after applying the ^ operator.

impl BitXorAssign<EventMask> for EventMask

fn bitxor_assign(&mut self, other: Self)

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 Debug for EventMask

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

Formats the value using the given formatter.

impl Display for EventMask

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

Formats the value using the given formatter.

impl Extend<EventMask> for EventMask

fn extend<T: IntoIterator<Item = Self>>(&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 = Self>>(iterator: T) -> Self

Creates a value from an iterator.

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

type Checker = GenericValueTypeChecker<EventMask>

Value type checker.

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

Get the contained value from a Value.

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

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = EventMask

The resulting type after applying the ! operator.

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.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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: &Rhs) -> bool

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

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

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

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

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

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

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

impl StaticType for EventMask

fn static_type() -> Type

Returns the type identifier of Self.

impl Sub<EventMask> for EventMask

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

Returns the set difference of the two sets of flags.

type Output = EventMask

The resulting type after applying the - operator.

impl SubAssign<EventMask> for EventMask

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl ToValue for EventMask

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl UpperHex for EventMask

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

Formats the value using the given formatter.

impl ValueType for EventMask

type Type = EventMask

Type to get the Type from.

impl Copy for EventMask

impl Eq for EventMask

impl StructuralEq for EventMask

impl StructuralPartialEq for EventMask