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

Dialog that tracks network transmissions. More...

#include <network_transmission.hpp>

Inheritance diagram for gui2::dialogs::network_transmission:

Classes

class  connection_data
 A wrapper of either a wesnothd_connection or a network_asio::connection. More...
 
class  pump_monitor
 

Public Member Functions

 network_transmission (connection_data &connection, const std::string &title, const std::string &subtitle)
 
- 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)
 

Protected Member Functions

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...
 
- 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...
 

Private Member Functions

virtual const std::string & window_id () const override
 The id of the window to build. More...
 

Private Attributes

connection_dataconnection_
 
gui2::dialogs::network_transmission::pump_monitor pump_monitor_
 
std::string subtitle_
 The subtitle for the dialog. More...
 

Additional Inherited Members

- Protected Attributes inherited from gui2::dialogs::modal_dialog
std::unique_ptr< windowwindow_
 The window object build for this dialog. More...
 

Detailed Description

Dialog that tracks network transmissions.

It shows upload/download progress and allows the user to cancel the transmission.

Definition at line 35 of file network_transmission.hpp.

Constructor & Destructor Documentation

◆ network_transmission()

gui2::dialogs::network_transmission::network_transmission ( connection_data connection,
const std::string &  title,
const std::string &  subtitle 
)

Member Function Documentation

◆ post_show()

void gui2::dialogs::network_transmission::post_show ( window window)
overrideprotectedvirtual

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 123 of file network_transmission.cpp.

References gui2::CANCEL, gui2::dialogs::network_transmission::connection_data::cancel(), connection_, gui2::dialogs::modal_dialog::get_retval(), gui2::dialogs::network_transmission::pump_monitor::poller_, pump_monitor_, gui2::dialogs::network_transmission::pump_monitor::stop_, and gui2::dialogs::network_transmission::pump_monitor::window_.

◆ pre_show()

void gui2::dialogs::network_transmission::pre_show ( window window)
overrideprotectedvirtual

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 107 of file network_transmission.cpp.

References pump_monitor_, gui2::styled_widget::set_label(), gui2::styled_widget::set_use_markup(), subtitle_, and gui2::dialogs::network_transmission::pump_monitor::window_.

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ connection_

connection_data* gui2::dialogs::network_transmission::connection_
private

Definition at line 51 of file network_transmission.hpp.

Referenced by post_show().

◆ pump_monitor_

gui2::dialogs::network_transmission::pump_monitor gui2::dialogs::network_transmission::pump_monitor_
private

Referenced by post_show(), and pre_show().

◆ subtitle_

std::string gui2::dialogs::network_transmission::subtitle_
private

The subtitle for the dialog.

This field commonly shows the action in progress eg connecting, uploading, downloading etc..

Definition at line 88 of file network_transmission.hpp.

Referenced by pre_show().


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