class: GestureMeta

[898:14] static extends: object

Generated metadata helpers for Gesture class surfaces.

Methods

• properties ()

  Returns property metadata for Gesture.

  • @r A list.

• signals ()

  Returns signal metadata for Gesture.

  • @r A list.

class: GestureSequencestatechangedCallback

[755:7] extends: object

Generated low-level callback wrapper for GIR callback sequence-state-changed.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• GestureSequencestatechangedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, sequence, state, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: GestureBeginCallback

[541:7] extends: object

Generated low-level callback wrapper for GIR callback begin.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• GestureBeginCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, sequence, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: GestureUpdateCallback

[827:7] extends: object

Generated low-level callback wrapper for GIR callback update.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• GestureUpdateCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, sequence, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: GestureCancelCallback

[612:7] extends: object

Generated low-level callback wrapper for GIR callback cancel.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• GestureCancelCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, sequence, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: Gesture

[67:7] extends: object

The base class for gesture recognition. Although GtkGesture is quite generalized to serve as a base for multi-touch gestures, it is suitable to implement single-touch and pointer-based gestures (using the special %NULL GdkEventSequence value for these). The number of touches that a GtkGesture need to be recognized is controlled by the [property@Gtk.Gesture:n-points] property, if a gesture is keeping track of less or more than that number of sequences, it won't check whether the gesture is recognized. As soon as the gesture has the expected number of touches, it will check regularly if it is recognized, the criteria to consider a gesture as "recognized" is left to GtkGesture subclasses. A recognized gesture will then emit the following signals: - [signal@Gtk.Gesture::begin] when the gesture is recognized. - [signal@Gtk.Gesture::update], whenever an input event is processed. - [signal@Gtk.Gesture::end] when the gesture is no longer recognized. ## Event propagation In order to receive events, a gesture needs to set a propagation phase through [method@Gtk.EventController.set_propagation_phase]. In the capture phase, events are propagated from the toplevel down to the target widget, and gestures that are attached to containers above the widget get a chance to interact with the event before it reaches the target. In the bubble phase, events are propagated up from the target widget to the toplevel, and gestures that are attached to containers above the widget get a chance to interact with events that have not been handled yet. ## States of a sequence Whenever input interaction happens, a single event may trigger a cascade of GtkGestures, both across the parents of the widget receiving the event and in parallel within an individual widget. It is a responsibility of the widgets using those gestures to set the state of touch sequences accordingly in order to enable cooperation of gestures around the GdkEventSequences triggering those. Within a widget, gestures can be grouped through [method@Gtk.Gesture.group]. Grouped gestures synchronize the state of sequences, so calling [method@Gtk.Gesture.set_state] on one will effectively propagate the state throughout the group. By default, all sequences start out in the %GTK_EVENT_SEQUENCE_NONE state, sequences in this state trigger the gesture event handler, but event propagation will continue unstopped by gestures. If a sequence enters into the %GTK_EVENT_SEQUENCE_DENIED state, the gesture group will effectively ignore the sequence, letting events go unstopped through the gesture, but the "slot" will still remain occupied while the touch is active. If a sequence enters in the %GTK_EVENT_SEQUENCE_CLAIMED state, the gesture group will grab all interaction on the sequence, by: - Setting the same sequence to %GTK_EVENT_SEQUENCE_DENIED on every other gesture group within the widget, and every gesture on parent widgets in the propagation chain. - Emitting [signal@Gtk.Gesture::cancel] on every gesture in widgets underneath in the propagation chain. - Stopping event propagation after the gesture group handles the event. Note: if a sequence is set early to %GTK_EVENT_SEQUENCE_CLAIMED on %GDK_TOUCH_BEGIN/%GDK_BUTTON_PRESS (so those events are captured before reaching the event widget, this implies %GTK_PHASE_CAPTURE), one similar event will be emulated if the sequence changes to %GTK_EVENT_SEQUENCE_DENIED. This way event coherence is preserved before event propagation is unstopped again. Sequence states can't be changed freely. See [method@Gtk.Gesture.set_state] to know about the possible lifetimes of a GdkEventSequence. ## Touchpad gestures On the platforms that support it, GtkGesture will handle transparently touchpad gesture events. The only precautions users of GtkGesture should do to enable this support are: - If the gesture has %GTK_PHASE_NONE, ensuring events of type %GDK_TOUCHPAD_SWIPE and %GDK_TOUCHPAD_PINCH are handled by the GtkGesture

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• Gesture (Handle = null)

  Creates a new Gesture by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asEventController ()

  Wraps this handle as EventController.

  • @r A EventController object.

• connectSignal (string Name, CallbackObj)

  Connects one generated callback wrapper to a named signal.

  • @p Name is the signal name.
  • @p CallbackObj is the generated callback wrapper to connect.
  • @r The connected handler id.

• disconnectSignalHandler (int HandlerId)

  Disconnects one retained signal handler id.

  • @p HandlerId is the signal handler id to disconnect.
  • @r None.

• setOnBegin (callback Fn, UserData = null)

  Emitted when the gesture is recognized. This means the number of touch sequences matches [property@Gtk.Gesture:n-points]. Note: These conditions may also happen when an extra touch (eg. a third touch on a 2-touches gesture) is lifted, in that situation @sequence won't pertain to the current set of active touches, so don't rely on this being true.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Gesture Self, EventSequence Sequence).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnCancel (callback Fn, UserData = null)

  Emitted whenever a sequence is cancelled. This usually happens on active touches when [method@Gtk.EventController.reset] is called on @gesture (manually, due to grabs...), or the individual @sequence was claimed by parent widgets' controllers (see [method@Gtk.Gesture.set_sequence_state]). @gesture must forget everything about @sequence as in response to this signal.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Gesture Self, EventSequence Sequence).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnEnd (callback Fn, UserData = null)

  Emitted when @gesture either stopped recognizing the event sequences as something to be handled, or the number of touch sequences became higher or lower than [property@Gtk.Gesture:n-points]. Note: @sequence might not pertain to the group of sequences that were previously triggering recognition on @gesture (ie. a just pressed touch sequence that exceeds [property@Gtk.Gesture:n-points]). This situation may be detected by checking through [method@Gtk.Gesture.handles_sequence].

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Gesture Self, EventSequence Sequence).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnSequencestatechanged (callback Fn, UserData = null)

  Emitted whenever a sequence state changes. See [method@Gtk.Gesture.set_sequence_state] to know more about the expectable sequence lifetimes.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Gesture Self, EventSequence Sequence, string State).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnUpdate (callback Fn, UserData = null)

  Emitted whenever an event is handled while the gesture is recognized.

  • @sequence is guaranteed to pertain to the set of active touches.
  • @p Fn is the Aussom callback.
  • @p Fn is called with (Gesture Self, EventSequence Sequence).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• get_device ()

  Returns the logical GdkDevice that is currently operating on @gesture. This returns %NULL if the gesture is not being interacted.

• get_group ()

  Returns all gestures in the group of @gesture

• get_last_event (object sequence)

  Returns the last event that was processed for @sequence. Note that the returned pointer is only valid as long as the @sequence is still interpreted by the @gesture. If in doubt, you should make a copy of the event.

  • @p sequence is a GdkEventSequence.

• get_last_updated_sequence ()

  Returns the GdkEventSequence that was last updated on @gesture.

• get_sequence_state (object sequence)

  Returns the @sequence state, as seen by @gesture.

  • @p sequence is a GdkEventSequence.

• get_sequences ()

  Returns the list of GdkEventSequences currently being interpreted by

  • @gesture. ``

• group (object gesture)

  Adds @gesture to the same group than @group_gesture. Gestures are by default isolated in their own groups. Both gestures must have been added to the same widget before they can be grouped. When gestures are grouped, the state of GdkEventSequences is kept in sync for all of those, so calling [method@Gtk.Gesture.set_sequence_state], on one will transfer the same value to the others. Groups also perform an "implicit grabbing" of sequences, if a GdkEventSequence state is set to %GTK_EVENT_SEQUENCE_CLAIMED on one group, every other gesture group attached to the same GtkWidget will switch the state for that sequence to %GTK_EVENT_SEQUENCE_DENIED.

  • @p gesture is a GtkGesture.
  • @r None.

• handles_sequence (object sequence)

  Returns %TRUE if @gesture is currently handling events corresponding to

  • @sequence. ``
  • @p sequence is a GdkEventSequence.

• is_active ()

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

• is_grouped_with (object other)

  Returns %TRUE if both gestures pertain to the same group.

  • @p other is another GtkGesture.

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

• set_sequence_state (object sequence, string 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: * None * None → Denied * None → Claimed * None → Claimed → Denied Note: Due to event handling ordering, it may be unsafe to set the state on another gesture within a [signal@Gtk.Gesture::begin] signal handler, as the callback might be executed before the other gesture knows about the sequence. A safe way to perform this could be: c static void first_gesture_begin_cb (GtkGesture *first_gesture, GdkEventSequence *sequence, gpointer user_data) { gtk_gesture_set_sequence_state (first_gesture, sequence, GTK_EVENT_SEQUENCE_CLAIMED); gtk_gesture_set_sequence_state (second_gesture, sequence, GTK_EVENT_SEQUENCE_DENIED); } static void second_gesture_begin_cb (GtkGesture *second_gesture, GdkEventSequence *sequence, gpointer user_data) { if (gtk_gesture_get_sequence_state (first_gesture, sequence) == GTK_EVENT_SEQUENCE_CLAIMED) gtk_gesture_set_sequence_state (second_gesture, sequence, GTK_EVENT_SEQUENCE_DENIED); } If both gestures are in the same group, just set the state on the gesture emitting the event, the sequence will be already be initialized to the group's global state when the second gesture processes the event.

  • @p sequence is a GdkEventSequence.
  • @p state is the sequence state.

• set_state (string state)

  Sets the state of all sequences that @gesture is currently interacting with. 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: * None * None → Denied * None → Claimed * None → Claimed → Denied Note: Due to event handling ordering, it may be unsafe to set the state on another gesture within a [signal@Gtk.Gesture::begin] signal handler, as the callback might be executed before the other gesture knows about the sequence. A safe way to perform this could be: c static void first_gesture_begin_cb (GtkGesture *first_gesture, GdkEventSequence *sequence, gpointer user_data) { gtk_gesture_set_state (first_gesture, GTK_EVENT_SEQUENCE_CLAIMED); gtk_gesture_set_state (second_gesture, GTK_EVENT_SEQUENCE_DENIED); } static void second_gesture_begin_cb (GtkGesture *second_gesture, GdkEventSequence *sequence, gpointer user_data) { if (gtk_gesture_get_sequence_state (first_gesture, sequence) == GTK_EVENT_SEQUENCE_CLAIMED) gtk_gesture_set_state (second_gesture, GTK_EVENT_SEQUENCE_DENIED); } If both gestures are in the same group, just set the state on the gesture emitting the event, the sequence will be already be initialized to the group's global state when the second gesture processes the event.

  • @p state is the sequence state.

• ungroup ()

  Separates @gesture into an isolated group.

  • @r None.

• group_list ()

  Returns get_group as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use get_group() when lazy or change-notify access is required.

  • @r An Aussom list of elements.

• sequences ()

  Returns get_sequences as an Aussom list of wrapper objects. This companion method materializes the full collection up front; use get_sequences() when lazy or change-notify access is required.

  • @r An Aussom list of elements.

class: GestureEndCallback

[683:7] extends: object

Generated low-level callback wrapper for GIR callback end.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• GestureEndCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, sequence, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.