summaryrefslogtreecommitdiffstats
path: root/xbmc/input/keyboard/interfaces/IKeyboardDriverHandler.h
blob: 828f0a984cb81b8cb46358405a93e78cbcbae282 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
/*
 *  Copyright (C) 2015-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

class CKey;

namespace KODI
{
namespace KEYBOARD
{
/*!
 * \ingroup keyboard
 * \brief Interface for handling keyboard events
 */
class IKeyboardDriverHandler
{
public:
  virtual ~IKeyboardDriverHandler() = default;

  /*!
   * \brief A key has been pressed
   *
   * \param key The pressed key
   *
   * \return True if the event was handled, false otherwise
   */
  virtual bool OnKeyPress(const CKey& key) = 0;

  /*!
   * \brief A key has been released
   *
   * \param key The released key
   */
  virtual void OnKeyRelease(const CKey& key) = 0;
};
} // namespace KEYBOARD
} // namespace KODI