summaryrefslogtreecommitdiffstats
path: root/xbmc/input/mouse/interfaces/IMouseDriverHandler.h
diff options
context:
space:
mode:
Diffstat (limited to 'xbmc/input/mouse/interfaces/IMouseDriverHandler.h')
-rw-r--r--xbmc/input/mouse/interfaces/IMouseDriverHandler.h56
1 files changed, 56 insertions, 0 deletions
diff --git a/xbmc/input/mouse/interfaces/IMouseDriverHandler.h b/xbmc/input/mouse/interfaces/IMouseDriverHandler.h
new file mode 100644
index 0000000..7989e39
--- /dev/null
+++ b/xbmc/input/mouse/interfaces/IMouseDriverHandler.h
@@ -0,0 +1,56 @@
+/*
+ * Copyright (C) 2016-2018 Team Kodi
+ * This file is part of Kodi - https://kodi.tv
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ * See LICENSES/README.md for more information.
+ */
+
+#pragma once
+
+#include "input/mouse/MouseTypes.h"
+
+namespace KODI
+{
+namespace MOUSE
+{
+/*!
+ * \ingroup mouse
+ * \brief Interface for handling mouse driver events
+ */
+class IMouseDriverHandler
+{
+public:
+ virtual ~IMouseDriverHandler(void) = default;
+
+ /*!
+ * \brief Handle mouse position updates
+ *
+ * \param x The new x coordinate of the pointer
+ * \param y The new y coordinate of the pointer
+ *
+ * The mouse uses a left-handed (graphics) cartesian coordinate system.
+ * Positive X is right, positive Y is down.
+ *
+ * \return True if the event was handled, false otherwise
+ */
+ virtual bool OnPosition(int x, int y) = 0;
+
+ /*!
+ * \brief A mouse button has been pressed
+ *
+ * \param button The index of the pressed button
+ *
+ * \return True if the event was handled, otherwise false
+ */
+ virtual bool OnButtonPress(BUTTON_ID button) = 0;
+
+ /*!
+ * \brief A mouse button has been released
+ *
+ * \param button The index of the released button
+ */
+ virtual void OnButtonRelease(BUTTON_ID button) = 0;
+};
+} // namespace MOUSE
+} // namespace KODI