Interface for handling mouse events. More...
#include <IMouseInputHandler.h>
Inheritance diagram for KODI::MOUSE::IMouseInputHandler:
Public Member Functions | |
| virtual std::string | ControllerID (void) const =0 |
| The controller profile for this mouse input handler. More... | |
| virtual bool | OnMotion (const PointerName &relpointer, int dx, int dy)=0 |
| A relative pointer has moved. More... | |
| virtual bool | OnButtonPress (const ButtonName &button)=0 |
| A mouse button has been pressed. More... | |
| virtual void | OnButtonRelease (const ButtonName &button)=0 |
| A mouse button has been released. More... | |
Detailed Description
Interface for handling mouse events.
Member Function Documentation
◆ ControllerID()
|
pure virtual |
The controller profile for this mouse input handler.
- Returns
- The ID of the add-on extending kodi.game.controller
Implemented in KODI::GAME::CGameClientMouse.
◆ OnButtonPress()
|
pure virtual |
A mouse button has been pressed.
- Parameters
-
button The name of the feature being pressed
- Returns
- True if the event was handled, otherwise false
Implemented in KODI::GAME::CGameClientMouse.
◆ OnButtonRelease()
|
pure virtual |
A mouse button has been released.
- Parameters
-
button The name of the feature being released
Implemented in KODI::GAME::CGameClientMouse.
◆ OnMotion()
|
pure virtual |
A relative pointer has moved.
- Parameters
-
relpointer The name of the relative pointer being moved dx The relative x coordinate of motion dy The relative y coordinate of motion
The mouse uses a left-handed (graphics) cartesian coordinate system. Positive X is right, positive Y is down.
- Returns
- True if the event was handled, otherwise false
Implemented in KODI::GAME::CGameClientMouse.
The documentation for this class was generated from the following file:
- xbmc/input/mouse/interfaces/IMouseInputHandler.h
