gtk4/org.gtkkn.bindings.gtk/GestureSwipe

GestureSwipe

open class GestureSwipe(val gtkGestureSwipePointer: <Error class: unknown class><<Error class: unknown class>>) : GestureSingle(source)

GtkGestureSwipe is a GtkGesture for swipe gestures.

After a press/move/.../move/release sequence happens, the signal@Gtk.GestureSwipe::swipe signal will be emitted, providing the velocity and directionality of the sequence at the time it was lifted.

If the velocity is desired in intermediate points, method@Gtk.GestureSwipe.get_velocity can be called in a signal@Gtk.Gesture::update handler.

All velocities are reported in pixels/sec units.

Skipped during bindings generation

parameter velocity_x: velocity_x: Out parameter is not supported

Constructors

GestureSwipe

constructor()

Returns a newly created GtkGesture that recognizes swipes.

constructor(gtkGestureSwipePointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

button

open var button: <Error class: unknown class>

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

exclusive

open var exclusive: Boolean

Whether the gesture is exclusive.

gtkEventControllerPointer

val gtkEventControllerPointer: <Error class: unknown class><<Error class: unknown class>>

gtkGesturePointer

val gtkGesturePointer: <Error class: unknown class><<Error class: unknown class>>

gtkGestureSinglePointer

val gtkGestureSinglePointer: <Error class: unknown class><<Error class: unknown class>>

gtkGestureSwipePointer

val gtkGestureSwipePointer: <Error class: unknown class><<Error class: unknown class>>

name

open var name: String?

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

propagationLimit

open var propagationLimit: PropagationLimit

The limit for which events this controller will handle.

propagationPhase

open var propagationPhase: PropagationPhase

The propagation phase at which this controller will handle events.

touchOnly

open var touchOnly: Boolean

Whether the gesture handles only touch events.

widget

open val widget: Widget?

The widget receiving the GdkEvents that the controller will handle.

Functions

emitBegin

fun emitBegin(sequence: <Error class: unknown class>?)

Emits the "begin" signal. See onBegin.

emitCancel

fun emitCancel(sequence: <Error class: unknown class>?)

Emits the "cancel" signal. See onCancel.

emitEnd

fun emitEnd(sequence: <Error class: unknown class>?)

Emits the "end" signal. See onEnd.

emitSequenceStateChanged

fun emitSequenceStateChanged(sequence: <Error class: unknown class>?, state: EventSequenceState)

Emits the "sequence-state-changed" signal. See onSequenceStateChanged.

emitSwipe

fun emitSwipe(velocityX: <Error class: unknown class>, velocityY: <Error class: unknown class>)

Emits the "swipe" signal. See onSwipe.

emitUpdate

fun emitUpdate(sequence: <Error class: unknown class>?)

Emits the "update" signal. See onUpdate.

getBoundingBox

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.

getCurrentButton

open fun getCurrentButton(): <Error class: unknown class>

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

getCurrentEvent

open fun getCurrentEvent(): <Error class: unknown class>?

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

getCurrentEventDevice

open fun getCurrentEventDevice(): <Error class: unknown class>?

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

getCurrentEventState

open fun getCurrentEventState(): <Error class: unknown class>

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

getCurrentEventTime

open fun getCurrentEventTime(): <Error class: unknown class>

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

getCurrentSequence

open fun getCurrentSequence(): <Error class: unknown class>?

Returns the event sequence currently interacting with @gesture.

getDevice

open fun getDevice(): <Error class: unknown class>?

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

getGroup

open fun getGroup(): <Error class: unknown class>

Returns all gestures in the group of @gesture

getLastEvent

open fun getLastEvent(sequence: <Error class: unknown class>? = null): <Error class: unknown class>?

Returns the last event that was processed for @sequence.

getLastUpdatedSequence

open fun getLastUpdatedSequence(): <Error class: unknown class>?

Returns the GdkEventSequence that was last updated on @gesture.

getSequences

open fun getSequences(): <Error class: unknown class>

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

getSequenceState

open fun getSequenceState(sequence: <Error class: unknown class>): EventSequenceState

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

group

open fun group(gesture: Gesture)

Adds @gesture to the same group than @group_gesture.

handlesSequence

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

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

isActive

open fun isActive(): Boolean

Returns true if the gesture is currently active.

isGroupedWith

open fun isGroupedWith(other: Gesture): Boolean

Returns true if both gestures pertain to the same group.

isRecognized

open fun isRecognized(): Boolean

Returns true if the gesture is currently recognized.

onBegin

fun onBegin( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>?) -> Unit): <Error class: unknown class>

Emitted when the gesture is recognized.

onCancel

fun onCancel( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>?) -> Unit): <Error class: unknown class>

Emitted whenever a sequence is cancelled.

onEnd

fun onEnd( 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.

onSequenceStateChanged

fun onSequenceStateChanged( 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.

onSwipe

fun onSwipe( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>) -> Unit): <Error class: unknown class>

Emitted when the recognized gesture is finished.

onUpdate

fun onUpdate( 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.

reset

open fun reset()

Resets the @controller to a clean state.

setSequenceState

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

This is deprecated since version 4.10..

setState

open fun setState(state: EventSequenceState): Boolean

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

setStaticName

open fun setStaticName(name: String? = null)

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

ungroup

open fun ungroup()

Separates @gesture into an isolated group.