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

#include <sp_options_configure.hpp>

Inheritance diagram for gui2::dialogs::sp_options_configure:

Public Member Functions

 sp_options_configure (ng::create_engine &create_engine, ng::configure_engine &config_engine)
 
- 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)
 

Static Public Member Functions

static bool execute (ng::create_engine &create_engine, ng::configure_engine &config_engine)
 Execute function. More...
 

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 Member Functions inherited from gui2::dialogs::plugin_executor
 plugin_executor ()
 
 ~plugin_executor ()
 

Private Attributes

ng::create_enginecreate_engine_
 
ng::configure_engineconfig_engine_
 
std::unique_ptr< mp_options_helperoptions_manager_
 
- Private Attributes inherited from gui2::dialogs::plugin_executor
std::unique_ptr< plugins_contextplugins_context_
 

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

Definition at line 27 of file sp_options_configure.hpp.

Constructor & Destructor Documentation

◆ sp_options_configure()

gui2::dialogs::sp_options_configure::sp_options_configure ( ng::create_engine create_engine,
ng::configure_engine config_engine 
)

Definition at line 26 of file sp_options_configure.cpp.

Referenced by execute().

Member Function Documentation

◆ execute()

static bool gui2::dialogs::sp_options_configure::execute ( ng::create_engine create_engine,
ng::configure_engine config_engine 
)
inlinestatic

Execute function.

We only want to show the dialog if the campaign has options or if there are active mods and at least one of those mods has custom options.

Definition at line 36 of file sp_options_configure.hpp.

References ng::create_engine::active_mods_data(), config::child_range(), ng::create_engine::current_level(), ng::level::data(), config::empty(), preferences::options(), post_show(), pre_show(), sp_options_configure(), and window_id().

Referenced by sp::configure_campaign().

◆ post_show()

void gui2::dialogs::sp_options_configure::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 40 of file sp_options_configure.cpp.

References config_engine_, gui2::window::get_retval(), gui2::OK, options_manager_, and ng::configure_engine::set_options().

Referenced by execute().

◆ pre_show()

void gui2::dialogs::sp_options_configure::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 34 of file sp_options_configure.cpp.

References create_engine_, and options_manager_.

Referenced by execute().

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Referenced by execute().

Member Data Documentation

◆ config_engine_

ng::configure_engine& gui2::dialogs::sp_options_configure::config_engine_
private

Definition at line 79 of file sp_options_configure.hpp.

Referenced by post_show().

◆ create_engine_

ng::create_engine& gui2::dialogs::sp_options_configure::create_engine_
private

Definition at line 78 of file sp_options_configure.hpp.

Referenced by pre_show().

◆ options_manager_

std::unique_ptr<mp_options_helper> gui2::dialogs::sp_options_configure::options_manager_
private

Definition at line 81 of file sp_options_configure.hpp.

Referenced by post_show(), and pre_show().


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