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

Asks the user to confirm a change required to proceed. More...

#include <depcheck_confirm_change.hpp>

Inheritance diagram for gui2::dialogs::depcheck_confirm_change:

Public Member Functions

 depcheck_confirm_change (bool action, const std::vector< std::string > &mods, const std::string &requester)
 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)
 

Protected Member Functions

virtual const std::string & window_id () const override
 The id of the window to build. More...
 
- 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...
 

Additional Inherited Members

- Protected Attributes inherited from gui2::dialogs::modal_dialog
std::unique_ptr< windowwindow_
 The window object build for this dialog. More...
 

Detailed Description

Asks the user to confirm a change required to proceed.

Currently used for enabling/disabling modifications.

Key Type MandatoryDescription
message label yes displays the details of the required changes
itemlist scroll_label yes displays the list of affected items
cancel button yes refuse to apply changes
ok button yes agree to apply changes

Definition at line 35 of file depcheck_confirm_change.hpp.

Constructor & Destructor Documentation

◆ depcheck_confirm_change()

gui2::dialogs::depcheck_confirm_change::depcheck_confirm_change ( bool  action,
const std::vector< std::string > &  mods,
const std::string &  requester 
)

Constructor.

Parameters
actiontrue if the listed modifications are to be enabled, false if they're to be disabled
modsthe names of the affected modifications
requesterthe name of the component which requests the change

Definition at line 29 of file depcheck_confirm_change.cpp.

References utils::join(), and VGETTEXT.

Member Function Documentation

◆ window_id()

virtual const std::string& gui2::dialogs::depcheck_confirm_change::window_id ( ) const
overrideprotectedvirtual

The id of the window to build.

Implements gui2::dialogs::modal_dialog.


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