Clean up ResettableButton rename.

Author: lendres

README.md

@@ -33,20 +33,20 @@ Turns a push button (momentary button) into a counter.  The counter is increment
 #### CycleButton
 Turns a push button (momentary button) into a button used to cycle through states (for example, an enumeration).  Pressing the button causes the value to increment.  Once the maximum value is reached, the value automatically resets to the initial value.  The value can also be reset to the initial value programmically or by the user (with a long press).
 
+
 ## Software Design
 Visit the Wiki to learn how the software is designed.
 
+
 ## About the Library
 ### Github Page
-
 https://github.com/lendres/ButtonSuite-Arduino
 
 ### Version 2
 The purpose of Version 2 was to greatly simplify the interface as well as the internal structure of the software.  Some of the more esoteric functionality was removed and some functionality was separated into different classes.  This meant backwards capatablity could not be maintained, however, the benefit is a much cleaner and easier to understand library.
 
 ### Prerequisites
 This library requires the following librarys to run:
-
 * [Bounce2](https://github.com/thomasfredericks/Bounce2) - Debouncer for Arduino
 
 ### Installing
@@ -60,5 +60,6 @@ We use [SemVer](http://semver.org/) for versioning.
 ## Authors
 * **Lance A. Endres** - [lendres](https://github.com/lendres)
 
+
 ## License
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

keywords.txt

@@ -1,33 +1,37 @@
 ################################
 # Classes
 ################################
-ButtonBase	KEYWORD1
-TwoStateButton	KEYWORD1
-Resettable	KEYWORD1
+ButtonBase				KEYWORD1
+TwoStateButton			KEYWORD1
+ResettableButton		KEYWORD1
 
-AlwaysOnButton	KEYWORD1
-MomentaryButton	KEYWORD1
+AlwaysOffButton			KEYWORD1
+AlwaysOnButton			KEYWORD1
+MomentaryButton			KEYWORD1
+LatchingButton			KEYWORD1
+PushEventButton			KEYWORD1
 
-LatchingButton	KEYWORD1
-CountingButton	KEYWORD1
-CycleButton	KEYWORD1
+CountingButton			KEYWORD1
+CycleButton				KEYWORD1
 
 ################################
 # Functions
 ################################
-setDebounceInterval	KEYWORD2
-update	KEYWORD2
+setDebounceInterval		KEYWORD2
+update					KEYWORD2
 
-setLongPressReset	KEYWORD2
+pushed					KEYWORD2
+
+setResetOnLongPress		KEYWORD2
 setLongPressInterval	KEYWORD2
-reset	KEYWORD2
+reset					KEYWORD2
 
-isPressed	KEYWORD2
+getCount				KEYWORD2
 
 setDefaultState	KEYWORD2
 getStatus	KEYWORD2
 
-getCount	KEYWORD2
+
 
 setMinimum	KEYWORD2
 setMaximum	KEYWORD2

src/ButtonBase.h

@@ -32,7 +32,7 @@
 	The work of debouncing and catching the state changes (LOW to HIGH or HIGH to LOW)
 	is done by the Bounce2 library.
 
-	See also: TwoStateButton, Resettable
+	See also: TwoStateButton, ResettableButton
 */
 
 /*

src/CountingButton.cpp

@@ -25,13 +25,13 @@
 
 // Constructors.
 CountingButton::CountingButton(int pin) :
-	Resettable(pin),
+	ResettableButton(pin),
 	_count(0)
 {
 }
 
 CountingButton::CountingButton(int pin, int debounceInterval) :
-	Resettable(pin, debounceInterval),
+	ResettableButton(pin, debounceInterval),
 	_count(0)
 {
 }

src/CountingButton.h

@@ -38,9 +38,9 @@
 #define COUNTINGBUTTON_H
 
 #include <Arduino.h>
-#include "Resettable.h"
+#include "ResettableButton.h"
 
-class CountingButton : public Resettable
+class CountingButton : public ResettableButton
 {
 	public:
 		CountingButton(int pin);

src/CycleButton.cpp

@@ -25,39 +25,39 @@
 
 // Constructors.
 CycleButton::CycleButton(int pin) :
-	Resettable(pin),
+	ResettableButton(pin),
 	_minValue(ZEROBASED),
 	_maxValue(2),
 	_value(0)
 {
 }
 
 CycleButton::CycleButton(int pin, int maxValue) :
-	Resettable(pin),
+	ResettableButton(pin),
 	_minValue(ZEROBASED),
 	_maxValue(maxValue),
 	_value(0)
 {
 }
 
 CycleButton::CycleButton(int pin, CYCLEBASE minValue, int maxValue) :
-	Resettable(pin),
+	ResettableButton(pin),
 	_minValue(minValue),
 	_maxValue(maxValue),
 	_value(0)
 {
 }
 
 CycleButton::CycleButton(int pin, int maxValue, int debounceInterval) :
-	Resettable(pin, debounceInterval),
+	ResettableButton(pin, debounceInterval),
 	_minValue(ZEROBASED),
 	_maxValue(maxValue),
 	_value(0)
 {
 }
 
 CycleButton::CycleButton(int pin, CYCLEBASE minValue, int maxValue, int debounceInterval) :
-	Resettable(pin, debounceInterval),
+	ResettableButton(pin, debounceInterval),
 	_minValue(minValue),
 	_maxValue(maxValue),
 	_value(0)
@@ -81,11 +81,6 @@ void CycleButton::setMaximum(unsigned int maxValue)
 	_maxValue = maxValue;
 }
 
-void CycleButton::setLongPressInterval(int longPressInterval)
-{
-  _longPressInterval = longPressInterval;
-}
-
 int CycleButton::getValue()
 {
 	// Catch transitions from HIGH to LOW.

src/CycleButton.h

@@ -44,9 +44,9 @@
 #define CYCLEBUTTON_H
 
 #include <Arduino.h>
-#include "Resettable.h"
+#include "ResettableButton.h"
 
-class CycleButton : public Resettable
+class CycleButton : public ResettableButton
 {
 	// Enums.
 	public:
@@ -75,9 +75,6 @@ class CycleButton : public Resettable
 		// Set the maximum value.
 		void setMaximum(unsigned int maxValue);
 
-		// Sets the length of time required for a press to be considered a long press.
-		void setLongPressInterval(int longPressInterval);
-
 	// Status access functions.  Call in the "loop" to get the status of the button.
 	public:
 		// Checks the button and returns the current state (toggled on or off).

src/LatchingButton.h

@@ -53,7 +53,6 @@
 #define LATCHINGBUTTON_H
 
 #include <Arduino.h>
-#include "Resettable.h"
 #include "TwoStateButton.h"
 
 class LatchingButton : public TwoStateButton

src/ResettableButton.cpp

@@ -24,29 +24,29 @@
 #include "ResettableButton.h"
 
 // Constructors.
-Resettable::Resettable(int pin) :
+ResettableButton::ResettableButton(int pin) :
 	ButtonBase(pin),
 	_resetOnLongPress(true)
 {
 }
 
-Resettable::Resettable(int pin, int debounceInterval) :
+ResettableButton::ResettableButton(int pin, int debounceInterval) :
 	ButtonBase(pin, debounceInterval),
 	_resetOnLongPress(true)
 {
 }
 
 // Destructor.
-Resettable::~Resettable()
+ResettableButton::~ResettableButton()
 {
 }
 
-void Resettable::setResetOnLongPress(bool enabled)
+void ResettableButton::setResetOnLongPress(bool enabled)
 {
 	_resetOnLongPress = enabled;
 }
 
-void Resettable::setLongPressInterval(int longPressInterval)
+void ResettableButton::setLongPressInterval(int longPressInterval)
 {
 	// The "_longPressInterval" member is in the "ButtonBase" class.
   _longPressInterval = longPressInterval;

src/ResettableButton.h

@@ -36,15 +36,15 @@
 #include <Arduino.h>
 #include "ButtonBase.h"
 
-class Resettable : public ButtonBase
+class ResettableButton : public ButtonBase
 {
 	protected:
 		// This is an abstract class and is only instantiated by derived classes.
 		// Therefore, all the constructors should be protected.
-		Resettable(int pin);
-		Resettable(int pin, int debounceInterval);
+		ResettableButton(int pin);
+		ResettableButton(int pin, int debounceInterval);
 
-		virtual ~Resettable();
+		virtual ~ResettableButton();
 
 	// Set up functions.  Normally, these would be called in the "setup" function of your sketch.
 	public: