Class

GtkGestureMultiPress

Description [src]

final class Gtk.GestureMultiPress : Gtk.GestureSingle {
  /* No available fields */
}

GtkGestureMultiPress is a GtkGesture implementation able to recognize multiple clicks on a nearby zone, which can be listened for through the GtkGestureMultiPress::pressed signal. Whenever time or distance between clicks exceed the GTK+ defaults, GtkGestureMultiPress::stopped is emitted, and the click counter is reset.

Callers may also restrict the area that is considered valid for a >1 touch/button press through gtk_gesture_multi_press_set_area(), so any click happening outside that area is considered to be a first click of its own.

Hierarchy

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

Constructors

gtk_gesture_multi_press_new

Returns a newly created GtkGesture that recognizes single and multiple presses.

Available since: 3.14

Instance methods

gtk_gesture_multi_press_get_area

If an area was set through gtk_gesture_multi_press_set_area(), this function will return TRUE and fill in rect with the press area. See gtk_gesture_multi_press_set_area() for more details on what the press area represents.

Available since: 3.14

gtk_gesture_multi_press_set_area

If rect is non-NULL, the press area will be checked to be confined within the rectangle, otherwise the button count will be reset so the press is seen as being the first one. If rect is NULL, the area will be reset to an unrestricted state.

Available since: 3.14

Methods inherited from GtkGestureSingle (8)
gtk_gesture_single_get_button

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

Available since: 3.14

gtk_gesture_single_get_current_button

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

Available since: 3.14

gtk_gesture_single_get_current_sequence

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

Available since: 3.14

gtk_gesture_single_get_exclusive

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

Available since: 3.14

gtk_gesture_single_get_touch_only

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

Available since: 3.14

gtk_gesture_single_set_button

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.

Available since: 3.14

gtk_gesture_single_set_exclusive

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.

Available since: 3.14

gtk_gesture_single_set_touch_only

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

GDK_TOUCH_BEGIN, #GDK_TOUCH_UPDATE or #GDK_TOUCH_END. If FALSE,

mouse events will be handled too.

Available since: 3.14

Methods inherited from GtkGesture (19)
gtk_gesture_get_bounding_box

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.

Available since: 3.14

gtk_gesture_get_bounding_box_center

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.

Available since: 3.14

gtk_gesture_get_device

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

Available since: 3.14

gtk_gesture_get_group

Returns all gestures in the group of gesture.

Available since: 3.14

gtk_gesture_get_last_event

Returns the last event that was processed for sequence.

gtk_gesture_get_last_updated_sequence

Returns the GdkEventSequence that was last updated on gesture.

Available since: 3.14

gtk_gesture_get_point

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.

Available since: 3.14

gtk_gesture_get_sequence_state

Returns the sequence state, as seen by gesture.

Available since: 3.14

gtk_gesture_get_sequences

Returns the list of GdkEventSequences currently being interpreted by gesture.

Available since: 3.14

gtk_gesture_get_window

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

Available since: 3.14

gtk_gesture_group

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

Available since: 3.14

gtk_gesture_handles_sequence

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

Available since: 3.14

gtk_gesture_is_active

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

Available since: 3.14

gtk_gesture_is_grouped_with

Returns TRUE if both gestures pertain to the same group.

Available since: 3.14

gtk_gesture_is_recognized

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.

Available since: 3.14

gtk_gesture_set_sequence_state

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:

Available since: 3.14

gtk_gesture_set_state

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

Available since: 3.14

gtk_gesture_set_window

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().

Available since: 3.14

gtk_gesture_ungroup

Separates gesture into an isolated group.

Available since: 3.14

Methods inherited from GtkEventController (5)
gtk_event_controller_get_propagation_phase

Gets the propagation phase at which controller handles events.

Available since: 3.14

gtk_event_controller_get_widget

Returns the GtkWidget this controller relates to.

Available since: 3.14

gtk_event_controller_handle_event

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

Available since: 3.14

gtk_event_controller_reset

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

Available since: 3.14

gtk_event_controller_set_propagation_phase

Sets the propagation phase at which a controller handles events.

Available since: 3.14

Methods inherited from GObject (42)

Properties

Properties inherited from GtkGestureSingle (3)
Gtk.GestureSingle:button

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

Available since: 3.14

Gtk.GestureSingle:exclusive

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

Available since: 3.14

Gtk.GestureSingle:touch-only

Whether the gesture handles only touch events.

Available since: 3.14

Properties inherited from GtkGesture (2)
Gtk.Gesture:n-points

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

Available since: 3.14

Gtk.Gesture:window

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

Available since: 3.14

Properties inherited from GtkEventController (2)
Gtk.EventController:propagation-phase

The propagation phase at which this controller will handle events.

Available since: 3.14

Gtk.EventController:widget

The widget receiving the GdkEvents that the controller will handle.

Available since: 3.14

Signals

Gtk.GestureMultiPress::pressed

This signal is emitted whenever a button or touch press happens.

Available since: 3.14

Gtk.GestureMultiPress::released

This signal is emitted when a button or touch is released. n_press will report the number of press that is paired to this event, note that GtkGestureMultiPress::stopped may have been emitted between the press and its release, n_press will only start over at the next press.

Available since: 3.14

Gtk.GestureMultiPress::stopped

This signal is emitted whenever any time/distance threshold has been exceeded.

Available since: 3.14

Signals inherited from GtkGesture (5)
Gtk.Gesture::begin

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.

Available since: 3.14

Gtk.Gesture::cancel

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()).

Available since: 3.14

Gtk.Gesture::end

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.

Available since: 3.14

Gtk.Gesture::sequence-state-changed

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

Available since: 3.14

Gtk.Gesture::update

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.

Available since: 3.14

Signals inherited from GObject (1)

Class structure

struct GtkGestureMultiPressClass {
  /* no available fields */
}