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

Addon connect dialog. More...

#include <connect.hpp>

Inheritance diagram for gui2::taddon_connect:
Inheritance graph

Public Member Functions

 taddon_connect (std::string &host_name, const bool allow_remove)
 Constructor. More...
 
- 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)
 

Private Member Functions

void help_button_callback (twindow &window)
 
virtual const std::stringwindow_id () const
 Inherited from tdialog, implemented by REGISTER_DIALOG. More...
 
void pre_show (twindow &window)
 Inherited from tdialog. More...
 
void post_show (twindow &window)
 Inherited from tdialog. More...
 

Private Attributes

bool allow_remove_
 Enable the addon remove button? More...
 

Additional Inherited Members

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

Detailed Description

Addon connect dialog.

Definition at line 26 of file connect.hpp.

Constructor & Destructor Documentation

gui2::taddon_connect::taddon_connect ( std::string host_name,
const bool  allow_remove 
)

Constructor.

Parameters
[in,out]The parameter's usage is:
  • Input: The initial value for the host_name.
  • Output :The final value of the host_name if the dialog returns twindow::OK or 3 undefined otherwise.
allow_removeSets allow_remove_.
dispThe display object used for showing the in-game help when requested.

Definition at line 56 of file connect.cpp.

Member Function Documentation

void gui2::taddon_connect::help_button_callback ( twindow window)
private

Definition at line 64 of file connect.cpp.

References help::show_help(), and gui2::twindow::video().

Referenced by pre_show().

void gui2::taddon_connect::post_show ( twindow window)
privatevirtual

Inherited from tdialog.

Reimplemented from gui2::tdialog.

Definition at line 81 of file connect.cpp.

References gui2::tdialog::get_retval(), gui2::twindow::OK, and gui2::ttext_box::save_to_history().

void gui2::taddon_connect::pre_show ( twindow window)
privatevirtual

Inherited from tdialog.

Reimplemented from gui2::tdialog.

Definition at line 69 of file connect.cpp.

References allow_remove_, gui2::event::connect_signal_mouse_left_click(), and help_button_callback().

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

Inherited from tdialog, implemented by REGISTER_DIALOG.

Implements gui2::tdialog.

Member Data Documentation

bool gui2::taddon_connect::allow_remove_
private

Enable the addon remove button?

Definition at line 46 of file connect.hpp.

Referenced by pre_show().


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