gtk.event_controller_scroll

Module for [EventControllerScroll] class

class EventControllerScroll EventControllerScrollGidBuilder EventControllerScrollGidBuilderImpl

Types 3

classEventControllerScroll : gtk.event_controller.EventController

[gtk.event_controller_scroll.EventControllerScroll] is an event controller that handles scroll events.

It is capable of handling both discrete and continuous scroll events from mice or touchpads, abstracting them both with the [gtk.event_controller_scroll.EventControllerScroll.scroll] signal. Deltas in the discrete case are multiples of 1.

In the case of continuous scroll events, [gtk.event_controller_scroll.EventControllerScroll] encloses all [gtk.event_controller_scroll.EventControllerScroll.scroll] emissions between two [gtk.event_controller_scroll.EventControllerScroll.scroll] and [gtk.event_controller_scroll.EventControllerScroll.scroll] signals.

The behavior of the event controller can be modified by the flags given at creation time, or modified at a later point through [gtk.event_controller_scroll.EventControllerScroll.setFlags] (e.g. because the scrolling conditions of the widget changed).

The controller can be set up to emit motion for either/both vertical and horizontal scroll events through [gtk.types.EventControllerScrollFlags.Vertical], [gtk.types.EventControllerScrollFlags.Horizontal] and [gtk.types.EventControllerScrollFlags.BothAxes]. If any axis is disabled, the respective [gtk.event_controller_scroll.EventControllerScroll.scroll] delta will be 0. Vertical scroll events will be translated to horizontal motion for the devices incapable of horizontal scrolling.

The event controller can also be forced to emit discrete events on all devices through [gtk.types.EventControllerScrollFlags.Discrete]. This can be used to implement discrete actions triggered through scroll events (e.g. switching across combobox options).

The [gtk.types.EventControllerScrollFlags.Kinetic] flag toggles the emission of the [gtk.event_controller_scroll.EventControllerScroll.decelerate] signal, emitted at the end of scrolling with two X/Y velocity arguments that are consistent with the motion that was received.

Methods

GType _getGType()

GType _gType() @property

EventControllerScroll self()Returns `this`, for use in `with` statements.

EventControllerScrollGidBuilder builder()Get builder for [gtk.eventcontrollerscroll.EventControllerScroll] Returns: New builder object

gtk.types.EventControllerScrollFlags flags() @propertyGet `flags` property. Returns: The flags affecting event controller behavior.

void flags(gtk.types.EventControllerScrollFlags propval) @propertySet `flags` property. Params: propval = The flags affecting event controller behavior.

gtk.types.EventControllerScrollFlags getFlags()Gets the flags conditioning the scroll controller behavior. Returns: the controller flags.

gdk.types.ScrollUnit getUnit()Gets the scroll unit of the last [gtk.eventcontrollerscroll.EventControllerScroll.scroll] signal received.

void setFlags(gtk.types.EventControllerScrollFlags flags)Sets the flags conditioning scroll controller behavior.

gulong connectDecelerate(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  double)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  double)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  gtk.event_controller_scroll.EventControllerScroll)))
   &&  Parameters!T.length <  4)

Connect to `Decelerate` signal.

gulong connectScroll(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  bool)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  double)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  double)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  gtk.event_controller_scroll.EventControllerScroll)))
   &&  Parameters!T.length <  4)

Connect to `Scroll` signal.

gulong connectScrollBegin(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.event_controller_scroll.EventControllerScroll)))
   &&  Parameters!T.length <  2)

Connect to `ScrollBegin` signal.

gulong connectScrollEnd(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.event_controller_scroll.EventControllerScroll)))
   &&  Parameters!T.length <  2)

Connect to `ScrollEnd` signal.

Constructors

this(void * ptr, Flag!"Take" take)

this(gtk.types.EventControllerScrollFlags flags)Creates a new event controller that will handle scroll events.

classEventControllerScrollGidBuilderImpl(T) : gtk.event_controller.EventControllerGidBuilderImpl!T

Methods

T flags(gtk.types.EventControllerScrollFlags propval)Set `flags` property. Params: propval = The flags affecting event controller behavior. Returns: Builder instance for fluent chaining

classEventControllerScrollGidBuilder : EventControllerScrollGidBuilderImpl!EventControllerScrollGidBuilder

Fluent builder for [gtk.event_controller_scroll.EventControllerScroll]

Methods

EventControllerScroll build()