The Battle for Wesnoth  1.17.0-dev
edit_scenario.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2010 - 2021
3  by Fabian Müller <fabianmueller5@gmx.de>
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 namespace gui2::dialogs
21 {
22 
23 /**
24  * @ingroup GUIWindowDefinitionWML
25  *
26  * Dialog for editing gamemap scenarios.
27  * Key |Type |Mandatory|Description
28  * ------------------|---------------|---------|-----------
29  * title | @ref label |yes |Dialog title label.
30  * label | @ref text_box |yes |Input field for the map label.
31  * team_only_toggle | toggle_button |yes |Checkbox for whether to make the label visible to the player's team only or not.
32  */
34 {
35 public:
36  editor_edit_scenario(std::string& id,
37  std::string& name,
38  std::string& description,
39  int& turns,
40  int& experience_modifier,
41  bool& victory_when_enemies_defeated,
42  bool& random_start_time);
43 
44  /** The execute function. See @ref modal_dialog for more information. */
46 
47 private:
48  virtual const std::string& window_id() const override;
49 
50  virtual void pre_show(window& window) override;
51 };
52 } // namespace dialogs
editor_edit_scenario(std::string &id, std::string &name, std::string &description, int &turns, int &experience_modifier, bool &victory_when_enemies_defeated, bool &random_start_time)
virtual const std::string & window_id() const override
The execute function.
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
Dialog for editing gamemap scenarios.
int turns()
Definition: game.cpp:559
Abstract base class for all modal dialogs.
bool random_start_time()
Definition: game.cpp:529
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:65