Class SettingsWindow

source/modes/SettingsWindow.h:29–102

\brief This class is creating a setting window gui child to the current gui context and populates its widgets with the current game, video, audio values. It also permits to change them.

//! and populates its widgets with the current game, video, audio values.
//! It also permits to change them.
class SettingsWindow
{
public:
    //! \brief Settings window constructor
    //! \param rootWindow The main CEGUI window used as background to the current mode.
    //! Used to load and later show the settings window.
    SettingsWindow(CEGUI::Window* rootWindow);

    ~SettingsWindow();

    void show();

    void hide();

    bool isVisible() const
    {
        if (mSettingsWindow)
            return mSettingsWindow->isVisible();
        return false;
    }

    //! \brief Called when pushing the cancel button on the settings window.
    bool onCancelSettings(const CEGUI::EventArgs& e = {});

private:
    //! \brief Vector of cegui event bindings to be cleared on exiting the mode
    std::vector<CEGUI::Event::Connection> mEventConnections;

    //! \brief The Settings window.
    CEGUI::Window* mSettingsWindow;

    //! \brief The apply change pop-up
    CEGUI::Window* mApplyWindow;

    //! \brief The root window.
    CEGUI::Window* mRootWindow;

    //! \brief The temporary video comboboxes and texts created depending on the video settings.
    std::vector<CEGUI::Window*> mCustomVideoComboBoxes;
    std::vector<CEGUI::Window*> mCustomVideoTexts;

    //! \brief Set the different widget values according to current config.
    void initConfig();

    //! \brief Save the config, potentially stopping the application if it needs to.
    void saveConfig();

    //! \brief Adds an event binding to be cleared on exiting the mode.
    inline void addEventConnection(CEGUI::Event::Connection conn)
    {
        mEventConnections.emplace_back(conn);
    }

    //! \brief Called when pushing the apply button on the settings window.
    bool onApplySettings(const CEGUI::EventArgs&);

    //! \brief Called when pushing the cancel button on the change appliance popup.
    bool onPopupCancelApplySettings(const CEGUI::EventArgs&);