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

#include <game_stats.hpp>

Inheritance diagram for gui2::dialogs::game_stats:

Public Member Functions

 game_stats (const display_context &board, const int viewing_team, int &selected_side_number)
 
- 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)
 

Static Public Member Functions

static bool execute (game_board &board, const int viewing_team, int &selected_side_number)
 

Private Member Functions

unit_const_ptr get_leader (const int side)
 
void on_tab_select ()
 
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

const display_contextboard_
 
const teamviewing_team_
 
std::vector< team_datateam_data_
 
int & selected_side_number_
 

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

Definition at line 34 of file game_stats.hpp.

Constructor & Destructor Documentation

◆ game_stats()

gui2::dialogs::game_stats::game_stats ( const display_context board,
const int  viewing_team,
int &  selected_side_number 
)

Definition at line 50 of file game_stats.cpp.

Referenced by execute().

Member Function Documentation

◆ execute()

static bool gui2::dialogs::game_stats::execute ( game_board board,
const int  viewing_team,
int &  selected_side_number 
)
inlinestatic

◆ get_leader()

unit_const_ptr gui2::dialogs::game_stats::get_leader ( const int  side)
private

◆ on_tab_select()

void gui2::dialogs::game_stats::on_tab_select ( )
private

Definition at line 246 of file game_stats.cpp.

References _(), gui2::dialogs::modal_dialog::get_window(), and i.

Referenced by pre_show().

◆ post_show()

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

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

◆ pre_show()

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

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ board_

const display_context& gui2::dialogs::game_stats::board_
private

Definition at line 51 of file game_stats.hpp.

Referenced by get_leader(), and pre_show().

◆ selected_side_number_

int& gui2::dialogs::game_stats::selected_side_number_
private

Definition at line 57 of file game_stats.hpp.

Referenced by post_show().

◆ team_data_

std::vector<team_data> gui2::dialogs::game_stats::team_data_
private

Definition at line 55 of file game_stats.hpp.

Referenced by post_show(), and pre_show().

◆ viewing_team_

const team& gui2::dialogs::game_stats::viewing_team_
private

Definition at line 53 of file game_stats.hpp.

Referenced by pre_show().


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