campaign_difficulty.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2010 - 2021
    by Iris Morelle <shadowm2006@gmail.com>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/

    This program 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 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.

    See the COPYING file for more details.
*/

#pragma once

#include "config.hpp"
#include "gui/dialogs/modal_dialog.hpp"

#include <vector>

namespace gui2::dialogs
{

/**
 * Helper function to convert old difficulty markup. Declared outside class to allow other
 * classes to make use of it.
 */
config generate_difficulty_config(const config& source);

/**
 * @ingroup GUIWindowDefinitionWML
 *
 * The campaign mode difficulty menu.
 * Key               |Type          |Mandatory|Description
 * ------------------|--------------|---------|-----------
 * title             | @ref label   |yes      |Dialog title label.
 * message           | scroll_label |no       |Text label displaying a description or instructions.
 * listbox           | @ref listbox |yes      |Listbox displaying user choices, defined by WML for each campaign.
 * icon              | control      |yes      |Widget which shows a listbox item icon, first item markup column.
 * label             | control      |yes      |Widget which shows a listbox item label, second item markup column.
 * description       | control      |yes      |Widget which shows a listbox item description, third item markup column.
 */
class campaign_difficulty : public modal_dialog
{
public:
    /**
     * @param campaign The campaign the difficulty is being chosen for
     */
    campaign_difficulty(const config& campaign);

    /**
     * Returns the selected difficulty define after displaying.
     * @return 'CANCEL' if the dialog was canceled.
     */
    std::string selected_difficulty() const
    {
        return selected_difficulty_;
    }

private:
    config difficulties_;
    std::string campaign_id_;
    std::string selected_difficulty_;

    virtual const std::string& window_id() const override;

    virtual void pre_show(window& window) override;

    virtual void post_show(window& window) override;
};
} // namespace dialogs