summaryrefslogtreecommitdiffstats
path: root/xbmc/input/keyboard/interfaces/IActionMap.h
blob: e77643e00f2d550dbb81047ae4ca981dff645fe3 (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
/*
 *  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

class CKey;

namespace KODI
{
namespace KEYBOARD
{
/*!
 * \brief Interface for translating keys to action IDs
 */
class IActionMap
{
public:
  virtual ~IActionMap() = default;

  /*!
   * \brief Get the action ID mapped to the specified key
   *
   * \param key The key to look up
   *
   * \return The action ID from ActionIDs.h, or ACTION_NONE if no action is
   *         mapped to the specified key
   */
  virtual unsigned int GetActionID(const CKey& key) = 0;
};
} // namespace KEYBOARD
} // namespace KODI