blob: 22c0b6e0c91969600e63cded7658bfa1af9da8ee (
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
/*
* 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
#include "input/joysticks/JoystickTypes.h"
#include <string>
class IKeymapEnvironment;
/*!
* \brief Interface for mapping buttons to Kodi actions
*
* \sa CJoystickUtils::MakeKeyName
*/
class IKeymap
{
public:
virtual ~IKeymap() = default;
/*!
* \brief The controller ID
*
* This is required because key names are specific to each controller
*/
virtual std::string ControllerID() const = 0;
/*!
* \brief Access properties of the keymapping environment
*/
virtual const IKeymapEnvironment* Environment() const = 0;
/*!
* \brief Get the actions for a given key name
*
* \param keyName The key name created by CJoystickUtils::MakeKeyName()
*
* \return A list of actions associated with the given key
*/
virtual const KODI::JOYSTICK::KeymapActionGroup& GetActions(const std::string& keyName) const = 0;
};
/*!
* \brief Interface for mapping buttons to Kodi actions for specific windows
*
* \sa CJoystickUtils::MakeKeyName
*/
class IWindowKeymap
{
public:
virtual ~IWindowKeymap() = default;
/*!
* \brief The controller ID
*
* This is required because key names are specific to each controller
*/
virtual std::string ControllerID() const = 0;
/*!
* \brief Add an action to the keymap for a given key name and window ID
*
* \param windowId The window ID to look up
* \param keyName The key name created by CJoystickUtils::MakeKeyName()
* \param action The action to map
*/
virtual void MapAction(int windowId,
const std::string& keyName,
KODI::JOYSTICK::KeymapAction action) = 0;
/*!
* \brief Get the actions for a given key name and window ID
*
* \param windowId The window ID to look up
* \param keyName The key name created by CJoystickUtils::MakeKeyName()
*
* \return A list of actions associated with the given key for the given window
*/
virtual const KODI::JOYSTICK::KeymapActionGroup& GetActions(int windowId,
const std::string& keyName) const = 0;
};
|
