EventControllerScrollRef

public struct EventControllerScrollRef : EventControllerScrollProtocol, GWeakCapturing

GtkEventControllerScroll 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 [signalGtk.EventControllerScroll::scroll] signal. Deltas in the discrete case are multiples of 1.

In the case of continuous scroll events, GtkEventControllerScroll encloses all [signalGtk.EventControllerScroll::scroll] emissions between two [signalGtk.EventControllerScroll::scroll-begin] and [signalGtk.EventControllerScroll::scroll-end] signals.

The behavior of the event controller can be modified by the flags given at creation time, or modified at a later point through methodGtk.EventControllerScroll.set_flags.

The controller can be set up to emit motion for either/both vertical and horizontal scroll events through GTK_EVENT_CONTROLLER_SCROLL_VERTICAL, GTK_EVENT_CONTROLLER_SCROLL_HORIZONTAL and GTK_EVENT_CONTROLLER_SCROLL_BOTH_AXES. If any axis is disabled, the respective [signalGtk.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_EVENT_CONTROLLER_SCROLL_DISCRETE. This can be used to implement discrete actions triggered through scroll events (e.g. switching across combobox options).

The GTK_EVENT_CONTROLLER_SCROLL_KINETIC flag toggles the emission of the [signalGtk.EventControllerScroll::decelerate] signal, emitted at the end of scrolling with two X/Y velocity arguments that are consistent with the motion that was received.

The EventControllerScrollRef type acts as a lightweight Swift reference to an underlying GtkEventControllerScroll instance. It exposes methods that can operate on this data type through EventControllerScrollProtocol conformance. Use EventControllerScrollRef only as an unowned reference to an existing GtkEventControllerScroll instance.

Show on GitHub

ptr
```
Untyped pointer to the underlying `GtkEventControllerScroll` instance.
```
For type-safe access, use the generated, typed pointer event_controller_scroll_ptr property instead.
Declaration
Swift

public let ptr: UnsafeMutableRawPointer!
Show on GitHub

EventControllerScroll Class

init(_:)
Designated initialiser from the underlying C data type
Declaration
Swift

@inlinable init(_ p: UnsafeMutablePointer<GtkEventControllerScroll>)
Show on GitHub
init(_:)
Designated initialiser from a constant pointer to the underlying C data type
Declaration
Swift

@inlinable init(_ p: UnsafePointer<GtkEventControllerScroll>)
Show on GitHub
init(_:)
Conditional initialiser from an optional pointer to the underlying C data type
Declaration
Swift

@inlinable init!(_ maybePointer: UnsafeMutablePointer<GtkEventControllerScroll>?)
Show on GitHub
init(_:)
Conditional initialiser from an optional, non-mutable pointer to the underlying C data type
Declaration
Swift

@inlinable init!(_ maybePointer: UnsafePointer<GtkEventControllerScroll>?)
Show on GitHub
init(gpointer:)
Conditional initialiser from an optional gpointer
Declaration
Swift

@inlinable init!(gpointer g: gpointer?)
Show on GitHub
init(gconstpointer:)
Conditional initialiser from an optional, non-mutable gconstpointer
Declaration
Swift

@inlinable init!(gconstpointer g: gconstpointer?)
Show on GitHub
init(_:)
Reference intialiser for a related type that implements EventControllerScrollProtocol
Declaration
Swift

@inlinable init<T>(_ other: T) where T : EventControllerScrollProtocol
Show on GitHub


                    
                    
                    unowned(_:)

This factory is syntactic sugar for setting weak pointers wrapped in GWeak<T>

Declaration

Swift

@inlinable
static func unowned<T>(_ other: T) -> EventControllerScrollRef where T : EventControllerScrollProtocol

Show on GitHub

init(cPointer:)
Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventControllerScrollProtocol.
Declaration
Swift

@inlinable init<T>(cPointer: UnsafeMutablePointer<T>)
Show on GitHub
init(constPointer:)
Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventControllerScrollProtocol.
Declaration
Swift

@inlinable init<T>(constPointer: UnsafePointer<T>)
Show on GitHub
init(mutating:)
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventControllerScrollProtocol.
Declaration
Swift

@inlinable init(mutating raw: UnsafeRawPointer)
Show on GitHub
init(raw:)
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventControllerScrollProtocol.
Declaration
Swift

@inlinable init(raw: UnsafeMutableRawPointer)
Show on GitHub
init(opaquePointer:)
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to EventControllerScrollProtocol.
Declaration
Swift

@inlinable init(opaquePointer: OpaquePointer)
Show on GitHub
init(flags:)
Creates a new event controller that will handle scroll events.
Declaration
Swift

@inlinable init(flags: EventControllerScrollFlags)
Show on GitHub