#------------------------------------------------------------------------------- #--[Class Description]---------------------------------------------------------- #-------------------------------------------------------------------------------

=begin rakudoc

Description

An event related to a scrolling motion.

=end rakudoc

#------------------------------------------------------------------------------- #--[Class Initialization]------------------------------------------------------- #-------------------------------------------------------------------------------

=begin rakudoc

Class initialization

new

:native-object

Create an object using a native object from an object of the same type found elsewhere. See also Gnome::N::TopLevelSupportClass.

multi method new ( N-Object() :$native-object! )

=end rakudoc

#------------------------------------------------------------------------------- #--[Methods]-------------------------------------------------------------------- #-------------------------------------------------------------------------------

=begin rakudoc

Methods =end rakudoc

#------------------------------------------------------------------------------- =begin rakudoc

get-deltas

Extracts the scroll deltas of a scroll event.

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

For the representation unit of these deltas, see .get-unit().

method get-deltas ( Num() $delta-x, Num() $delta-y )

• $delta-x; (transfer ownership: full) return location for x scroll delta.

• $delta-y; (transfer ownership: full) return location for y scroll delta.

=end rakudoc

#------------------------------------------------------------------------------- =begin rakudoc

get-direction This function is not yet available

Extracts the direction of a scroll event.

method get-direction (--> GdkScrollDirection  )

Return value; the scroll direction of $event.

=end rakudoc

#------------------------------------------------------------------------------- =begin rakudoc

get-unit This function is not yet available

Extracts the scroll delta unit of a scroll event.

The unit will always be GDK_SCROLL_UNIT_WHEEL if the scroll direction is not GDK_SCROLL_SMOOTH.

method get-unit (--> GdkScrollUnit  )

Return value; the scroll unit..

=end rakudoc

#------------------------------------------------------------------------------- =begin rakudoc

is-stop

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.

method is-stop (--> Bool )

Return value; True if the event is a scroll stop event.

=end rakudoc