gtk4/org.gtkkn.bindings.gtk/GestureStylus

GestureStylus

open class GestureStylus(val gtkGestureStylusPointer: <Error class: unknown class><<Error class: unknown class>>) : GestureSingle(source)

GtkGestureStylus is a GtkGesture specific to stylus input.

The provided signals just relay the basic information of the stylus events.

Skipped during bindings generation

  • parameter axes: Array parameter of type Gdk.AxisUse is not supported

  • parameter value: value: Out parameter is not supported

  • parameter backlog: backlog: Out parameter is not supported

Constructors

Link copied to clipboard
constructor()

Creates a new GtkGestureStylus.

constructor(gtkGestureStylusPointer: <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
val gtkGestureStylusPointer: <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 stylusOnly: Boolean

If this gesture should exclusively react to stylus input devices.

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 emitBegin(sequence: <Error class: unknown class>?)

Emits the "begin" signal. See onBegin.

Link copied to clipboard
fun emitCancel(sequence: <Error class: unknown class>?)

Emits the "cancel" signal. See onCancel.

Link copied to clipboard
fun emitDown(x: <Error class: unknown class>, y: <Error class: unknown class>)

Emits the "down" signal. See onDown.

Link copied to clipboard
fun emitEnd(sequence: <Error class: unknown class>?)

Emits the "end" signal. See onEnd.

Link copied to clipboard
fun emitMotion(x: <Error class: unknown class>, y: <Error class: unknown class>)

Emits the "motion" signal. See onMotion.

Link copied to clipboard
fun emitProximity(x: <Error class: unknown class>, y: <Error class: unknown class>)

Emits the "proximity" signal. See onProximity.

Link copied to clipboard
fun emitSequenceStateChanged(sequence: <Error class: unknown class>?, state: EventSequenceState)

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

Link copied to clipboard
fun emitUp(x: <Error class: unknown class>, y: <Error class: unknown class>)

Emits the "up" signal. See onUp.

Link copied to clipboard
fun emitUpdate(sequence: <Error class: unknown class>?)

Emits the "update" signal. See onUpdate.

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 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 getDeviceTool(): <Error class: unknown class>?

Returns the GdkDeviceTool currently driving input through this gesture.

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

Link copied to clipboard
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.

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

Emitted when the stylus touches the device.

Link copied to clipboard
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.

Link copied to clipboard
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 stylus moves while touching the device.

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

Emitted when the stylus is in proximity of the device.

Link copied to clipboard
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.

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

Emitted when the stylus no longer touches the device.

Link copied to clipboard
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.

Link copied to clipboard
open fun reset()

Resets the @controller to a clean state.

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

This is deprecated since version 4.10..

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 ungroup()

Separates @gesture into an isolated group.