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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* Copyright (C) 2005-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 <string>
#ifndef SWIG
class CKey;
/*!
\ingroup actionkeys
\brief class encapsulating information regarding a particular user action to be sent to windows
and controls
*/
class CAction
{
public:
CAction();
CAction(int actionID,
float amount1 = 1.0f,
float amount2 = 0.0f,
const std::string& name = "",
unsigned int holdTime = 0);
CAction(int actionID, wchar_t unicode);
CAction(int actionID,
unsigned int state,
float posX,
float posY,
float offsetX,
float offsetY,
float velocityX = 0.0f,
float velocityY = 0.0f,
const std::string& name = "");
CAction(int actionID, const std::string& name, const CKey& key);
CAction(int actionID, const std::string& name);
CAction(const CAction& other) { *this = other; }
CAction& operator=(const CAction& rhs);
/*! \brief Identifier of the action
\return id of the action
*/
int GetID() const { return m_id; }
/*! \brief Is this an action from the mouse
\return true if this is a mouse action, false otherwise
*/
bool IsMouse() const;
bool IsGesture() const;
/*! \brief Human-readable name of the action
\return name of the action
*/
const std::string& GetName() const { return m_name; }
/*! \brief Text of the action if any
\return text payload of this action.
*/
const std::string& GetText() const { return m_text; }
/*! \brief Set the text payload of the action
\param text to be set
*/
void SetText(const std::string& text) { m_text = text; }
/*! \brief Get an amount associated with this action
\param zero-based index of amount to retrieve, defaults to 0
\return an amount associated with this action
*/
float GetAmount(unsigned int index = 0) const
{
return (index < max_amounts) ? m_amount[index] : 0;
};
/*! \brief Reset all amount values to zero
*/
void ClearAmount();
/*! \brief Unicode value associated with this action
\return unicode value associated with this action, for keyboard input.
*/
wchar_t GetUnicode() const { return m_unicode; }
/*! \brief Time in ms that the key has been held
\return time that the key has been held down in ms.
*/
unsigned int GetHoldTime() const { return m_holdTime; }
/*! \brief Time since last repeat in ms
\return time since last repeat in ms. Returns 0 if unknown.
*/
float GetRepeat() const { return m_repeat; }
/*! \brief Button code that triggered this action
\return button code
*/
unsigned int GetButtonCode() const { return m_buttonCode; }
bool IsAnalog() const;
private:
int m_id;
std::string m_name;
static const unsigned int max_amounts = 6; // Must be at least 6
float m_amount[max_amounts] = {};
float m_repeat = 0.0f;
unsigned int m_holdTime = 0;
unsigned int m_buttonCode = 0;
wchar_t m_unicode = 0;
std::string m_text;
};
#endif
|
