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

This shows the dialog for managing addons and connecting to the addon server. More...

#include <connect.hpp>

Inheritance diagram for gui2::dialogs::addon_connect:

Public Member Functions

 addon_connect (std::string &host_name, const bool allow_remove)
 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)
 

Private Member Functions

void help_button_callback ()
 
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...
 
virtual void post_show (window &window) override
 Actions to be taken after the window has been shown. More...
 

Private Attributes

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

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

This shows the dialog for managing addons and connecting to the addon server.

Key Type MandatoryDescription
hostname text_box yes This text contains the name of the server to connect to.
show_help gui::button yes Thus button shows the in-game help about add-ons management when triggered.
free to choose (2)button no This button closes the dialog to display a dialog for removing installed add-ons.

Definition at line 33 of file connect.hpp.

Constructor & Destructor Documentation

◆ addon_connect()

gui2::dialogs::addon_connect::addon_connect ( std::string &  host_name,
const bool  allow_remove 
)

Constructor.

Parameters
host_nameThe parameter's usage is:
  • Input: The initial value for the host_name.
  • Output :The final value of the host_name if the dialog returns retval::OK or 3 undefined otherwise.
allow_removeSets allow_remove_.

Definition at line 34 of file connect.cpp.

Member Function Documentation

◆ help_button_callback()

void gui2::dialogs::addon_connect::help_button_callback ( )
private

Definition at line 42 of file connect.cpp.

References help::show_help().

Referenced by pre_show().

◆ post_show()

void gui2::dialogs::addon_connect::post_show ( window window)
overrideprivatevirtual

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 57 of file connect.cpp.

References gui2::dialogs::modal_dialog::get_retval(), gui2::OK, and gui2::text_box::save_to_history().

◆ pre_show()

void gui2::dialogs::addon_connect::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 47 of file connect.cpp.

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

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ allow_remove_

bool gui2::dialogs::addon_connect::allow_remove_
private

Enable the addon remove button?

Definition at line 51 of file connect.hpp.

Referenced by pre_show().


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