summaryrefslogtreecommitdiffstats
path: root/xbmc/input/keyboard/interfaces/IKeyboardInputProvider.h
diff options
context:
space:
mode:
Diffstat (limited to 'xbmc/input/keyboard/interfaces/IKeyboardInputProvider.h')
-rw-r--r--xbmc/input/keyboard/interfaces/IKeyboardInputProvider.h43
1 files changed, 43 insertions, 0 deletions
diff --git a/xbmc/input/keyboard/interfaces/IKeyboardInputProvider.h b/xbmc/input/keyboard/interfaces/IKeyboardInputProvider.h
new file mode 100644
index 0000000..5d964d5
--- /dev/null
+++ b/xbmc/input/keyboard/interfaces/IKeyboardInputProvider.h
@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2017-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
+
+namespace KODI
+{
+namespace KEYBOARD
+{
+class IKeyboardInputHandler;
+
+/*!
+ * \ingroup mouse
+ * \brief Interface for classes that can provide keyboard input
+ */
+class IKeyboardInputProvider
+{
+public:
+ virtual ~IKeyboardInputProvider() = default;
+
+ /*!
+ * \brief Registers a handler to be called on keyboard input
+ *
+ * \param handler The handler to receive keyboard input provided by this class
+ * \param bPromiscuous True to observe all events without affecting the
+ * input's destination
+ */
+ virtual void RegisterKeyboardHandler(IKeyboardInputHandler* handler, bool bPromiscuous) = 0;
+
+ /*!
+ * \brief Unregisters handler from keyboard input
+ *
+ * \param handler The handler that was receiving keyboard input
+ */
+ virtual void UnregisterKeyboardHandler(IKeyboardInputHandler* handler) = 0;
+};
+} // namespace KEYBOARD
+} // namespace KODI