SCENE C++ API  2.0.27
Public Member Functions | List of all members
LSMouseWheelEvent Class Reference

The LSMouseWheelEvent class represent events triggered by a mouse wheel. More...

#include <lsmousewheelevent.h>

+ Inheritance diagram for LSMouseWheelEvent:

Public Member Functions

 LSMouseWheelEvent (ref_ptr< LSView > view, unsigned flags, POINT point, short delta)
 Constructor. More...
 
short getDelta () const
 Get the delta value representing the scrolled distance. More...
 
- Public Member Functions inherited from LSMouseEvent
 LSMouseEvent (ref_ptr< LSView > view, unsigned flags, POINT point)
 Constructor. More...
 
unsigned getFlags () const
 Get the flags which indicate whether virtual keys are down. More...
 
POINT getPoint () const
 Get the the x- and y- coordinate of the cursor. More...
 
- Public Member Functions inherited from LSViewEvent
 LSViewEvent (ref_ptr< LSView > view)
 Constructor. More...
 
ref_ptr< LSViewgetView () const
 Gets the view instance for which the event is triggered. More...
 
- Public Member Functions inherited from LSEvent
 LSEvent ()
 Constructor. More...
 
virtual ~LSEvent ()
 Destructor. More...
 
bool isConsumed () const
 Query whether this event has been consumed. More...
 
void consume ()
 Consumes this event if the event can be consumed. More...
 

Additional Inherited Members

- Protected Member Functions inherited from LSRefType
void ref () const
 Increments the internal reference counter. More...
 
void unref () const
 Decrements the internal reference counter. More...
 

Detailed Description

The LSMouseWheelEvent class represent events triggered by a mouse wheel.

Version
SCENE API Version 2.0.0.

Constructor & Destructor Documentation

◆ LSMouseWheelEvent()

LSMouseWheelEvent ( ref_ptr< LSView view,
unsigned  flags,
POINT  point,
short  delta 
)

Constructor.

Parameters
viewThe view for which the event was triggered
flagsIndicates whether various virtual keys are down.
pointSpecifies the x- and y-coordinate of the cursor.
deltaIndicates the scrolled distance.
Version
SCENE API Version 2.0.0.

Member Function Documentation

◆ getDelta()

short getDelta ( ) const

Get the delta value representing the scrolled distance.

Returns
The delta value representing the scrolled distance.
Version
SCENE API Version 2.0.0.