Interface: GtkEventControllerScrollProps

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

Props for the GtkEventControllerScroll controller element.

Extends

• EventControllerBaseProps

Properties

children?

optional children: ReactNode

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

Inherited from

EventControllerBaseProps.children

---

flags?

optional flags: EventControllerScrollFlags

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

The flags affecting event controller behavior.

---

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

EventControllerBaseProps.name

---

onDecelerate()?

optional onDecelerate: (velX, velY, self) => void | null

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

Emitted after scroll is finished if the %GTK_EVENT_CONTROLLER_SCROLL_KINETIC flag is set.

vel_x and vel_y express the initial velocity that was imprinted by the scroll events. vel_x and vel_y are expressed in pixels/ms.

Parameters

Parameter	Type
velX	number
velY	number
self	EventControllerScroll

Returns

void | null

---

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

EventControllerBaseProps.onNotify

---

onScroll()?

optional onScroll: (dx, dy, self) => boolean | null

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

Signals that the widget should scroll by the amount specified by dx and dy.

For the representation unit of the deltas, see EventControllerScroll.get_unit.

Parameters

Parameter	Type
dx	number
dy	number
self	EventControllerScroll

Returns

boolean | null

---

onScrollBegin()?

optional onScrollBegin: (self) => void | null

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

Signals that a new scrolling operation has begun.

It will only be emitted on devices capable of it.

Parameters

Parameter	Type
self	EventControllerScroll

Returns

void | null

---

onScrollEnd()?

optional onScrollEnd: (self) => void | null

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

Signals that a scrolling operation has finished.

It will only be emitted on devices capable of it.

Parameters

Parameter	Type
self	EventControllerScroll

Returns

void | null

---

propagationLimit?

optional propagationLimit: PropagationLimit

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

The limit for which events this controller will handle.

Inherited from

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

EventControllerBaseProps.propagationPhase

---

ref?

optional ref: Ref<EventControllerScroll>

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