The Battle for Wesnoth  1.17.0-dev
depcheck_confirm_change.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2012 - 2021
3  by Boldizs√°r Lipka <lipkab@zoho.com>
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 #include <vector>
20 #include <string>
21 
22 namespace gui2::dialogs
23 {
24 
25 /**
26  * @ingroup GUIWindowDefinitionWML
27  *
28  * Asks the user to confirm a change required to proceed. Currently used for enabling/disabling modifications.
29  * Key |Type |Mandatory|Description
30  * ------------------|--------------|---------|-----------
31  * message | @ref label |yes |displays the details of the required changes
32  * itemlist | scroll_label |yes |displays the list of affected items
33  * cancel | @ref button |yes |refuse to apply changes
34  * ok | @ref button |yes |agree to apply changes
35  */
37 {
38 public:
39  /**
40  * Constructor.
41  *
42  * @param action true if the listed modifications are to be enabled,
43  * false if they're to be disabled
44  * @param mods the names of the affected modifications
45  * @param requester the name of the component which requests the change
46  *
47  */
48  depcheck_confirm_change(bool action,
49  const std::vector<std::string>& mods,
50  const std::string& requester);
51 
53 
54 protected:
55  virtual const std::string& window_id() const override;
56 };
57 
58 } // namespace dialogs
depcheck_confirm_change(bool action, const std::vector< std::string > &mods, const std::string &requester)
Constructor.
Asks the user to confirm a change required to proceed.
virtual const std::string & window_id() const override
The id of the window to build.
Abstract base class for all modal dialogs.