MenuHistoryNavigator.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 https://www.thecoderscorner.com (Dave Cherry).
 * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
 */
 
#ifndef TCMENU_MENUHISTORYNAVIGATOR_H
#define TCMENU_MENUHISTORYNAVIGATOR_H
 
#include "MenuItems.h"
 
#ifndef NAV_ITEM_ARRAY_SIZE
#define NAV_ITEM_ARRAY_SIZE 4
#endif
 
namespace tcnav {
    class NavigationListener {
        NavigationListener* next = nullptr;
    public:
        virtual void navigationHasChanged(MenuItem* newItem, bool completelyReset)=0;
        NavigationListener* getNext() { return next; }
        void setNext(NavigationListener* nxt) { next = nxt; }
    };
 
    class MenuNavigationStore {
    private:
        MenuItem* root;
        MenuItem* currentRoot;
        MenuItem* currentSub;
        MenuItem* navItems[NAV_ITEM_ARRAY_SIZE];
        MenuItem* activeItems[NAV_ITEM_ARRAY_SIZE];
        NavigationListener* navigationLister = nullptr;
        uint8_t navIdx;
        bool currentIsCustom;
    public:
        MenuNavigationStore() = default;
 
        void addNavigationListener(NavigationListener* newListener);
        void clearNavigationListeners() { navigationLister = nullptr; }
 
        void triggerNavigationListener(bool completeReset);
 
        MenuItem* getRoot() { return root; }
        MenuItem* getCurrentRoot() { return currentRoot; }
        MenuItem* getCurrentSubMenu() { return currentSub; }
 
        void setRootItem(MenuItem* item);
 
        void navigateTo(MenuItem* activeItem, MenuItem* newRoot, bool custom);
 
        MenuItem* popNavigationGetActive();
 
        bool isShowingRoot();
 
        int getNavigationDepth() const { return navIdx; }
 
        MenuItem* getActiveAt(uint8_t i) { return i < navIdx ? activeItems[i] : nullptr; }
 
        MenuItem* getRootAt(uint8_t i) { return i < navIdx ? navItems[i] : nullptr; }
 
        void resetStack();
    };
}
 
#endif //TCMENU_MENUHISTORYNAVIGATOR_H