The Battle for Wesnoth  1.17.0-dev
uninstall_list.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2011 - 2021
3  by Iris Morelle <shadowm2006@gmail.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 
20 #include <map>
21 
22 namespace gui2::dialogs
23 {
24 
25 /**
26  * @ingroup GUIWindowDefinitionWML
27  *
28  * Dialog with a checkbox list for choosing installed add-ons to remove.
29  * Key |Type |Mandatory|Description
30  * ------------------|---------------|---------|-----------
31  * addons_list | @ref listbox |yes |A listbox containing add-on selection entries.
32  * checkbox | toggle_button |yes |A toggle button allowing the user to mark/unmark the add-on.
33  * name | control |no |The name of the add-on.
34  */
36 {
37 public:
38  /**
39  * Constructor.
40  *
41  * @param addon_titles_map
42  * Internal id <-> user-visible title mappings for
43  * the add-ons to display.
44  */
46  const std::map<std::string, std::string>& addon_titles_map)
47  : titles_map_(addon_titles_map), ids_(), selections_()
48  {
49  }
50 
51  std::vector<std::string> selected_addons() const;
52 
53 private:
54  std::map<std::string, std::string> titles_map_;
55  std::vector<std::string> ids_;
56  std::map<std::string, bool> selections_;
57 
58  virtual const std::string& window_id() const override;
59 
60  virtual void pre_show(window& window) override;
61 
62  virtual void post_show(window& window) override;
63 };
64 
65 } // namespace dialogs
addon_uninstall_list(const std::map< std::string, std::string > &addon_titles_map)
Constructor.
std::vector< std::string > selected_addons() const
virtual const std::string & window_id() const override
The id of the window to build.
std::vector< std::string > ids_
std::map< std::string, std::string > titles_map_
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
Dialog with a checkbox list for choosing installed add-ons to remove.
std::map< std::string, bool > selections_
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:65
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.