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

This shows the dialog to select the language to use. More...

#include <language_selection.hpp>

Inheritance diagram for gui2::dialogs::language_selection:

Public Member Functions

 language_selection ()
 
- 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 execute function. More...
 
virtual void pre_show (window &window) override
 
virtual void post_show (window &window) override
 Actions to be taken after the window has been shown. 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 to select the language to use.

When the dialog is closed with the OK button it also updates the selected language in the preferences.

Key Type MandatoryDescription
language_list listbox yes This listbox contains the list with available languages.
free to choose control no Show the name of the language in the current row.

Definition at line 32 of file language_selection.hpp.

Constructor & Destructor Documentation

◆ language_selection()

gui2::dialogs::language_selection::language_selection ( )
inline

Member Function Documentation

◆ post_show()

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

References get_languages(), gui2::dialogs::modal_dialog::get_retval(), gui2::OK, translation::set_language(), and preferences::set_language().

Referenced by language_selection().

◆ pre_show()

void gui2::dialogs::language_selection::pre_show ( window window)
overrideprivatevirtual
Todo:
show we also reset the translations and is the tips of day call really needed?

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 36 of file language_selection.cpp.

References gui2::listbox::add_row(), get_language(), get_languages(), and gui2::listbox::select_last_row().

Referenced by language_selection().

◆ window_id()

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

The execute function.

See modal_dialog for more information.

Implements gui2::dialogs::modal_dialog.

Referenced by language_selection().


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