Outline ![]()
Files ![]()
loading...
CodeScope![]()
STM32 Libraries and Samples![]()
TouchGFX![]()
touchgfx/framework/include/platform/driver/button/ButtonController.hpp
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
/**
******************************************************************************
* This file is part of the TouchGFX 4.10.0 distribution.
*
* <h2><center>© Copyright (c) 2018 STMicroelectronics.
* All rights reserved.</center></h2>
*
* This software component is licensed by ST under Ultimate Liberty license
* SLA0044, the "License"; You may not use this file except in compliance with
* the License. You may obtain a copy of the License at:
* www.st.com/SLA0044
*
******************************************************************************
*/
#ifndef BUTTONCONTROLLER_HPP
#define BUTTONCONTROLLER_HPP
#include <touchgfx/hal/Types.hpp>
namespace touchgfx
{
/**
* @class ButtonController ButtonController.hpp platform/driver/button/ButtonController.hpp
*
* @brief Interface for sampling external key events.
*
* Interface for sampling external key events.
*/
class ButtonController
{
public:
/**
* @fn virtual ButtonController::~ButtonController()
*
* @brief Destructor.
*
* Destructor.
*/
virtual ~ButtonController()
{
}
/**
* @fn virtual void ButtonController::init() = 0;
*
* @brief Initializes button controller.
*
* Initializes button controller.
*/
virtual void init() = 0;
/**
* @fn virtual bool ButtonController::sample(uint8_t& key) = 0;
*
* @brief Sample external key events.
*
* Sample external key events.
*
* @param [in,out] key Output parameter that will be set to the key value if a keypress was
* detected.
*
* @return True if a keypress was detected and the "key" parameter is set to a value.
*/
virtual bool sample(uint8_t& key) = 0;
/**
* @fn virtual void reset()
*
* @brief Resets button controller.
*
* Resets button controller. Does nothing in the default implementation.
*
*/
virtual void reset() {}
};
} // namespace touchgfx
#endif // BUTTONCONTROLLER_HPP