ES-DE/es-app/src/guis/GuiSettings.h

//  SPDX-License-Identifier: MIT
//
//  EmulationStation Desktop Edition
//  GuiSettings.h
//
//  User interface template for a settings GUI.
//  The saving of es_settings.xml, the reload of gamelists and some other actions are
//  also triggered to be executed here via flags set by the menu entries' lambda functions.
//

#ifndef ES_APP_GUIS_GUI_SETTINGS_H
#define ES_APP_GUIS_GUI_SETTINGS_H

#include "components/MenuComponent.h"
#include "SystemData.h"

// This is just a really simple template for a GUI that calls some save functions when closed.
class GuiSettings : public GuiComponent
{
public:
    GuiSettings(Window* window, std::string title);
    virtual ~GuiSettings();

    void save();
    inline void addRow(const ComponentListRow& row) { mMenu.addRow(row); };
    inline void addWithLabel(const std::string& label,
            const std::shared_ptr<GuiComponent>& comp) { mMenu.addWithLabel(label, comp); };
    void addEditableTextComponent(
            const std::string label,
            std::shared_ptr<GuiComponent> ed,
            std::string value,
            std::string defaultValue = "",
            bool isPassword = false);
    inline void addSaveFunc(const std::function<void()>& func) { mSaveFuncs.push_back(func); };

    void setNeedsSaving(bool state = true) { mNeedsSaving = state; };
    void setNeedsReloadHelpPrompts() { mNeedsReloadHelpPrompts = true; };
    void setNeedsCollectionsUpdate() { mNeedsCollectionsUpdate = true; };
    void setNeedsSorting() { mNeedsSorting = true; };
    void setNeedsSortingCollections() { mNeedsSortingCollections = true; };
    void setNeedsResetFilters() { mNeedsResetFilters = true; }
    void setNeedsReloading() { mNeedsReloading = true; };
    void setNeedsGoToStart() { mNeedsGoToStart = true; };
    void setNeedsGoToSystem(SystemData* goToSystem)
            { mNeedsGoToSystem = true; mGoToSystem = goToSystem; };
    void setNeedsGoToGroupedCollections() { mNeedsGoToGroupedCollections = true; };
    void setInvalidateCachedBackground() { mInvalidateCachedBackground = true; };

    bool input(InputConfig* config, Input input) override;
    std::vector<HelpPrompt> getHelpPrompts() override;
    HelpStyle getHelpStyle() override;

private:
    MenuComponent mMenu;
    std::vector<std::function<void()>> mSaveFuncs;
    bool mNeedsSaving;
    bool mNeedsReloadHelpPrompts;
    bool mNeedsCollectionsUpdate;
    bool mNeedsSorting;
    bool mNeedsSortingCollections;
    bool mNeedsResetFilters;
    bool mNeedsReloading;
    bool mNeedsGoToStart;
    bool mNeedsGoToSystem;
    bool mNeedsGoToGroupedCollections;
    bool mInvalidateCachedBackground;

    SystemData* mGoToSystem;
};

#endif // ES_APP_GUIS_GUI_SETTINGS_H