Dialog that tracks network transmissions. More...
#include <network_transmission.hpp>
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) | |
![]() | |
modal_dialog () | |
virtual | ~modal_dialog () |
bool | show (const unsigned auto_close_time=0) |
Shows the window. More... | |
window * | get_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... | |
![]() | |
template<typename T , typename... Args> | |
T * | register_field (Args &&... args) |
Creates a new field of given type with given arguments. More... | |
field_bool * | register_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_bool * | register_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_integer * | register_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_integer * | register_integer (const std::string &id, const bool mandatory, int &linked_variable) |
Creates a new integer field. More... | |
field_text * | register_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_text * | register_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false) |
Creates a new text field. More... | |
field_label * | register_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_label * | register_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_data * | connection_ |
gui2::dialogs::network_transmission::pump_monitor | pump_monitor_ |
std::string | subtitle_ |
The subtitle for the dialog. More... | |
Additional Inherited Members | |
![]() | |
std::unique_ptr< window > | window_ |
The window object build for this dialog. More... | |
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.
gui2::dialogs::network_transmission::network_transmission | ( | connection_data & | connection, |
const std::string & | title, | ||
const std::string & | subtitle | ||
) |
Definition at line 95 of file network_transmission.cpp.
References gui2::dialogs::modal_dialog::register_label(), and gui2::dialogs::modal_dialog::set_restore().
|
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).
window | The 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_.
|
overrideprotectedvirtual |
Actions to be taken before showing the window.
At this point the registered fields are registered and initialized with their initial values.
window | The 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_.
|
overrideprivatevirtual |
The id of the window to build.
Implements gui2::dialogs::modal_dialog.
|
private |
Definition at line 51 of file network_transmission.hpp.
Referenced by post_show().
|
private |
Referenced by post_show(), and pre_show().
|
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().