The Battle for Wesnoth  1.15.12+dev
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
gui2::dialogs::mp_method_selection Class Reference

This shows the dialog to select the kind of MP game the user wants to play. More...

#include <mp_method_selection.hpp>

Inheritance diagram for gui2::dialogs::mp_method_selection:

Public Types

enum  choice { choice::JOIN = 0, choice::CONNECT, choice::HOST, choice::LOCAL }
 Corresponds to each connection option. More...
 

Public Member Functions

 mp_method_selection ()
 
const std::string & user_name () const
 
choice get_choice () const
 
- 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...
 

Private Attributes

std::string user_name_
 The name to use on the MP server. More...
 
choice choice_
 The selected method to `connect' to the MP server. More...
 

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 select the kind of MP game the user wants to play.

Key Type MandatoryDescription
user_name text_box yes This text contains the name the user on the MP server. This widget will get a fixed maximum length by the engine.
method_list listbox yes The list with possible game methods.

Definition at line 31 of file mp_method_selection.hpp.

Member Enumeration Documentation

◆ choice

Corresponds to each connection option.

Enumerator
JOIN 
CONNECT 
HOST 
LOCAL 

Definition at line 35 of file mp_method_selection.hpp.

Constructor & Destructor Documentation

◆ mp_method_selection()

gui2::dialogs::mp_method_selection::mp_method_selection ( )
inline

Definition at line 37 of file mp_method_selection.hpp.

Member Function Documentation

◆ get_choice()

choice gui2::dialogs::mp_method_selection::get_choice ( ) const
inline

Definition at line 46 of file mp_method_selection.hpp.

References choice_.

Referenced by gui2::dialogs::title_screen::button_callback_multiplayer().

◆ post_show()

void gui2::dialogs::mp_method_selection::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 53 of file mp_method_selection.cpp.

References choice_, gui2::dialogs::modal_dialog::get_retval(), gui2::listbox::get_selected_row(), gui2::text_box_base::get_value(), gui2::OK, gui2::text_box::save_to_history(), preferences::set_login(), and user_name_.

◆ pre_show()

void gui2::dialogs::mp_method_selection::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 36 of file mp_method_selection.cpp.

References gui2::event::connect_signal_mouse_left_click(), gui2::dialogs::forum_registration_url, preferences::login(), mp::max_login_size, desktop::open_object(), gui2::text_box_base::set_maximum_length(), and gui2::text_box_base::set_value().

◆ user_name()

const std::string& gui2::dialogs::mp_method_selection::user_name ( ) const
inline

Definition at line 41 of file mp_method_selection.hpp.

References user_name_.

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ choice_

choice gui2::dialogs::mp_method_selection::choice_
private

The selected method to `connect' to the MP server.

Definition at line 56 of file mp_method_selection.hpp.

Referenced by get_choice(), and post_show().

◆ user_name_

std::string gui2::dialogs::mp_method_selection::user_name_
private

The name to use on the MP server.

Definition at line 53 of file mp_method_selection.hpp.

Referenced by post_show(), and user_name().


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