The Battle for Wesnoth  1.15.12+dev
Public Member Functions | Private Member Functions | Private Attributes | List of all members
gui2::dialogs::addon_uninstall_list Class Reference

Dialog with a checkbox list for choosing installed add-ons to remove. More...

#include <uninstall_list.hpp>

Inheritance diagram for gui2::dialogs::addon_uninstall_list:

Public Member Functions

 addon_uninstall_list (const std::map< std::string, std::string > &addon_titles_map)
 Constructor. More...
 
std::vector< std::string > selected_addons () const
 
- 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

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

std::map< std::string, std::string > titles_map_
 
std::vector< std::string > ids_
 
std::map< std::string, bool > selections_
 

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

Dialog with a checkbox list for choosing installed add-ons to remove.

Key Type MandatoryDescription
addons_list listbox yes A listbox containing add-on selection entries.
checkbox toggle_button yes A toggle button allowing the user to mark/unmark the add-on.
name control no The name of the add-on.

Definition at line 34 of file uninstall_list.hpp.

Constructor & Destructor Documentation

◆ addon_uninstall_list()

gui2::dialogs::addon_uninstall_list::addon_uninstall_list ( const std::map< std::string, std::string > &  addon_titles_map)
inlineexplicit

Constructor.

Parameters
addon_titles_mapInternal id <-> user-visible title mappings for the add-ons to display.

Definition at line 44 of file uninstall_list.hpp.

References selected_addons().

Member Function Documentation

◆ post_show()

void gui2::dialogs::addon_uninstall_list::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 58 of file uninstall_list.cpp.

References g, gui2::listbox::get_item_count(), gui2::dialogs::modal_dialog::get_retval(), gui2::listbox::get_row_grid(), gui2::selectable_item::get_value_bool(), ids_, gui2::OK, selections_, and titles_map_.

◆ pre_show()

void gui2::dialogs::addon_uninstall_list::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 31 of file uninstall_list.cpp.

References gui2::listbox::add_row(), and gui2::listbox::clear().

◆ selected_addons()

std::vector< std::string > gui2::dialogs::addon_uninstall_list::selected_addons ( ) const

Definition at line 77 of file uninstall_list.cpp.

References selections_.

Referenced by addon_uninstall_list().

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ ids_

std::vector<std::string> gui2::dialogs::addon_uninstall_list::ids_
private

Definition at line 54 of file uninstall_list.hpp.

Referenced by post_show().

◆ selections_

std::map<std::string, bool> gui2::dialogs::addon_uninstall_list::selections_
private

Definition at line 55 of file uninstall_list.hpp.

Referenced by post_show(), and selected_addons().

◆ titles_map_

std::map<std::string, std::string> gui2::dialogs::addon_uninstall_list::titles_map_
private

Definition at line 53 of file uninstall_list.hpp.

Referenced by post_show().


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