Package: gtk

Class gtk:event-controller

Superclasses

gobject:object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

gtk:drop-controller-motion, gtk:drop-target, gtk:drop-target-async, gtk:event-controller-focus, gtk:event-controller-key, gtk:event-controller-legacy, gtk:event-controller-motion, gtk:event-controller-scroll, gtk:gesture, gtk:pad-controller, gtk:shortcut-controller

Direct Slots

name
The name property of type :string (Read / Write)
The name for this controller, typically used for debugging purposes.
Default value: nil
propagation-limit
The propagation-limit property of type gtk:propagation-limit (Read / Write)
The limit for which events the controller will handle.
Default value: :same-native
propagation-phase
The propagation-phase property of type gtk:propagation-phase (Read / Write)
The propagation phase at which this controller will handle events.
Default value: :bubble
widget
The widget property of type gtk:widget (Read)
The widget receiving the gdk:event instances that the controller will handle.

Details

The gtk:event-controller class is the base class for event controllers. These are ancillary objects associated to widgets, which react to gdk:event instances, and possibly trigger actions as a consequence.

Event controllers are added to a widget with the gtk:widget-add-controller function. It is rarely necessary to explicitly remove a controller with the gtk:widget-remove-controller function.

See the GTK documentation on input handling for an overview of the basic concepts, such as the capture and bubble phases of even propagation.
 

Slot Access Functions

gtk:event-controller-name
gtk:event-controller-propagation-limit
gtk:event-controller-propagation-phase
gtk:event-controller-widget

Inherited Slot Access Functions

g:object-has-reference
g:object-pointer

See also

gdk:event
gtk:gesture
2024-7-26