Class

GtkGesturePan

Description [src]

final class Gtk.GesturePan : Gtk.GestureDrag
{
  /* No available fields */
}

GtkGesturePan is a GtkGesture implementation able to recognize pan gestures, those are drags that are locked to happen along one axis. The axis that a GtkGesturePan handles is defined at construct time, and can be changed through gtk_gesture_pan_set_orientation().

When the gesture starts to be recognized, GtkGesturePan will attempt to determine as early as possible whether the sequence is moving in the expected direction, and denying the sequence if this does not happen.

Once a panning gesture along the expected axis is recognized, the GtkGesturePan::pan signal will be emitted as input events are received, containing the offset in the given axis.

Hierarchy

hierarchy this GtkGesturePan ancestor_0 GtkGestureDrag ancestor_0--this ancestor_1 GtkGestureSingle ancestor_1--ancestor_0 ancestor_2 GtkGesture ancestor_2--ancestor_1 ancestor_3 GtkEventController ancestor_3--ancestor_2 ancestor_4 GObject ancestor_4--ancestor_3

Constructors

gtk_gesture_pan_new

Returns a newly created GtkGesture that recognizes pan gestures.

since: 3.14

Instance methods

gtk_gesture_pan_get_orientation

Returns the orientation of the pan gestures that this gesture expects.

since: 3.14

gtk_gesture_pan_set_orientation

Sets the orientation to be expected on pan gestures.

since: 3.14

Methods inherited from GtkGestureDrag (2)
gtk_gesture_drag_get_offset

If the gesture is active, this function returns TRUE and fills in x and y with the coordinates of the current point, as an offset to the starting drag point.

since: 3.14

gtk_gesture_drag_get_start_point

If the gesture is active, this function returns TRUE and fills in x and y with the drag start coordinates, in window-relative coordinates.

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.

since: 3.14

gtk_gesture_single_get_current_button

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

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.

since: 3.14

gtk_gesture_single_get_exclusive

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

since: 3.14

gtk_gesture_single_get_touch_only

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

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.

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.

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.

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.

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.

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.

since: 3.14

gtk_gesture_get_group

Returns all gestures in the group of gesture.

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.

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.

since: 3.14

gtk_gesture_get_sequence_state

Returns the sequence state, as seen by gesture.

since: 3.14

gtk_gesture_get_sequences

Returns the list of GdkEventSequences currently being interpreted by gesture.

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.

since: 3.14

gtk_gesture_group

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

since: 3.14

gtk_gesture_handles_sequence

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

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.

since: 3.14

gtk_gesture_is_grouped_with

Returns TRUE if both gestures pertain to the same group.

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.

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:.

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.

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

since: 3.14

gtk_gesture_ungroup

Separates gesture into an isolated group.

since: 3.14

Methods inherited from GtkEventController (5)
gtk_event_controller_get_propagation_phase

Gets the propagation phase at which controller handles events.

since: 3.14

gtk_event_controller_get_widget

Returns the GtkWidget this controller relates to.

since: 3.14

gtk_event_controller_handle_event

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

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.

since: 3.14

gtk_event_controller_set_propagation_phase

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.

Properties

Gtk.GesturePan:orientation

The expected orientation of pan gestures.

since: 3.14

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

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

since: 3.14

Gtk.GestureSingle:exclusive

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

since: 3.14

Gtk.GestureSingle:touch-only

Whether the gesture handles only touch events.

since: 3.14

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

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

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.

since: 3.14

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

The propagation phase at which this controller will handle events.

since: 3.14

Gtk.EventController:widget

The widget receiving the GdkEvents that the controller will handle.

since: 3.14

Signals

Gtk.GesturePan::pan

This signal is emitted once a panning gesture along the expected axis is detected.

since: 3.14

Signals inherited from GtkGestureDrag (3)
GtkGestureDrag::drag-begin

This signal is emitted whenever dragging starts.

since: 3.14

GtkGestureDrag::drag-end

This signal is emitted whenever the dragging is finished.

since: 3.14

GtkGestureDrag::drag-update

This signal is emitted whenever the dragging point moves.

since: 3.14

Signals inherited from GtkGesture (5)
GtkGesture::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.

since: 3.14

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

since: 3.14

GtkGesture::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.

since: 3.14

GtkGesture::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.

since: 3.14

GtkGesture::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.

since: 3.14

Signals inherited from GObject (1)
GObject::notify

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 GtkGesturePanClass {
  /* no available fields */
}

No description available.