The Battle for Wesnoth  1.17.12+dev
mp_report.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008 - 2022
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 namespace gui2::dialogs
20 {
21 
22 /**
23  * @ingroup GUIWindowDefinitionWML
24  *
25  * This shows a dialog to report players on the multiplayer server.
26  *
27  * Key |Type |Mandatory|Description
28  * ----------------------|---------------|---------|-----------
29  * reportee | text_box |yes |The person being reported.
30  * report_reason | text_box |yes |Why they're being reported.
31  * occurrence_location | menu_button |yes |Where in-game it happened.
32  * additional_information| text_box |yes |Any additional information to add.
33  */
34 class mp_report : public modal_dialog
35 {
36 public:
37  mp_report(std::string& report_text_);
38 
40 
41 private:
42  virtual const std::string& window_id() const override;
43 
44  virtual void pre_show(window& window) override;
45 
46  virtual void post_show(window& window) override;
47 
48  void reportee_changed(const std::string& text);
49  void report_reason_changed(const std::string& text);
50 
51  std::string& report_text_;
54  const static std::array<std::string, 3> occurrence_locations;
55 };
56 
57 } // namespace gui2::dialogs
This shows a dialog to report players on the multiplayer server.
Definition: mp_report.hpp:34
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
Definition: mp_report.cpp:66
std::string & report_text_
Definition: mp_report.hpp:51
static const std::array< std::string, 3 > occurrence_locations
Definition: mp_report.hpp:54
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
Definition: mp_report.cpp:45
void reportee_changed(const std::string &text)
Definition: mp_report.cpp:86
mp_report(std::string &report_text_)
Definition: mp_report.cpp:37
void report_reason_changed(const std::string &text)
Definition: mp_report.cpp:94
Abstract base class for all modal dialogs.
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:66
virtual const std::string & window_id() const override
The ID of the window to build.