Abstract base button class. More...
#include <PBtnToggleBase.h>
Inheritance diagram for PBtnToggleBase:
Public Member Functions | |
| PBtnToggleBase (int btn_pin, int pressed_state=HIGH) | |
| Create button instance. More... | |
| void | onPress (ToggleFunc callback) |
| Set optional callback function to be called on button press event. More... | |
| void | onLongPress (LongPressFunc callback) |
| Set optional callback function to be called on button long press event. More... | |
| void | onRelease (ToggleFunc callback) |
| Set optional callback function to be called on button release event. More... | |
| void | check () |
| Check button state and trigger event callback functions. More... | |
| int | getPin () |
| Get pin number. More... | |
Friends | |
| class | PBtnToggle |
| class | PBtnTogglePISO |
| class | PBtnTogglePISOController |
Detailed Description
Abstract base button class.
Constructor & Destructor Documentation
| PBtnToggleBase::PBtnToggleBase | ( | int | btn_pin, |
| int | pressed_state = HIGH |
||
| ) |
Create button instance.
- Parameters
-
btn_pin Pin where button is wired pressed_state Pin state when button is pressed. Value LOW or HIGH depends on wiring.
Member Function Documentation
| void PBtnToggleBase::check | ( | ) |
Check button state and trigger event callback functions.
This method must be called in loop()
| int PBtnToggleBase::getPin | ( | ) |
Get pin number.
| void PBtnToggleBase::onLongPress | ( | LongPressFunc | callback | ) |
Set optional callback function to be called on button long press event.
- Parameters
-
callback Callback function pointer
| void PBtnToggleBase::onPress | ( | ToggleFunc | callback | ) |
Set optional callback function to be called on button press event.
- Parameters
-
callback Callback function pointer
| void PBtnToggleBase::onRelease | ( | ToggleFunc | callback | ) |
Set optional callback function to be called on button release event.
- Parameters
-
callback Callback function pointer
Friends And Related Function Documentation
|
friend |
|
friend |
|
friend |
The documentation for this class was generated from the following files:
