ArtisanKit.ScrollEvent

A more detailed set of information about the current scrolling status.

Constructors

LineHeight As Integer, DeltaX As Integer, DeltaY As Integer

Must be created from within a RectControl.MouseWheel event! Calculates values and status given the provided deltas and line height.

Properties

LineHeight As Integer // Read Only

The number of pixels moved by a single "step" of a traditional scroll wheel.

MomentumPhase As Integer // Read Only

See [NSEvent momentumPhase] for more information. Possible return values are any the Phase constants.

Phase As Integer // Read Only

See [NSEvent phase] for more information. Possible return values are any of the Phase constants.

The value returned indicates the user's finger state on the trackpad or mouse. This only applies for gesture-based input devices. All other devices will always return PhaseNone. For example, PhaseMayBegin should be returned when the user has placed their fingers on a trackpad, but has not yet moved them to cause a scroll.

By combining the various phases, it should be possible to build a "snap-back" or "rubber band" form of scrolling that is now familiar on OS X and iOS.

ScrollX As Integer // Read Only

Number of pixels to adjust the horizontal scroll position.

ScrollY As Integer // Read Only

Number of pixels to adjust the vertical scroll position.

Constants

Const PhaseBegan = 1
Const PhaseCancelled = 16
Const PhaseChanged = 4
Const PhaseEnded = 8
Const PhaseMayBegin = 32
Const PhaseNone = 0
Const PhaseStationary = 2