Struct gdk4::Event

pub struct Event(_);

Events are immutable data structures, created by GDK to represent windowing system events.

In GTK applications the events are handled automatically by toplevel widgets and passed on to the event controllers of appropriate widgets, so using Event and its related API is rarely needed.

This is an Abstract Base Class, you cannot instantiate it.

Implementations

impl Event

pub fn downcast<T: EventKind>(self) -> Result<T, Event>

pub fn downcast_ref<T: EventKind>(&self) -> Option<&T>

pub fn angle<P: AsRef<Event>>(&self, event: P) -> Option<f64>

pub fn center<P: AsRef<Event>>(&self, event: P) -> Option<(f64, f64)>

pub fn distance<P: AsRef<Event>>(&self, event: P) -> Option<f64>

pub fn axis(&self, axis_use: AxisUse) -> Option<f64>

Extract the axis value for a particular axis use from an event structure.

axis_use

the axis use to look for

Returns

true if the specified axis was found, otherwise false

value

location to store the value found

pub fn device(&self) -> Option<Device>

Returns the device of an event.

Returns

a Device

pub fn display(&self) -> Option<Display>

Retrieves the display associated to the self.

Returns

a Display

pub fn event_type(&self) -> EventType

Retrieves the type of the event.

Returns

a EventType

pub fn history(&self) -> Vec<TimeCoord>

Retrieves the history of the device that self is for, as a list of time and coordinates.

The history includes positions that are not delivered as separate events to the application because they occurred in the same frame as self.

Note that only motion and scroll events record history, and motion events do it only if one of the mouse buttons is down.

Returns

an array of time and coordinates

pub fn modifier_state(&self) -> ModifierType

Returns the modifier state field of an event.

Returns

the modifier state of self

pub fn is_pointer_emulated(&self) -> bool

Returns whether this event is an ‘emulated’ pointer event.

Emulated pointer events typically originate from a touch events.

Returns

true if this event is emulated

pub fn position(&self) -> Option<(f64, f64)>

Extract the event surface relative x/y coordinates from an event.

Returns

x

location to put event surface x coordinate

y

location to put event surface y coordinate

pub fn seat(&self) -> Option<Seat>

Returns the seat that originated the event.

Returns

a Seat.

pub fn surface(&self) -> Option<Surface>

Extracts the surface associated with an event.

Returns

The Surface associated with the event

pub fn time(&self) -> u32

Returns the timestamp of self.

Not all events have timestamps. In that case, this function returns GDK_CURRENT_TIME.

Returns

timestamp field from self

pub fn triggers_context_menu(&self) -> bool

Returns whether a Event should trigger a context menu, according to platform conventions.

The right mouse button typically triggers context menus.

This function should always be used instead of simply checking for event->button == GDK_BUTTON_SECONDARY.

Returns

true if the event should trigger a context menu.

Trait Implementations

impl AsRef<Event> for ButtonEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for CrossingEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for ScrollEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for TouchEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for TouchpadEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for DeleteEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for DNDEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for FocusEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for GrabBrokenEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for KeyEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for MotionEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for PadEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Event> for ProximityEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Display for Event

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

Formats the value using the given formatter.

impl StaticType for Event

fn static_type() -> Type

Returns the type identifier of Self.