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

Offers a list of compatible items if a currently selected one is incompatible. More...

#include <depcheck_select_new.hpp>

Inheritance diagram for gui2::dialogs::depcheck_select_new:

Public Member Functions

 depcheck_select_new (ng::depcheck::component_type name, const std::vector< std::string > &options)
 Constructor. More...
 
int result () const
 Returns the selected item. 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...
 
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...
 
- 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...
 

Private Attributes

std::vector< std::string > items_
 the options available More...
 
int result_
 the index of the selected item 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

Offers a list of compatible items if a currently selected one is incompatible.

Currently used for switching era or map.

Key Type MandatoryDescription
message label yes displays the details of the required changes
itemlist listbox yes displays the available items to choose from
cancel button yes refuse to apply any changes
ok button yes select the chosen item

Definition at line 36 of file depcheck_select_new.hpp.

Constructor & Destructor Documentation

◆ depcheck_select_new()

gui2::dialogs::depcheck_select_new::depcheck_select_new ( ng::depcheck::component_type  name,
const std::vector< std::string > &  options 
)

Constructor.

Parameters
namethe type of which we want to select a new item
optionsthe names of the components which can be chosen

Definition at line 30 of file depcheck_select_new.cpp.

References _(), ng::depcheck::ERA, ng::depcheck::MODIFICATION, and ng::depcheck::SCENARIO.

Member Function Documentation

◆ post_show()

void gui2::dialogs::depcheck_select_new::post_show ( window window)
overrideprotectedvirtual

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 74 of file depcheck_select_new.cpp.

References gui2::dialogs::modal_dialog::get_retval(), gui2::listbox::get_selected_row(), mp_ui_alerts::items, gui2::OK, and result_.

Referenced by result().

◆ pre_show()

void gui2::dialogs::depcheck_select_new::pre_show ( window window)
overrideprotectedvirtual

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 59 of file depcheck_select_new.cpp.

References gui2::listbox::add_row(), mp_ui_alerts::items, items_, and gui2::listbox::select_row().

Referenced by result().

◆ result()

int gui2::dialogs::depcheck_select_new::result ( ) const
inline

Returns the selected item.

Returns
the index of the selected item, or -1 if none was selected (the dialog was closed with the cancel button)

Definition at line 54 of file depcheck_select_new.hpp.

References post_show(), pre_show(), result_, and window_id().

Referenced by ng::depcheck::manager::change_era_dialog(), and ng::depcheck::manager::change_scenario_dialog().

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Referenced by result().

Member Data Documentation

◆ items_

std::vector<std::string> gui2::dialogs::depcheck_select_new::items_
private

the options available

Definition at line 68 of file depcheck_select_new.hpp.

Referenced by pre_show().

◆ result_

int gui2::dialogs::depcheck_select_new::result_
private

the index of the selected item

Definition at line 71 of file depcheck_select_new.hpp.

Referenced by post_show(), and result().


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