The Battle for Wesnoth  1.15.12+dev
mp_join_game_password_prompt.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2015 - 2018 by Iris Morelle <shadowm2006@gmail.com>
3  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 
15 #pragma once
16 
18 
19 namespace gui2::dialogs
20 {
21 
22 /**
23  * @ingroup GUIWindowDefinitionWML
24  *
25  * Dialog for entering a password for joining a password-protected MP game.
26  * Key |Type |Mandatory|Description
27  * ------------------|--------------|---------|-----------
28  * password | text_box |yes |Input field for the game password.
29  */
31 {
32 public:
33  /**
34  * Constructor.
35  *
36  * @param [in, out] password The parameter's usage is:
37  * - Input: The initial value for the password.
38  * - Output: The password input by the user
39  * if the dialog returns retval::OK,
40  * undefined otherwise.
41  */
42  explicit mp_join_game_password_prompt(std::string& password);
43 
44  /** The execute function. See @ref modal_dialog for more information. */
46 
47 private:
48  virtual const std::string& window_id() const override;
49 };
50 
51 } // 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.