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

This shows the multiplayer change control dialog. More...

#include <mp_change_control.hpp>

Inheritance diagram for gui2::dialogs::mp_change_control:

Public Member Functions

 mp_change_control (events::menu_handler &mh)
 
- 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 handle_sides_list_item_clicked ()
 
void handle_nicks_list_item_clicked ()
 
void highlight_side_nick ()
 

Private Attributes

events::menu_handlermenu_handler_
 
unsigned int selected_side_
 
unsigned int selected_nick_
 
std::vector< int > sides_
 
std::vector< std::string > nicks_
 

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 multiplayer change control dialog.

Key Type MandatoryDescription
sides_list listbox yes List of sides participating in the MP game.
nicks_list listbox yes List of nicks of all clients playing or observing the MP game.

Definition at line 39 of file mp_change_control.hpp.

Constructor & Destructor Documentation

◆ mp_change_control()

gui2::dialogs::mp_change_control::mp_change_control ( events::menu_handler mh)
explicit

Definition at line 48 of file mp_change_control.cpp.

Member Function Documentation

◆ handle_nicks_list_item_clicked()

void gui2::dialogs::mp_change_control::handle_nicks_list_item_clicked ( )
private

Definition at line 140 of file mp_change_control.cpp.

References gui2::dialogs::modal_dialog::get_window(), and selected_nick_.

Referenced by pre_show().

◆ handle_sides_list_item_clicked()

void gui2::dialogs::mp_change_control::handle_sides_list_item_clicked ( )
private

◆ highlight_side_nick()

void gui2::dialogs::mp_change_control::highlight_side_nick ( )
private

◆ post_show()

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

References DBG_GUI, gui2::window::get_retval(), menu_handler_, nicks_, gui2::OK, events::menu_handler::request_control_change(), selected_nick_, selected_side_, and sides_.

◆ pre_show()

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

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ menu_handler_

events::menu_handler& gui2::dialogs::mp_change_control::menu_handler_
private

Definition at line 58 of file mp_change_control.hpp.

Referenced by highlight_side_nick(), post_show(), and pre_show().

◆ nicks_

std::vector<std::string> gui2::dialogs::mp_change_control::nicks_
private

Definition at line 67 of file mp_change_control.hpp.

Referenced by highlight_side_nick(), post_show(), and pre_show().

◆ selected_nick_

unsigned int gui2::dialogs::mp_change_control::selected_nick_
private

Definition at line 61 of file mp_change_control.hpp.

Referenced by handle_nicks_list_item_clicked(), and post_show().

◆ selected_side_

unsigned int gui2::dialogs::mp_change_control::selected_side_
private

◆ sides_

std::vector<int> gui2::dialogs::mp_change_control::sides_
private

Definition at line 64 of file mp_change_control.hpp.

Referenced by post_show(), and pre_show().


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