The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
gui2::tnetwork_transmission Class Reference

Dialog that tracks network transmissions. More...

#include <network_transmission.hpp>

Inheritance diagram for gui2::tnetwork_transmission:
Inheritance graph

Classes

class  connection_data
 
class  pump_monitor
 

Public Member Functions

 tnetwork_transmission (connection_data &connection, const std::string &title, const std::string &subtitle)
 
void set_subtitle (const std::string &)
 
void set_connection_data (connection_data &connection)
 
- Public Member Functions inherited from gui2::tdialog
 tdialog ()
 
virtual ~tdialog ()
 
bool show (CVideo &video, const unsigned auto_close_time=0)
 Shows the window. More...
 
int get_retval () const
 
void set_always_save_fields (const bool always_save_fields)
 
void set_restore (const bool restore)
 

Protected Member Functions

void pre_show (twindow &window)
 Inherited from tdialog. More...
 
void post_show (twindow &window)
 Inherited from tdialog. More...
 
- Protected Member Functions inherited from gui2::tdialog
tfield_boolregister_bool (const std::string &id, const bool mandatory, const std::function< bool()> &callback_load_value=std::function< bool()>(), const std::function< void(const bool)> &callback_save_value=std::function< void(const bool)>(), const std::function< void(twidget &)> &callback_change=std::function< void(twidget &)>())
 Creates a new boolean field. More...
 
tfield_boolregister_bool (const std::string &id, const bool mandatory, bool &linked_variable, const std::function< void(twidget &)> &callback_change=std::function< void(twidget &)>())
 Creates a new boolean field. More...
 
tfield_integerregister_integer (const std::string &id, const bool mandatory, const std::function< int()> &callback_load_value=std::function< int()>(), const std::function< void(const int)> &callback_save_value=std::function< void(const int)>())
 Creates a new integer field. More...
 
tfield_integerregister_integer (const std::string &id, const bool mandatory, int &linked_variable)
 Creates a new integer field. More...
 
tfield_textregister_text (const std::string &id, const bool mandatory, const std::function< std::string()> &callback_load_value=std::function< std::string()>(), const std::function< void(const std::string &)> &callback_save_value=std::function< void(const std::string &)>(), const bool capture_focus=false)
 Creates a new text field. More...
 
tfield_textregister_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
 Creates a new text field. More...
 
tfield_labelregister_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup=false)
 Registers a new control as a label. More...
 
tfield_labelregister_image (const std::string &id, const bool mandatory, const std::string &filename)
 Registers a new control as image. More...
 

Private Member Functions

virtual const std::stringwindow_id () const
 Inherited from tdialog, implemented by REGISTER_DIALOG. More...
 

Private Attributes

connection_dataconnection_
 
gui2::tnetwork_transmission::pump_monitor pump_monitor_
 
std::string subtitle_
 The subtitle for the 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 34 of file network_transmission.hpp.

Constructor & Destructor Documentation

gui2::tnetwork_transmission::tnetwork_transmission ( connection_data connection,
const std::string title,
const std::string subtitle 
)

Member Function Documentation

void gui2::tnetwork_transmission::post_show ( twindow window)
protectedvirtual
void gui2::tnetwork_transmission::pre_show ( twindow window)
protectedvirtual
void gui2::tnetwork_transmission::set_connection_data ( connection_data connection)
inline

Definition at line 70 of file network_transmission.hpp.

Referenced by addons_client::wait_for_transfer_done().

void gui2::tnetwork_transmission::set_subtitle ( const std::string subtitle)

Definition at line 73 of file network_transmission.cpp.

References subtitle_.

Referenced by addons_client::wait_for_transfer_done().

virtual const std::string& gui2::tnetwork_transmission::window_id ( ) const
privatevirtual

Inherited from tdialog, implemented by REGISTER_DIALOG.

Implements gui2::tdialog.

Member Data Documentation

connection_data* gui2::tnetwork_transmission::connection_
private

Definition at line 48 of file network_transmission.hpp.

Referenced by post_show().

gui2::tnetwork_transmission::pump_monitor gui2::tnetwork_transmission::pump_monitor_
private

Referenced by post_show(), and pre_show().

std::string gui2::tnetwork_transmission::subtitle_
private

The subtitle for the dialog.

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

Definition at line 89 of file network_transmission.hpp.

Referenced by pre_show(), and set_subtitle().


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