GI.Gdk.Objects.ScrollEvent

An event related to a scrolling motion.

Exported types

newtype ScrollEvent

Memory-managed wrapper type.

Constructors

ScrollEvent (ManagedPtr ScrollEvent)

Instances

Eq ScrollEvent

Defined in GI.Gdk.Objects.ScrollEvent

Methods

(==) :: ScrollEvent -> ScrollEvent -> Bool

(/=) :: ScrollEvent -> ScrollEvent -> Bool

BoxedPtr ScrollEvent

Defined in GI.Gdk.Objects.ScrollEvent

Methods

boxedPtrCopy :: ScrollEvent -> IO ScrollEvent

boxedPtrFree :: ScrollEvent -> IO ()

ManagedPtrNewtype ScrollEvent

Defined in GI.Gdk.Objects.ScrollEvent

Methods

toManagedPtr :: ScrollEvent -> ManagedPtr ScrollEvent

TypedObject ScrollEvent

Defined in GI.Gdk.Objects.ScrollEvent

Methods

glibType :: IO GType

HasParentTypes ScrollEvent

Defined in GI.Gdk.Objects.ScrollEvent

type ParentTypes ScrollEvent

Defined in GI.Gdk.Objects.ScrollEvent

type ParentTypes ScrollEvent = '[Event]

class (BoxedPtr o, TypedObject o, IsDescendantOf ScrollEvent o) => IsScrollEvent o

Type class for types which can be safely cast to ScrollEvent, for instance with toScrollEvent.

Instances

(BoxedPtr o, TypedObject o, IsDescendantOf ScrollEvent o) => IsScrollEvent o

Defined in GI.Gdk.Objects.ScrollEvent

toScrollEvent :: (MonadIO m, IsScrollEvent o) => o -> m ScrollEvent

Cast to ScrollEvent, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

isStop, ref, triggersContextMenu, unref.

Getters

getAxes, getAxis, getDeltas, getDevice, getDeviceTool, getDirection, getDisplay, getEventSequence, getEventType, getHistory, getModifierState, getPointerEmulated, getPosition, getSeat, getSurface, getTime, getUnit.

Setters

None.

getDeltas

scrollEventGetDeltas

Arguments

:: (HasCallStack, MonadIO m, IsScrollEvent a)

=> a

event: a scroll event

-> m (Double, Double)

Extracts the scroll deltas of a scroll event.

The deltas will be zero unless the scroll direction is ScrollDirectionSmooth.

For the representation unit of these deltas, see scrollEventGetUnit.

getDirection

scrollEventGetDirection

Arguments

:: (HasCallStack, MonadIO m, IsScrollEvent a)

=> a

event: a scroll event

-> m ScrollDirection

Returns: the scroll direction of event

Extracts the direction of a scroll event.

getUnit

scrollEventGetUnit

Arguments

:: (HasCallStack, MonadIO m, IsScrollEvent a)

=> a

event: a scroll event.

-> m ScrollUnit

Returns: the scroll unit.

Extracts the scroll delta unit of a scroll event.

The unit will always be ScrollUnitWheel if the scroll direction is not ScrollDirectionSmooth.

Since: 4.8

isStop

scrollEventIsStop

Arguments

:: (HasCallStack, MonadIO m, IsScrollEvent a)

=> a

event: a scroll event

-> m Bool

Returns: True if the event is a scroll stop event

Check whether a scroll event is a stop scroll event.

Scroll sequences with smooth scroll information may provide a stop scroll event once the interaction with the device finishes, e.g. by lifting a finger. This stop scroll event is the signal that a widget may trigger kinetic scrolling based on the current velocity.

Stop scroll events always have a delta of 0/0.