The Battle for Wesnoth  1.17.0-dev
Public Member Functions | Private Member Functions | Private Attributes | List of all members
gui2::dialogs::mp_login Class Reference

This shows the dialog to log in to the MP server. More...

#include <mp_login.hpp>

Inheritance diagram for gui2::dialogs::mp_login:

Public Member Functions

 mp_login (const std::string &host, const std::string &label, const bool focus_password)
 
- Public Member Functions inherited from gui2::dialogs::modal_dialog
 modal_dialog ()
 
virtual ~modal_dialog ()
 
bool show (const unsigned auto_close_time=0)
 Shows the window. More...
 
windowget_window () const
 Returns a pointer to the dialog's window. More...
 
int get_retval () const
 Returns the cached window exit code. More...
 
void set_retval (int retval)
 Convenience wrapper to set the window's exit code. More...
 
void set_always_save_fields (const bool always_save_fields)
 
void set_restore (const bool restore)
 
void set_allow_plugin_skip (const bool allow_plugin_skip)
 
void set_show_even_without_video (const bool show_even_without_video)
 

Private Member Functions

virtual const std::string & window_id () const override
 The id of the window to build. More...
 
virtual void pre_show (window &window) override
 Actions to be taken before showing the window. More...
 
virtual void post_show (window &window) override
 Actions to be taken after the window has been shown. More...
 
void load_password () const
 
void save_password () const
 

Private Attributes

const std::string host_
 
field_textusername_
 
bool focus_password_
 

Additional Inherited Members

- Protected Member Functions inherited from gui2::dialogs::modal_dialog
field_boolregister_bool (const std::string &id, const bool mandatory, const std::function< bool()> callback_load_value=nullptr, const std::function< void(bool)> callback_save_value=nullptr, const std::function< void(widget &)> callback_change=nullptr, const bool initial_fire=false)
 Creates a new boolean field. More...
 
field_boolregister_bool (const std::string &id, const bool mandatory, bool &linked_variable, const std::function< void(widget &)> callback_change=nullptr, const bool initial_fire=false)
 Creates a new boolean field. More...
 
field_integerregister_integer (const std::string &id, const bool mandatory, const std::function< int()> callback_load_value=nullptr, const std::function< void(int)> callback_save_value=nullptr)
 Creates a new integer field. More...
 
field_integerregister_integer (const std::string &id, const bool mandatory, int &linked_variable)
 Creates a new integer field. More...
 
field_textregister_text (const std::string &id, const bool mandatory, const std::function< std::string()> callback_load_value=nullptr, const std::function< void(const std::string &)> callback_save_value=nullptr, const bool capture_focus=false)
 Creates a new text field. More...
 
field_textregister_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
 Creates a new text field. More...
 
field_labelregister_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup=false)
 Registers a new styled_widget as a label. More...
 
field_labelregister_image (const std::string &id, const bool mandatory, const std::string &filename)
 Registers a new styled_widget as image. More...
 
- Protected Attributes inherited from gui2::dialogs::modal_dialog
std::unique_ptr< windowwindow_
 The window object build for this dialog. More...
 

Detailed Description

This shows the dialog to log in to the MP server.

Key Type MandatoryDescription
user_name text_box yes The login user name.
password text_box yes The password.
remember_password toggle_button no A toggle button to offer to remember the password in the preferences.
password_reminder button no Request a password reminder.
change_username button no Use a different username.
login_label button no Displays the information received from the server.

Definition at line 40 of file mp_login.hpp.

Constructor & Destructor Documentation

◆ mp_login()

gui2::dialogs::mp_login::mp_login ( const std::string &  host,
const std::string &  label,
const bool  focus_password 
)

Member Function Documentation

◆ load_password()

void gui2::dialogs::mp_login::load_password ( ) const
private

◆ post_show()

void gui2::dialogs::mp_login::post_show ( window window)
overrideprivatevirtual

Actions to be taken after the window has been shown.

At this point the registered fields already stored their values (if the OK has been pressed).

Parameters
windowThe window which has been shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 76 of file mp_login.cpp.

References gui2::dialogs::modal_dialog::get_retval(), gui2::OK, and save_password().

◆ pre_show()

void gui2::dialogs::mp_login::pre_show ( window window)
overrideprivatevirtual

Actions to be taken before showing the window.

At this point the registered fields are registered and initialized with their initial values.

Parameters
windowThe window to be shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 61 of file mp_login.cpp.

References gui2::event::dispatcher::connect_signal(), focus_password_, load_password(), preferences::login(), and gui2::event::RECEIVE_KEYBOARD_FOCUS.

◆ save_password()

void gui2::dialogs::mp_login::save_password ( ) const
private

◆ window_id()

virtual const std::string& gui2::dialogs::mp_login::window_id ( ) const
overrideprivatevirtual

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ focus_password_

bool gui2::dialogs::mp_login::focus_password_
private

Definition at line 57 of file mp_login.hpp.

Referenced by pre_show().

◆ host_

const std::string gui2::dialogs::mp_login::host_
private

Definition at line 55 of file mp_login.hpp.

Referenced by load_password(), and save_password().

◆ username_

field_text* gui2::dialogs::mp_login::username_
private

Definition at line 56 of file mp_login.hpp.

Referenced by load_password(), and save_password().


The documentation for this class was generated from the following files: