gtk4/org.gtkkn.bindings.gtk/GestureSingle

GestureSingle

open class GestureSingle(pointer: <Error class: unknown class><<Error class: unknown class>>) : Gesture

GtkGestureSingle is a GtkGestures subclass optimized for singe-touch and mouse gestures.

Under interaction, these gestures stick to the first interacting sequence, which is accessible through method@Gtk.GestureSingle.get_current_sequence while the gesture is being interacted with.

By default gestures react to both %GDK_BUTTON_PRIMARY and touch events. method@Gtk.GestureSingle.set_touch_only can be used to change the touch behavior. Callers may also specify a different mouse button number to interact with through method@Gtk.GestureSingle.set_button, or react to any mouse button by setting it to 0. While the gesture is active, the button being currently pressed can be known through method@Gtk.GestureSingle.get_current_button.

Inheritors

Constructors

Link copied to clipboard
constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open var button: <Error class: unknown class>

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

Link copied to clipboard
open var exclusive: Boolean

Whether the gesture is exclusive.

Link copied to clipboard
val gtkEventControllerPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gtkGesturePointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gtkGestureSinglePointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open var name: String?

The name for this controller, typically used for debugging purposes.

Link copied to clipboard
open var propagationLimit: PropagationLimit

The limit for which events this controller will handle.

Link copied to clipboard
open var propagationPhase: PropagationPhase

The propagation phase at which this controller will handle events.

Link copied to clipboard
open var touchOnly: Boolean

Whether the gesture handles only touch events.

Link copied to clipboard
open val widget: Widget?

The widget receiving the GdkEvents that the controller will handle.

Functions

Link copied to clipboard
fun connectBegin(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>?) -> Unit): <Error class: unknown class>

Emitted when the gesture is recognized.

Link copied to clipboard
fun connectCancel(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>?) -> Unit): <Error class: unknown class>

Emitted whenever a sequence is cancelled.

Link copied to clipboard
fun connectEnd(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>?) -> Unit): <Error class: unknown class>

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.

Link copied to clipboard
fun connectSequenceStateChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>?, state: EventSequenceState) -> Unit): <Error class: unknown class>

Emitted whenever a sequence state changes.

Link copied to clipboard
fun connectUpdate(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>?) -> Unit): <Error class: unknown class>

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

Link copied to clipboard
open fun getBoundingBox(rect: <Error class: unknown class>): Boolean

If there are touch sequences being currently handled by @gesture, returns true and fills in @rect with the bounding box containing all active touches.

Link copied to clipboard
open fun getButton(): <Error class: unknown class>

Returns the button number @gesture listens for.

Link copied to clipboard
open fun getCurrentButton(): <Error class: unknown class>

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

Link copied to clipboard
open fun getCurrentEvent(): <Error class: unknown class>?

Returns the event that is currently being handled by the controller.

Link copied to clipboard
open fun getCurrentEventDevice(): <Error class: unknown class>?

Returns the device of the event that is currently being handled by the controller.

Link copied to clipboard
open fun getCurrentEventState(): <Error class: unknown class>

Returns the modifier state of the event that is currently being handled by the controller.

Link copied to clipboard
open fun getCurrentEventTime(): <Error class: unknown class>

Returns the timestamp of the event that is currently being handled by the controller.

Link copied to clipboard
open fun getCurrentSequence(): <Error class: unknown class>?

Returns the event sequence currently interacting with @gesture.

Link copied to clipboard
open fun getDevice(): <Error class: unknown class>?

Returns the logical GdkDevice that is currently operating on @gesture.

Link copied to clipboard
open fun getExclusive(): Boolean

Gets whether a gesture is exclusive.

Link copied to clipboard
open fun getGroup(): <Error class: unknown class>

Returns all gestures in the group of @gesture

Link copied to clipboard
open fun getLastEvent(sequence: <Error class: unknown class>? = null): <Error class: unknown class>?

Returns the last event that was processed for @sequence.

Link copied to clipboard
open fun getLastUpdatedSequence(): <Error class: unknown class>?

Returns the GdkEventSequence that was last updated on @gesture.

Link copied to clipboard
open fun getName(): String?

Gets the name of @controller.

Link copied to clipboard
open fun getPropagationLimit(): PropagationLimit

Gets the propagation limit of the event controller.

Link copied to clipboard
open fun getPropagationPhase(): PropagationPhase

Gets the propagation phase at which @controller handles events.

Link copied to clipboard
open fun getSequences(): <Error class: unknown class>

Returns the list of GdkEventSequences currently being interpreted by @gesture.

Link copied to clipboard
open fun getSequenceState(sequence: <Error class: unknown class>): EventSequenceState

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

Link copied to clipboard
open fun getTouchOnly(): Boolean

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

Link copied to clipboard
open fun getWidget(): Widget?

Returns the GtkWidget this controller relates to.

Link copied to clipboard
open fun group(gesture: Gesture)

Adds @gesture to the same group than @group_gesture.

Link copied to clipboard
open fun handlesSequence(sequence: <Error class: unknown class>? = null): Boolean

Returns true if @gesture is currently handling events corresponding to @sequence.

Link copied to clipboard
open fun isActive(): Boolean

Returns true if the gesture is currently active.

Link copied to clipboard
open fun isGroupedWith(other: Gesture): Boolean

Returns true if both gestures pertain to the same group.

Link copied to clipboard
open fun isRecognized(): Boolean

Returns true if the gesture is currently recognized.

Link copied to clipboard
open fun reset()

Resets the @controller to a clean state.

Link copied to clipboard
open fun setButton(button: <Error class: unknown class>)

Sets the button number @gesture listens to.

Link copied to clipboard
open fun setExclusive(exclusive: Boolean)

Sets whether @gesture is exclusive.

Link copied to clipboard
open fun setName(name: String? = null)

Sets a name on the controller that can be used for debugging.

Link copied to clipboard
open fun setPropagationLimit(limit: PropagationLimit)

Sets the event propagation limit on the event controller.

Link copied to clipboard
open fun setPropagationPhase(phase: PropagationPhase)

Sets the propagation phase at which a controller handles events.

Link copied to clipboard
open fun setSequenceState(sequence: <Error class: unknown class>, state: EventSequenceState): Boolean

Sets the state of @sequence in @gesture.

Link copied to clipboard
open fun setState(state: EventSequenceState): Boolean

Sets the state of all sequences that @gesture is currently interacting with.

Link copied to clipboard
open fun setStaticName(name: String? = null)

Sets a name on the controller that can be used for debugging.

Link copied to clipboard
open fun setTouchOnly(touchOnly: Boolean)

Sets whether to handle only touch events.

Link copied to clipboard
open fun ungroup()

Separates @gesture into an isolated group.