DISTRHO Plugin Framework
Public Member Functions | Public Attributes | List of all members
Widget::ScrollEvent Struct Reference

#include <Widget.hpp>

Inheritance diagram for Widget::ScrollEvent:
Widget::BaseEvent

Public Member Functions

 ScrollEvent () noexcept
 
- Public Member Functions inherited from Widget::BaseEvent
 BaseEvent () noexcept
 
virtual ~BaseEvent () noexcept
 

Public Attributes

Point< double > pos
 
Point< double > absolutePos
 
Point< double > delta
 
ScrollDirection direction
 
- Public Attributes inherited from Widget::BaseEvent
uint mod
 
uint flags
 
uint time
 

Detailed Description

Mouse scroll event.

The scroll distance is expressed in "lines", an arbitrary unit that corresponds to a single tick of a detented mouse wheel. For example, delta.y = 1.0 scrolls 1 line up. Some systems and devices support finer resolution and/or higher values for fast scrolls, so programs should handle any value gracefully.

See also
onScroll

Constructor & Destructor Documentation

◆ ScrollEvent()

Widget::ScrollEvent::ScrollEvent ( )
inlinenoexcept

Constructor for default/null values

Member Data Documentation

◆ pos

Point<double> Widget::ScrollEvent::pos

The widget-relative coordinates of the pointer.

◆ absolutePos

Point<double> Widget::ScrollEvent::absolutePos

The absolute coordinates of the pointer.

◆ delta

Point<double> Widget::ScrollEvent::delta

The scroll distance.

◆ direction

ScrollDirection Widget::ScrollEvent::direction

The direction of the scroll or "smooth".


The documentation for this struct was generated from the following file: