The Battle for Wesnoth
1.17.23+dev
gui
dialogs
multiplayer
mp_login.hpp
Go to the documentation of this file.
1
/*
2
Copyright (C) 2008 - 2023
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
18
#include "
gui/dialogs/modal_dialog.hpp
"
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
();
53
void
save_password
();
54
55
const
std::string
host_
;
56
field_text
*
username_
;
57
bool
focus_password_
;
58
};
59
60
}
// namespace dialogs
61
}
// namespace gui2
gui2::dialogs::modal_dialog
Abstract base class for all modal dialogs.
Definition:
modal_dialog.hpp:146
gui2::dialogs::mp_login
This shows the dialog to log in to the MP server.
Definition:
mp_login.hpp:41
gui2::dialogs::mp_login::mp_login
mp_login(const std::string &host, const std::string &label, const bool focus_password)
Definition:
mp_login.cpp:35
gui2::dialogs::mp_login::load_password
void load_password()
Definition:
mp_login.cpp:51
gui2::dialogs::mp_login::window_id
virtual const std::string & window_id() const override
The ID of the window to build.
gui2::dialogs::mp_login::username_
field_text * username_
Definition:
mp_login.hpp:56
gui2::dialogs::mp_login::focus_password_
bool focus_password_
Definition:
mp_login.hpp:57
gui2::dialogs::mp_login::host_
const std::string host_
Definition:
mp_login.hpp:55
gui2::dialogs::mp_login::post_show
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
Definition:
mp_login.cpp:78
gui2::dialogs::mp_login::save_password
void save_password()
Definition:
mp_login.cpp:57
gui2::dialogs::mp_login::pre_show
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
Definition:
mp_login.cpp:63
gui2::field_text
Specialized field class for text.
Definition:
field.hpp:537
gui2::label
A label displays text that can be wrapped but no scrollbars are provided.
Definition:
label.hpp:57
gui2::window
base class of top level items, the only item which needs to store the final canvases to draw on.
Definition:
window.hpp:67
modal_dialog.hpp
dialogs
Various uncategorised dialogs.
gui2
Generic file dialog.
Definition:
draw_manager.hpp:19
Generated by
1.9.1