gtk4/org.gtkkn.bindings.gtk/GesturePan

GesturePan

open class GesturePan(pointer: <Error class: unknown class><<Error class: unknown class>>) : GestureDrag

GtkGesturePan is a GtkGesture for pan gestures.

These 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 method@Gtk.GesturePan.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 signal@Gtk.GesturePan::pan signal will be emitted as input events are received, containing the offset in the given axis.

Constructors

GesturePan

constructor(orientation: Orientation)

Returns a newly created GtkGesture that recognizes pan gestures.

constructor(pointer: <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>>

gtkGestureDragPointer

val gtkGestureDragPointer: <Error class: unknown class><<Error class: unknown class>>

gtkGesturePanPointer

val gtkGesturePanPointer: <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>>

name

open var name: String?

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

orientation

open var orientation: Orientation

The expected orientation of pan gestures.

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

connectBegin

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.

connectCancel

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.

connectDragBegin

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

Emitted whenever dragging starts.

connectDragEnd

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

Emitted whenever the dragging is finished.

connectDragUpdate

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

Emitted whenever the dragging point moves.

connectEnd

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.

connectPan

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

Emitted once a panning gesture along the expected axis is detected.

connectSequenceStateChanged

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.

connectUpdate

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.

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.