The Battle for Wesnoth  1.17.0-dev
core_selection.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2009 - 2021
3  by Mark de Wever <koraq@xs4all.nl>
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 class config;
21 
22 namespace gui2::dialogs
23 {
24 
25 /**
26  * @ingroup GUIWindowDefinitionWML
27  *
28  * This shows the dialog which allows the user to choose which core to play.
29  * Key |Type |Mandatory|Description
30  * ------------------|--------------|---------|-----------
31  * core_list | @ref listbox |yes |A listbox that contains all available cores.
32  * icon | @ref image |no |The icon for the core.
33  * name | control |no |The name of the core.
34  * core_details | multi_page |yes |A multi page widget that shows more details for the selected core.
35  * image | @ref image |no |The image for the core.
36  * description | control |no |The description of the core.
37  */
39 {
40 public:
41  explicit core_selection(const std::vector<config>& cores, int choice)
42  : cores_(cores), choice_(choice)
43  {
44  }
45 
46  /***** ***** ***** setters / getters for members ***** ****** *****/
47 
48  int get_choice() const
49  {
50  return choice_;
51  }
52 
53 private:
54  /** Called when another core is selected. */
55  void core_selected() const;
56 
57  virtual const std::string& window_id() const override;
58 
59  virtual void pre_show(window& window) override;
60 
61  virtual void post_show(window& window) override;
62 
63  /** Contains the config objects for all cores. */
64  const std::vector<config>& cores_;
65 
66  /** The chosen core. */
67  int choice_;
68 };
69 
70 } // namespace dialogs
int choice_
The chosen core.
core_selection(const std::vector< config > &cores, int choice)
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
const std::vector< config > & cores_
Contains the config objects for all cores.
void core_selected() const
Called when another core is selected.
Abstract base class for all modal dialogs.
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
This shows the dialog which allows the user to choose which core to play.
virtual const std::string & window_id() const override
The id of the window to build.
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:61
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:65