kodi
Public Member Functions | List of all members
KODI::MOUSE::IMouseDriverHandler Class Referenceabstract

Interface for handling mouse driver events. More...

#include <IMouseDriverHandler.h>

Inheritance diagram for KODI::MOUSE::IMouseDriverHandler:
Inheritance graph
[legend]

Public Member Functions

virtual bool OnPosition (int x, int y)=0
 Handle mouse position updates. More...
 
virtual bool OnButtonPress (BUTTON_ID button)=0
 A mouse button has been pressed. More...
 
virtual void OnButtonRelease (BUTTON_ID button)=0
 A mouse button has been released. More...
 

Detailed Description

Interface for handling mouse driver events.

Member Function Documentation

◆ OnButtonPress()

virtual bool KODI::MOUSE::IMouseDriverHandler::OnButtonPress ( BUTTON_ID  button)
pure virtual

A mouse button has been pressed.

Parameters
buttonThe index of the pressed button
Returns
True if the event was handled, otherwise false

Implemented in KODI::JOYSTICK::CButtonMapping, KODI::GAME::CAgentInput, PERIPHERALS::CAddonInputHandling, PERIPHERALS::CAddonButtonMapping, KODI::MOUSE::CDefaultMouseHandling, PERIPHERALS::CPeripheralMouse, and KODI::MOUSE::CMouseInputHandling.

◆ OnButtonRelease()

virtual void KODI::MOUSE::IMouseDriverHandler::OnButtonRelease ( BUTTON_ID  button)
pure virtual

◆ OnPosition()

virtual bool KODI::MOUSE::IMouseDriverHandler::OnPosition ( int  x,
int  y 
)
pure virtual

Handle mouse position updates.

Parameters
xThe new x coordinate of the pointer
yThe new y coordinate of the pointer

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, false otherwise

Implemented in KODI::JOYSTICK::CButtonMapping, KODI::GAME::CAgentInput, PERIPHERALS::CAddonInputHandling, PERIPHERALS::CAddonButtonMapping, KODI::MOUSE::CDefaultMouseHandling, PERIPHERALS::CPeripheralMouse, and KODI::MOUSE::CMouseInputHandling.


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