Interface: GtkGesturePanProps

Defined in: packages/react/src/generated/jsx.ts:10276

Props for the GtkGesturePan controller element.

Extends

• GtkGestureDragProps

Properties

button?

optional button: number

Defined in: packages/react/src/generated/jsx.ts:10294

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

Inherited from

GtkGestureDragProps.button

---

children?

optional children: ReactNode

Defined in: packages/react/src/generated/jsx.ts:9842

Inherited from

GtkGestureDragProps.children

---

exclusive?

optional exclusive: boolean

Defined in: packages/react/src/generated/jsx.ts:10300

Whether the gesture is exclusive.

Exclusive gestures only listen to pointer and pointer emulated events.

Inherited from

GtkGestureDragProps.exclusive

---

name?

optional name: string | null

Defined in: packages/react/src/generated/jsx.ts:9809

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

Inherited from

GtkGestureDragProps.name

---

nPoints?

optional nPoints: number

Defined in: packages/react/src/generated/jsx.ts:10156

The number of touch points that trigger recognition on this gesture.

Inherited from

GtkGestureDragProps.nPoints

---

onBegin()?

optional onBegin: (sequence, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:10168

Emitted when the gesture is recognized.

This means the number of touch sequences matches Gesture.n-points.

Note: These conditions may also happen when an extra touch (eg. a third touch on a 2-touches gesture) is lifted, in that situation sequence won't pertain to the current set of active touches, so don't rely on this being true.

Parameters

Parameter	Type
sequence	EventSequence
self	Gesture

Returns

void | null

Inherited from

GtkGestureDragProps.onBegin

---

onCancel()?

optional onCancel: (sequence, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:10181

Emitted whenever a sequence is cancelled.

This usually happens on active touches when EventController.reset is called on gesture (manually, due to grabs...), or the individual sequence was claimed by parent widgets' controllers (see Gesture.set_sequence_state).

gesture must forget everything about sequence as in response to this signal.

Parameters

Parameter	Type
sequence	EventSequence
self	Gesture

Returns

void | null

Inherited from

GtkGestureDragProps.onCancel

---

onDragBegin()?

optional onDragBegin: (startX, startY, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:10250

Emitted whenever dragging starts.

Parameters

Parameter	Type
startX	number
startY	number
self	GestureDrag

Returns

void | null

Inherited from

GtkGestureDragProps.onDragBegin

---

onDragEnd()?

optional onDragEnd: (offsetX, offsetY, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:10252

Emitted whenever the dragging is finished.

Parameters

Parameter	Type
offsetX	number
offsetY	number
self	GestureDrag

Returns

void | null

Inherited from

GtkGestureDragProps.onDragEnd

---

onDragUpdate()?

optional onDragUpdate: (offsetX, offsetY, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:10254

Emitted whenever the dragging point moves.

Parameters

Parameter	Type
offsetX	number
offsetY	number
self	GestureDrag

Returns

void | null

Inherited from

GtkGestureDragProps.onDragUpdate

---

onEnd()?

optional onEnd: (sequence, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:10193

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 Gesture.n-points.

Note: sequence might not pertain to the group of sequences that were previously triggering recognition on gesture (ie. a just pressed touch sequence that exceeds Gesture.n-points). This situation may be detected by checking through Gesture.handles_sequence.

Parameters

Parameter	Type
sequence	EventSequence
self	Gesture

Returns

void | null

Inherited from

GtkGestureDragProps.onEnd

---

onNotify()?

optional onNotify: (pspec, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:9841

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with %G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass %G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

|[ g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view) ]|

It is important to note that you must use [canonical parameter names]GObjectParamSpec#parameter-names as detail strings for the notify signal.

Parameters

Parameter	Type
pspec	ParamSpec
self	EventController

Returns

void | null

Inherited from

GtkGestureDragProps.onNotify

---

onPan()?

optional onPan: (direction, offset, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:10280

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

Parameters

Parameter	Type
direction	PanDirection
offset	number
self	GesturePan

Returns

void | null

---

onSequenceStateChanged()?

optional onSequenceStateChanged: (sequence, state, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:10200

Emitted whenever a sequence state changes.

See Gesture.set_sequence_state to know more about the expectable sequence lifetimes.

Parameters

Parameter	Type
sequence	EventSequence
state	EventSequenceState
self	Gesture

Returns

void | null

Inherited from

GtkGestureDragProps.onSequenceStateChanged

---

onUpdate()?

optional onUpdate: (sequence, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:10210

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

sequence is guaranteed to pertain to the set of active touches.

Parameters

Parameter	Type
sequence	EventSequence
self	Gesture

Returns

void | null

Inherited from

GtkGestureDragProps.onUpdate

---

orientation?

optional orientation: Orientation

Defined in: packages/react/src/generated/jsx.ts:10278

The expected orientation of pan gestures.

---

propagationLimit?

optional propagationLimit: PropagationLimit

Defined in: packages/react/src/generated/jsx.ts:9811

The limit for which events this controller will handle.

Inherited from

GtkGestureDragProps.propagationLimit

---

propagationPhase?

optional propagationPhase: PropagationPhase

Defined in: packages/react/src/generated/jsx.ts:9813

The propagation phase at which this controller will handle events.

Inherited from

GtkGestureDragProps.propagationPhase

---

ref?

optional ref: Ref<GesturePan>

Defined in: packages/react/src/generated/jsx.ts:10281

Overrides

GtkGestureDragProps.ref

---

touchOnly?

optional touchOnly: boolean

Defined in: packages/react/src/generated/jsx.ts:10302

Whether the gesture handles only touch events.

Inherited from

GtkGestureDragProps.touchOnly