GtkEventController — Self-contained handler of series of events
char * | name | Read / Write |
GtkPropagationLimit | propagation-limit | Read / Write |
GtkPropagationPhase | propagation-phase | Read / Write |
GtkWidget * | widget | Read |
GObject ╰── GtkEventController ├── GtkGesture ├── GtkDropTarget ├── GtkDropTargetAsync ├── GtkEventControllerKey ├── GtkEventControllerFocus ├── GtkEventControllerLegacy ├── GtkEventControllerMotion ├── GtkEventControllerScroll ├── GtkPadController ╰── GtkShortcutController
#include <gtk/gtk.h>
GtkEventController is a base, low-level implementation for event controllers. Those react to a series of GdkEvents, and possibly trigger actions as a consequence of those.
GtkPropagationPhase
gtk_event_controller_get_propagation_phase
(GtkEventController *controller
);
Gets the propagation phase at which controller
handles events.
controller |
the propagation phase
void gtk_event_controller_set_propagation_phase (GtkEventController *controller
,GtkPropagationPhase phase
);
Sets the propagation phase at which a controller handles events.
If phase
is GTK_PHASE_NONE
, no automatic event handling will be performed, but other additional gesture maintenance will. In that phase, the events can be managed by calling gtk_event_controller_handle_event()
.
controller | ||
phase | a propagation phase |
GtkPropagationLimit
gtk_event_controller_get_propagation_limit
(GtkEventController *controller
);
Gets the propagation limit of the event controller.
controller |
the propagation limit
void gtk_event_controller_set_propagation_limit (GtkEventController *controller
,GtkPropagationLimit limit
);
Sets the event propagation limit on the event controller.
If the limit is set to GTK_LIMIT_SAME_NATIVE
, the controller won't handle events that are targeted at widgets on a different surface, such as popovers.
controller | ||
limit | the propagation limit |
GtkWidget *
gtk_event_controller_get_widget (GtkEventController *controller
);
Returns the GtkWidget this controller relates to.
controller |
void
gtk_event_controller_reset (GtkEventController *controller
);
Resets the controller
to a clean state. Every interaction the controller did through gtk_event_controller_handle_event()
will be dropped at this point.
controller |
const char *
gtk_event_controller_get_name (GtkEventController *controller
);
Gets the name of controller
.
controller |
void gtk_event_controller_set_name (GtkEventController *controller
,const char *name
);
Sets a name on the controller that can be used for debugging.
controller | ||
name | a name for |
GdkEvent *
gtk_event_controller_get_current_event
(GtkEventController *controller
);
Returns the event that is currently being handled by the controller, and NULL
at other times.
controller |
the event is current handled by controller
.
[nullable][transfer none]
GdkDevice *
gtk_event_controller_get_current_event_device
(GtkEventController *controller
);
Returns the device of the event that is currently being handled by the controller, and NULL
otherwise.
controller |
device of the event is current handled by controller
.
[nullable][transfer none]
GdkModifierType
gtk_event_controller_get_current_event_state
(GtkEventController *controller
);
Returns the modifier state of the event that is currently being handled by the controller, and 0 otherwise.
controller |
modifier state of the event is current handled by controller
guint32
gtk_event_controller_get_current_event_time
(GtkEventController *controller
);
Returns the timestamp of the event that is currently being handled by the controller, and 0 otherwise.
controller |
timestamp of the event is current handled by controller
typedef struct _GtkEventController GtkEventController;
Describes the stage at which events are fed into a GtkEventController.
GTK_PHASE_NONE | Events are not delivered. | |
GTK_PHASE_CAPTURE | Events are delivered in the capture phase. The capture phase happens before the bubble phase, runs from the toplevel down to the event widget. This option should only be used on containers that might possibly handle events before their children do. | |
GTK_PHASE_BUBBLE | Events are delivered in the bubble phase. The bubble phase happens after the capture phase, and before the default handlers are run. This phase runs from the event widget, up to the toplevel. | |
GTK_PHASE_TARGET | Events are delivered in the default widget event handlers, note that widget implementations must chain up on button, motion, touch and grab broken handlers for controllers in this phase to be run. |
Describes limits of a GtkEventController for handling events targeting other widgets.
GTK_LIMIT_NONE | Events are handled regardless of what their target is. | |
GTK_LIMIT_SAME_NATIVE | Events are only handled if their target is in the same GtkNative as the event controllers widget. Note that some event types have two targets (origin and destination). |
“name”
property“name” char *
The name for this controller, typically used for debugging purposes.
Owner: GtkEventController
Flags: Read / Write
Default value: NULL
“propagation-limit”
property“propagation-limit” GtkPropagationLimit
The limit for which events this controller will handle.
Owner: GtkEventController
Flags: Read / Write
Default value: GTK_LIMIT_SAME_NATIVE
“propagation-phase”
property“propagation-phase” GtkPropagationPhase
The propagation phase at which this controller will handle events.
Owner: GtkEventController
Flags: Read / Write
Default value: GTK_PHASE_BUBBLE
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk4/4.0/GtkEventController.html