/home/runner/work/DCCEXSimpleThrottle/DCCEXSimpleThrottle/BaseMenu.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 BASEMENU_H
#define BASEMENU_H
 
#include "BaseMenuItem.h"
#include "Defines.h"
#include "DisplayInterface.h"
#include "EventManager.h"
#include "UserConfirmationInterface.h"
#include "UserSelectionInterface.h"
#include <Arduino.h>
 
class BaseMenu {
public:
  virtual void handleUserConfirmationAction(UserConfirmationAction action) = 0;
 
  void handleUserSelectionAction(UserSelectionAction action);
 
  void displayMenu(DisplayInterface *displayInterface);
 
  void setMenuName(const char *name);
 
  const char *getMenuName();
 
  void addItem(BaseMenuItem *menuItem);
 
  BaseMenuItem *getFirstMenuItem();
 
  BaseMenuItem *getMenuItemAtIndex(uint8_t index);
 
  uint8_t getMenuItemCount();
 
  uint8_t getSelectedItemIndex();
 
  bool getSelectionChanged();
 
  void setEventManager(EventManager *eventManager);
 
  EventManager *getEventManager();
 
private:
  const char *_name = nullptr;            // Name of this menu
  BaseMenuItem *_firstMenuItem = nullptr; // Pointer to the first menu item in the linked list
  uint8_t _menuItemCount = 0;             // Count of menu items associated with this menu
  uint8_t _currentItemIndex = 0;          // Incrementing index to ensure each menu item has a unique index
  uint8_t _selectedItemIndex = 0;         // Index of the item currently selected by the user
  bool _selectionChanged = false;         // Flag if user has selected a different item
  EventManager *_eventManager = nullptr;  // pointer to the application event manager
};
 
#endif // MENU_H