Description [src]

final class Gtk.GestureSingle : Gtk.Gesture
  /* No available fields */

GtkGestureSingle is a subclass of GtkGesture, optimized (although not restricted) for dealing with mouse and single-touch gestures. Under interaction, these gestures stick to the first interacting sequence, which is accessible through gtk_gesture_single_get_current_sequence() while the gesture is being interacted with.

By default gestures react to both GDK_BUTTON_PRIMARY and touch events, gtk_gesture_single_set_touch_only() can be used to change the touch behavior. Callers may also specify a different mouse button number to interact with through gtk_gesture_single_set_button(), or react to any mouse button by setting 0. While the gesture is active, the button being currently pressed can be known through gtk_gesture_single_get_current_button().


hierarchy this GtkGestureSingle ancestor_0 GtkGesture ancestor_0--this ancestor_1 GtkEventController ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

Instance methods


Returns the button number gesture listens for, or 0 if gesture reacts to any button press.

since: 3.14


Returns the button number currently interacting with gesture, or 0 if there is none.

since: 3.14


Returns the event sequence currently interacting with gesture. This is only meaningful if gtk_gesture_is_active() returns TRUE.

since: 3.14


Gets whether a gesture is exclusive. For more information, see gtk_gesture_single_set_exclusive().

since: 3.14


Returns TRUE if the gesture is only triggered by touch events.

since: 3.14


Sets the button number gesture listens to. If non-0, every button press from a different button number will be ignored. Touch events implicitly match with button 1.

since: 3.14


Sets whether gesture is exclusive. An exclusive gesture will only handle pointer and “pointer emulated” touch events, so at any given time, there is only one sequence able to interact with those.

since: 3.14


If touch_only is TRUE, gesture will only handle events of type


mouse events will be handled too.

since: 3.14

Methods inherited from GtkGesture (19)

If there are touch sequences being currently handled by gesture, this function returns TRUE and fills in rect with the bounding box containing all active touches. Otherwise, FALSE will be returned.

since: 3.14


If there are touch sequences being currently handled by gesture, this function returns TRUE and fills in x and y with the center of the bounding box containing all active touches. Otherwise, FALSE will be returned.

since: 3.14


Returns the master GdkDevice that is currently operating on gesture, or NULL if the gesture is not being interacted.

since: 3.14


Returns all gestures in the group of gesture.

since: 3.14


Returns the last event that was processed for sequence.


Returns the GdkEventSequence that was last updated on gesture.

since: 3.14


If sequence is currently being interpreted by gesture, this function returns TRUE and fills in x and y with the last coordinates stored for that event sequence. The coordinates are always relative to the widget allocation.

since: 3.14


Returns the sequence state, as seen by gesture.

since: 3.14


Returns the list of GdkEventSequences currently being interpreted by gesture.

since: 3.14


Returns the user-defined window that receives the events handled by gesture. See gtk_gesture_set_window() for more information.

since: 3.14


Adds gesture to the same group than group_gesture. Gestures are by default isolated in their own groups.

since: 3.14


Returns TRUE if gesture is currently handling events corresponding to sequence.

since: 3.14


Returns TRUE if the gesture is currently active. A gesture is active meanwhile there are touch sequences interacting with it.

since: 3.14


Returns TRUE if both gestures pertain to the same group.

since: 3.14


Returns TRUE if the gesture is currently recognized. A gesture is recognized if there are as many interacting touch sequences as required by gesture, and GtkGesture::check returned TRUE for the sequences being currently interpreted.

since: 3.14


Sets the state of sequence in gesture. Sequences start in state #GTK_EVENT_SEQUENCE_NONE, and whenever they change state, they can never go back to that state. Likewise, sequences in state #GTK_EVENT_SEQUENCE_DENIED cannot turn back to a not denied state. With these rules, the lifetime of an event sequence is constrained to the next four:

since: 3.14


Sets the state of all sequences that gesture is currently interacting with. See gtk_gesture_set_sequence_state() for more details on sequence states.

since: 3.14


Sets a specific window to receive events about, so gesture will effectively handle only events targeting window, or a child of it. window must pertain to gtk_event_controller_get_widget().

since: 3.14


Separates gesture into an isolated group.

since: 3.14

Methods inherited from GtkEventController (5)

Gets the propagation phase at which controller handles events.

since: 3.14


Returns the GtkWidget this controller relates to.

since: 3.14


Feeds an events into controller, so it can be interpreted and the controller actions triggered.

since: 3.14


Resets the controller to a clean state. Every interaction the controller did through GtkEventController::handle-event will be dropped at this point.

since: 3.14


Sets the propagation phase at which a controller handles events.

since: 3.14

Methods inherited from GObject (43)

Please see GObject for a full list of methods.



Mouse button number to listen to, or 0 to listen for any button.

since: 3.14


Whether the gesture is exclusive. Exclusive gestures only listen to pointer and pointer emulated events.

since: 3.14


Whether the gesture handles only touch events.

since: 3.14

Properties inherited from GtkGesture (2)

The number of touch points that trigger recognition on this gesture,

since: 3.14


If non-NULL, the gesture will only listen for events that happen on this GdkWindow, or a child of it.

since: 3.14

Properties inherited from GtkEventController (2)

The propagation phase at which this controller will handle events.

since: 3.14


The widget receiving the GdkEvents that the controller will handle.

since: 3.14


Signals inherited from GtkGesture (5)

This signal is emitted when the gesture is recognized. This means the number of touch sequences matches GtkGesture:n-points, and the GtkGesture::check handler(s) returned TRUE.

since: 3.14


This signal is emitted whenever a sequence is cancelled. This usually happens on active touches when gtk_event_controller_reset() is called on gesture (manually, due to grabs…), or the individual sequence was claimed by parent widgets’ controllers (see gtk_gesture_set_sequence_state()).

since: 3.14


This signal is emitted when gesture either stopped recognizing the event sequences as something to be handled (the GtkGesture::check handler returned FALSE), or the number of touch sequences became higher or lower than GtkGesture:n-points.

since: 3.14


This signal is emitted whenever a sequence state changes. See gtk_gesture_set_sequence_state() to know more about the expectable sequence lifetimes.

since: 3.14


This signal is emitted whenever an event is handled while the gesture is recognized. sequence is guaranteed to pertain to the set of active touches.

since: 3.14

Signals inherited from GObject (1)

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct GtkGestureSingleClass {
  /* no available fields */
No description available.