The Battle for Wesnoth  1.17.0-dev
mp_method_selection.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008 - 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 namespace gui2::dialogs
21 {
22 
23 /**
24  * @ingroup GUIWindowDefinitionWML
25  *
26  * This shows the dialog to select the kind of MP game the user wants to play.
27  * Key |Type |Mandatory|Description
28  * ------------------|--------------|---------|-----------
29  * user_name | text_box |yes |This text contains the name the user on the MP server. This widget will get a fixed maximum length by the engine.
30  * method_list | @ref listbox |yes |The list with possible game methods.
31  */
33 {
34 public:
35  /** Corresponds to each connection option. */
36  enum class choice { JOIN = 0, CONNECT, HOST, LOCAL };
37 
39  {
40  }
41 
42  const std::string& user_name() const
43  {
44  return user_name_;
45  }
46 
48  {
49  return choice_;
50  }
51 
52 private:
53  /** The name to use on the MP server. */
54  std::string user_name_;
55 
56  /** The selected method to `connect' to the MP server. */
58 
59  virtual const std::string& window_id() const override;
60 
61  virtual void pre_show(window& window) override;
62 
63  virtual void post_show(window& window) override;
64 };
65 
66 } // namespace dialogs
const std::string & user_name() const
std::string user_name_
The name to use on the MP server.
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
virtual const std::string & window_id() const override
The id of the window to build.
choice
Corresponds to each connection option.
This shows the dialog to select the kind of MP game the user wants to play.
Abstract base class for all modal dialogs.
choice choice_
The selected method to `connect&#39; to the MP server.
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:65