The Battle for Wesnoth  1.17.0-dev
mp_join_game_password_prompt.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2015 - 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 namespace gui2::dialogs
21 {
22 
23 /**
24  * @ingroup GUIWindowDefinitionWML
25  *
26  * Dialog for entering a password for joining a password-protected MP game.
27  * Key |Type |Mandatory|Description
28  * ------------------|--------------|---------|-----------
29  * password | text_box |yes |Input field for the game password.
30  */
32 {
33 public:
34  /**
35  * Constructor.
36  *
37  * @param [in, out] password The parameter's usage is:
38  * - Input: The initial value for the password.
39  * - Output: The password input by the user
40  * if the dialog returns retval::OK,
41  * undefined otherwise.
42  */
43  explicit mp_join_game_password_prompt(std::string& password);
44 
45  /** The execute function. See @ref modal_dialog for more information. */
47 
48 private:
49  virtual const std::string& window_id() const override;
50 };
51 
52 } // namespace dialogs
Dialog for entering a password for joining a password-protected MP game.
virtual const std::string & window_id() const override
The execute function.
std::string password(const std::string &server, const std::string &login)
Abstract base class for all modal dialogs.
mp_join_game_password_prompt(std::string &password)
Constructor.