new_map.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2008 - 2018 by Mark de Wever <koraq@xs4all.nl>
   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 "gui/dialogs/modal_dialog.hpp"

#include "tstring.hpp"

namespace gui2::dialogs
{

/**
 * @ingroup GUIWindowDefinitionWML
 *
 * Key               |Type              |Mandatory|Description
 * ------------------|------------------|---------|-----------
 * width             | integer_selector |yes      |An integer selector to determine the width of the map to create.
 * height            | integer_selector |yes      |An integer selector to determine the height of the map to create.
 */
class editor_new_map : public modal_dialog
{
public:
    /**
     * Constructor.
     *
     * @param title               The title of the dialog.
     * @param [in, out] width     The parameter's usage is:
     *                            - Input: The initial width of the map.
     *                            - Output: The selected width of the map if
     *                              the dialog returns retval::OK
     *                              undefined otherwise.
     * @param [in, out] height    The parameter's usage is:
     *                            - Input: The initial height of the map.
     *                            - Output: The selected height of the map if
     *                              the dialog returns retval::OK
     *                              undefined otherwise.
     */
    editor_new_map(const t_string& title, int& width, int& height);

    /** The execute function. See @ref modal_dialog for more information. */
    DEFINE_SIMPLE_EXECUTE_WRAPPER(editor_new_map)

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

} // namespace dialogs