The Battle for Wesnoth  1.17.0-dev
mp_login.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
21 {
22 class field_text;
23 
24 namespace dialogs
25 {
26 
27 /**
28  * @ingroup GUIWindowDefinitionWML
29  *
30  * This shows the dialog to log in to the MP server.
31  * Key |Type |Mandatory|Description
32  * ------------------|---------------|---------|-----------
33  * user_name | text_box |yes |The login user name.
34  * password | text_box |yes |The password.
35  * remember_password | toggle_button |no |A toggle button to offer to remember the password in the preferences.
36  * password_reminder | @ref button |no |Request a password reminder.
37  * change_username | @ref button |no |Use a different username.
38  * login_label | @ref button |no |Displays the information received from the server.
39  */
40 class mp_login : public modal_dialog
41 {
42 public:
43  mp_login(const std::string& host, const std::string& label, const bool focus_password);
44 
45 private:
46  virtual const std::string& window_id() const override;
47 
48  virtual void pre_show(window& window) override;
49 
50  virtual void post_show(window& window) override;
51 
52  void load_password() const;
53  void save_password() const;
54 
55  const std::string host_;
58 };
59 
60 } // namespace dialogs
61 } // namespace gui2
field_text * username_
Definition: mp_login.hpp:56
void load_password() const
Definition: mp_login.cpp:49
const std::string host_
Definition: mp_login.hpp:55
A label displays a text, the text can be wrapped but no scrollbars are provided.
Definition: label.hpp:57
Generic file dialog.
Definition: field-fwd.hpp:23
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
Definition: mp_login.cpp:61
virtual const std::string & window_id() const override
The id of the window to build.
Various uncategorised dialogs.
mp_login(const std::string &host, const std::string &label, const bool focus_password)
Definition: mp_login.cpp:35
void save_password() const
Definition: mp_login.cpp:55
This shows the dialog to log in to the MP server.
Definition: mp_login.hpp:40
Abstract base class for all modal dialogs.
Specialized field class for text.
Definition: field.hpp:593
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:65
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
Definition: mp_login.cpp:76