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