gtk4/org.gtkkn.bindings.gtk/EventControllerMotion

EventControllerMotion

open class EventControllerMotion( val gtkEventControllerMotionPointer: <Error class: unknown class><<Error class: unknown class>>) : EventController(source)

GtkEventControllerMotion is an event controller tracking the pointer position.

The event controller offers signal@Gtk.EventControllerMotion::enter and signal@Gtk.EventControllerMotion::leave signals, as well as property@Gtk.EventControllerMotion:is-pointer and property@Gtk.EventControllerMotion:contains-pointer properties which are updated to reflect changes in the pointer position as it moves over the widget.

Skipped during bindings generation

method contains-pointer: Property has no getter nor setter
method is-pointer: Property has no getter nor setter

Constructors

EventControllerMotion

constructor()

Creates a new event controller that will handle motion events.

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

Types

Companion

object Companion

Properties

gtkEventControllerMotionPointer

val gtkEventControllerMotionPointer: <Error class: unknown class><<Error class: unknown class>>

gtkEventControllerPointer

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

widget

open val widget: Widget?

The widget receiving the GdkEvents that the controller will handle.

Functions

containsPointer

open fun containsPointer(): Boolean

Returns if a pointer is within @self or one of its children.

emitEnter

fun emitEnter(x: <Error class: unknown class>, y: <Error class: unknown class>)

Emits the "enter" signal. See onEnter.

emitLeave

fun emitLeave()

Emits the "leave" signal. See onLeave.

emitMotion

fun emitMotion(x: <Error class: unknown class>, y: <Error class: unknown class>)

Emits the "motion" signal. See onMotion.

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.

isPointer

open fun isPointer(): Boolean

Returns if a pointer is within @self, but not one of its children.

onEnter

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

Signals that the pointer has entered the widget.

onLeave

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

Signals that the pointer has left the widget.

onMotion

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

Emitted when the pointer moves inside the widget.

reset

open fun reset()

Resets the @controller to a clean state.

setStaticName

open fun setStaticName(name: String? = null)

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