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::server_info Class Reference

#include <server_info_dialog.hpp>

Inheritance diagram for gui2::dialogs::server_info:

Public Member Functions

 server_info (const std::string &info, const std::string &announcement)
 Constructor. More...
 
- 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 void display (const std::string &info, const std::string &announcements)
 The display function. More...
 

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...
 
void tab_switch_callback ()
 

Private Attributes

const std::string & server_information_
 
const std::string & announcements_
 

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 25 of file server_info_dialog.hpp.

Constructor & Destructor Documentation

◆ server_info()

gui2::dialogs::server_info::server_info ( const std::string &  info,
const std::string &  announcement 
)

Constructor.

Definition at line 30 of file server_info_dialog.cpp.

Referenced by display().

Member Function Documentation

◆ display()

static void gui2::dialogs::server_info::display ( const std::string &  info,
const std::string &  announcements 
)
inlinestatic

The display function.

See modal_dialog for more information.

Definition at line 38 of file server_info_dialog.hpp.

References pre_show(), server_info(), tab_switch_callback(), and window_id().

Referenced by gui2::dialogs::mp_lobby::show_server_info().

◆ pre_show()

void gui2::dialogs::server_info::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 37 of file server_info_dialog.cpp.

References announcements_, gui2::event::connect_signal_notify_modified(), gui2::listbox::get_item_count(), gui2::stacked_widget::get_layer_count(), gui2::stacked_widget::select_layer(), server_information_, tab_switch_callback(), and VALIDATE.

Referenced by display().

◆ tab_switch_callback()

void gui2::dialogs::server_info::tab_switch_callback ( )
private

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Referenced by display().

Member Data Documentation

◆ announcements_

const std::string& gui2::dialogs::server_info::announcements_
private

Definition at line 51 of file server_info_dialog.hpp.

Referenced by pre_show().

◆ server_information_

const std::string& gui2::dialogs::server_info::server_information_
private

Definition at line 50 of file server_info_dialog.hpp.

Referenced by pre_show().


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