Memory-managed wrapper type.

Construct a Event struct initialized to zero.

A convenience alias for Nothing :: Maybe Event.

Copies a Event, copying or incrementing the reference count of the resources associated with it (e.g. Window’s and strings).

Frees a Event, freeing or decrementing any resources associated with it. Note that this function should only be called with events returned from functions such as eventPeek, eventGet, eventCopy and eventNew.

Checks all open displays for a Event to process,to be processed on, fetching events from the windowing system if necessary. See displayGetEvent.

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

Extract the button number from an event.

Since: 3.2

Extracts the click count from an event.

Since: 3.2

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

If the event contains a “device” field, this function will return it, else it will return Nothing.

Since: 3.0

If the event was generated by a device that supports different tools (eg. a tablet), this function will return a DeviceTool representing the tool that caused the event. Otherwise, Nothing will be returned.

Note: the DeviceTool<!-- -->s will be constant during the application lifetime, if settings must be stored persistently across runs, see deviceToolGetSerial

Since: 3.22

If event if of type EventTypeTouchBegin, EventTypeTouchUpdate, EventTypeTouchEnd or EventTypeTouchCancel, returns the EventSequence to which the event belongs. Otherwise, return Nothing.

Since: 3.4

Retrieves the type of the event.

Since: 3.10

Extracts the hardware keycode from an event.

Also see eventGetScancode.

Since: 3.2

Extracts the keyval from an event.

Since: 3.2

event: a Event Returns whether this event is an 'emulated' pointer event (typically from a touch event), as opposed to a real one.

Since: 3.22

Extract the root window relative x/y coordinates from an event.

Gets the keyboard low-level scancode of a key event.

This is usually hardware_keycode. On Windows this is the high word of WM_KEY{DOWN,UP} lParam which contains the scancode and some extended flags.

Since: 3.22

Returns the screen for the event. The screen is typically the screen for event->any.window, but for events such as mouse events, it is the screen where the pointer was when the event occurs - that is, the screen which has the root window to which event->motion.x_root and event->motion.y_root are relative.

Since: 2.2

Retrieves the scroll deltas from a Event

Since: 3.4

Extracts the scroll direction from an event.

Since: 3.2

Returns the Seat this event was generated for.

Since: 3.20

This function returns the hardware (slave) Device that has triggered the event, falling back to the virtual (master) device (as in eventGetDevice) if the event wasn’t caused by interaction with a hardware device. This may happen for example in synthesized crossing events after a Window updates its geometry or a grab is acquired/released.

If the event does not contain a device field, this function will return Nothing.

Since: 3.0

If the event contains a “state” field, puts that field in state. Otherwise stores an empty state (0). Returns True if there was a state field in the event. event may be Nothing, in which case it’s treated as if the event had no state field.

Returns the time stamp from event, if there is one; otherwise returns CURRENT_TIME. If event is Nothing, returns CURRENT_TIME.

Extracts the Window associated with an event.

Since: 3.10

Sets the function to call to handle all events from GDK.

Note that GTK+ uses this to install its own event handler, so it is usually not useful for GTK+ applications. (Although an application can call this function then call gtk_main_do_event() to pass events to GTK+.)

Check whether a scroll event is a stop scroll event. Scroll sequences with smooth scroll information may provide a stop scroll event once the interaction with the device finishes, e.g. by lifting a finger. This stop scroll event is the signal that a widget may trigger kinetic scrolling based on the current velocity.

Stop scroll events always have a a delta of 0/0.

Since: 3.20

Creates a new event of the given type. All fields are set to 0.

Since: 2.2

If there is an event waiting in the event queue of some open display, returns a copy of it. See displayPeekEvent.

Appends a copy of the given event onto the front of the event queue for event->any.window’s display, or the default event queue if event->any.window is Nothing. See displayPutEvent.

Request more motion notifies if event is a motion notify hint event.

This function should be used instead of windowGetPointer to request further motion notifies, because it also works for extension events where motion notifies are provided for devices other than the core pointer. Coordinate extraction, processing and requesting more motion events from a EventTypeMotionNotify event usually works like this:

C code

{
  // motion_event handler
  x = motion_event->x;
  y = motion_event->y;
  // handle (x,y) motion
  gdk_event_request_motions (motion_event); // handles is_hint events
}

Since: 2.12

Sets the device for event to device. The event must have been allocated by GTK+, for instance, by eventCopy.

Since: 3.0

Sets the device tool for this event, should be rarely used.

Since: 3.22

Sets the screen for event to screen. The event must have been allocated by GTK+, for instance, by eventCopy.

Since: 2.2

Sets the slave device for event to device.

The event must have been allocated by GTK+, for instance by eventCopy.

Since: 3.0

This function returns whether a EventButton should trigger a context menu, according to platform conventions. The right mouse button always triggers context menus. Additionally, if keymapGetModifierMask returns a non-0 mask for ModifierIntentContextMenu, then the left mouse button will also trigger a context menu if this modifier is pressed.

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

Since: 3.4

Get the value of the “any” field. When overloading is enabled, this is equivalent to

get event #any

Get the value of the “button” field. When overloading is enabled, this is equivalent to

get event #button

Get the value of the “configure” field. When overloading is enabled, this is equivalent to

get event #configure

Get the value of the “crossing” field. When overloading is enabled, this is equivalent to

get event #crossing

Get the value of the “dnd” field. When overloading is enabled, this is equivalent to

get event #dnd

Get the value of the “expose” field. When overloading is enabled, this is equivalent to

get event #expose

Get the value of the “focus_change” field. When overloading is enabled, this is equivalent to

get event #focusChange

Get the value of the “grab_broken” field. When overloading is enabled, this is equivalent to

get event #grabBroken

Get the value of the “key” field. When overloading is enabled, this is equivalent to

get event #key

Get the value of the “motion” field. When overloading is enabled, this is equivalent to

get event #motion

Get the value of the “owner_change” field. When overloading is enabled, this is equivalent to

get event #ownerChange

Get the value of the “pad_axis” field. When overloading is enabled, this is equivalent to

get event #padAxis

Get the value of the “pad_button” field. When overloading is enabled, this is equivalent to

get event #padButton

Get the value of the “pad_group_mode” field. When overloading is enabled, this is equivalent to

get event #padGroupMode

Get the value of the “property” field. When overloading is enabled, this is equivalent to

get event #property

Get the value of the “proximity” field. When overloading is enabled, this is equivalent to

get event #proximity

Get the value of the “scroll” field. When overloading is enabled, this is equivalent to

get event #scroll

Get the value of the “selection” field. When overloading is enabled, this is equivalent to

get event #selection

Get the value of the “setting” field. When overloading is enabled, this is equivalent to

get event #setting

Get the value of the “touch” field. When overloading is enabled, this is equivalent to

get event #touch

Get the value of the “touchpad_pinch” field. When overloading is enabled, this is equivalent to

get event #touchpadPinch

Get the value of the “touchpad_swipe” field. When overloading is enabled, this is equivalent to

get event #touchpadSwipe

Get the value of the “type” field. When overloading is enabled, this is equivalent to

get event #type

Set the value of the “type” field. When overloading is enabled, this is equivalent to

set event [ #type := value ]

Get the value of the “visibility” field. When overloading is enabled, this is equivalent to

get event #visibility

Get the value of the “window_state” field. When overloading is enabled, this is equivalent to

get event #windowState