The Battle for Wesnoth  1.15.2+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
20 {
21 namespace dialogs
22 {
23 
25 {
26 public:
27  /**
28  * Constructor.
29  *
30  * @param [in, out] password The parameter's usage is:
31  * - Input: The initial value for the password.
32  * - Output: The password input by the user
33  * if the dialog returns @ref retval::OK,
34  * undefined otherwise.
35  */
36  explicit mp_join_game_password_prompt(std::string& password);
37 
38  /** The execute function. See @ref modal_dialog for more information. */
40 
41 private:
42  /** Inherited from modal_dialog, implemented by REGISTER_DIALOG. */
43  virtual const std::string& window_id() const override;
44 };
45 
46 } // namespace dialogs
47 } // namespace gui2
Generic file dialog.
Definition: field-fwd.hpp:22
virtual const std::string & window_id() const override
The execute function.
Various uncategorised dialogs.
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.