The Battle for Wesnoth  1.17.0-dev
new_map.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008 - 2021
3  by Mark de Wever <koraq@xs4all.nl>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 #pragma once
17 
19 
20 #include "tstring.hpp"
21 
22 namespace gui2::dialogs
23 {
24 
25 /**
26  * @ingroup GUIWindowDefinitionWML
27  *
28  * Key |Type |Mandatory|Description
29  * ------------------|------------------|---------|-----------
30  * width | integer_selector |yes |An integer selector to determine the width of the map to create.
31  * height | integer_selector |yes |An integer selector to determine the height of the map to create.
32  */
34 {
35 public:
36  /**
37  * Constructor.
38  *
39  * @param title The title of the dialog.
40  * @param [in, out] width The parameter's usage is:
41  * - Input: The initial width of the map.
42  * - Output: The selected width of the map if
43  * the dialog returns retval::OK
44  * undefined otherwise.
45  * @param [in, out] height The parameter's usage is:
46  * - Input: The initial height of the map.
47  * - Output: The selected height of the map if
48  * the dialog returns retval::OK
49  * undefined otherwise.
50  */
51  editor_new_map(const t_string& title, int& width, int& height);
52 
53  /** The execute function. See @ref modal_dialog for more information. */
55 
56 private:
57  virtual const std::string& window_id() const override;
58 };
59 
60 } // namespace dialogs
editor_new_map(const t_string &title, int &width, int &height)
Constructor.
Definition: new_map.cpp:27
virtual const std::string & window_id() const override
The execute function.
Key Type MandatoryDescription width integer_selector yes An integer selector to determine the width ...
Definition: new_map.hpp:33
Abstract base class for all modal dialogs.