Interface

Gtk-4.0GtkEventControllerScrollSignalSignatures

interface SignalSignatures {
    decelerate: (arg0: number, arg1: number) => void;
    notify: (arg0: GObject.ParamSpec) => void;
    "notify::flags": (pspec: GObject.ParamSpec) => void;
    "notify::name": (pspec: GObject.ParamSpec) => void;
    "notify::propagation-limit": (pspec: GObject.ParamSpec) => void;
    "notify::propagation-phase": (pspec: GObject.ParamSpec) => void;
    "notify::widget": (pspec: GObject.ParamSpec) => void;
    scroll: (arg0: number, arg1: number) => boolean | void;
    "scroll-begin": () => void;
    "scroll-end": () => void;
}

Hierarchy (View Summary)

Index

Properties

decelerate: (arg0: number, arg1: number) => void

Emitted after scroll is finished if the Gtk.EventControllerScrollFlags.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.

"notify::flags": (pspec: GObject.ParamSpec) => void
"notify::name": (pspec: GObject.ParamSpec) => void
"notify::propagation-limit": (pspec: GObject.ParamSpec) => void
"notify::propagation-phase": (pspec: GObject.ParamSpec) => void
"notify::widget": (pspec: GObject.ParamSpec) => void
scroll: (arg0: number, arg1: number) => boolean | void

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

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

"scroll-begin": () => void

Signals that a new scrolling operation has begun.

It will only be emitted on devices capable of it.

"scroll-end": () => void

Signals that a scrolling operation has finished.

It will only be emitted on devices capable of it.

Properties - Inherited from Gtk.EventController.SignalSignatures

notify: (arg0: GObject.ParamSpec) => void

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 GObject.ParamFlags.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 GObject.ParamFlags.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][class@GObject.ParamSpec#parameter-names] as detail strings for the notify signal.