GBoxed event-scroll - cl-cffi-gtk3 API documentation

Package: gdk

GBoxed gdk:event-scroll

Declaration

(define-gboxed-variant-cstruct event "GdkEvent"
  (type event-type)
  (window (g:object window))
  (send-event (:boolean :int8))
  (:variant type
            ...
            ((:scroll) event-scroll
             (time :uint32)
             (x :double)
             (y :double)
             (state modifier-type)
             (direction scroll-direction)
             (device (g:object device))
             (x-root :double)
             (y-root :double)
             (delta-x :double)
             (delta-y :double))
  ... ))

Values

type: The gdk:event-type type of the scroll event.
window: The gdk:window object which received the event.
send-event: True if the event was sent explicitly.
time: The unsigned integer for the time of the event in milliseconds.
x: The double float x coordinate of the pointer relative to the window.
y: The double float y coordinate of the pointer relative to the window.
state: The gdk:modifier-type bit-mask representing the state of the modifier keys, for example, the Control, Shift and Alt keys, and the pointer buttons.
direction: The gdk:scroll-direction direction to scroll to, one of the :up, :down, :left, :right or :smooth values.
device: The gdk:device object where the event originated.
x-root: The double float x coordinate of the pointer relative to the root of the screen.
y-root: The double float y coordinate of the pointer relative to the root of the screen.
delta-x: The double float x coordinate of the scroll delta.
delta-y: The double float y coordinate of the scroll delta.

Details

Generated from button presses for the buttons 4 to 7. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.

Some GDK backends can also generate 'smooth' scroll events, which can be recognized by the :smooth direction. For these, the scroll deltas can be obtained with the gdk:event-scroll-deltas function.