/home/runner/work/DCCEXSimpleThrottle/DCCEXSimpleThrottle/DisplayInterface.h

Go to the documentation of this file.

/*
 *  © 2024 Peter Cole
 *  © 2023 Peter Cole
 *
 *  This is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  It is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this code.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef DISPLAYINTERFACE_H
#define DISPLAYINTERFACE_H
 
#include "BaseMenuItem.h"
#include <Arduino.h>
#include <DCCEXProtocol.h>
 
class DisplayInterface {
public:
  virtual void begin() = 0;
 
  virtual void clear() = 0;
 
  virtual void displayStartupScreen(const char *headerText, const char *version) = 0;
 
  virtual void displayProgressScreen(const char *activity, uint8_t counter) = 0;
 
  virtual void displayErrorScreen(const char *errorText) = 0;
 
  virtual void displayMenuScreen(const char *menuName, BaseMenuItem *firstMenuItem, uint8_t selectedItemIndex,
                                 bool selectionChanged) = 0;
 
  virtual void displayThrottleScreen(const char *locoName, uint8_t speed, Direction direction, TrackPower trackPower,
                                     bool speedChanged, bool directionChange, bool trackPowerChanged) = 0;
 
  bool needsRedraw() { return _needsRedraw; }
 
  void setNeedsRedraw(bool redraw) { _needsRedraw = redraw; }
 
  bool needsMenuRefresh() { return _needsMenuRefresh; }
 
  void setNeedsMenuRefresh(bool refresh) { _needsMenuRefresh = refresh; }
 
  uint8_t getMenuItemsPerPage() { return _menuItemsPerPage; }
 
  void setMenuItemsPerPage(uint8_t menuItemsPerPage) { _menuItemsPerPage = menuItemsPerPage; }
 
  virtual ~DisplayInterface() = default;
 
private:
  bool _needsRedraw = false;
  bool _needsMenuRefresh = false;
  uint8_t _menuItemsPerPage = 0;
};
 
#endif // DISPLAYINTERFACE_H