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

Dialog for selecting a GUI theme. More...

#include <theme_list.hpp>

Inheritance diagram for gui2::dialogs::theme_list:

Public Member Functions

 theme_list (const std::vector< theme_info > &themes, int selection=-1)
 
int selected_index () const
 Returns the selected item index after displaying. More...
 
void set_selected_index (int index)
 Sets the initially selected item index (-1 by default). 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)
 

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

int index_
 
std::vector< theme_infothemes_
 

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 for selecting a GUI theme.

Key Type MandatoryDescription
themes listbox yes Listbox displaying user choices.
name control yes Widget which shows a theme item name.
description control yes Widget which shows a theme item description.

Definition at line 34 of file theme_list.hpp.

Constructor & Destructor Documentation

◆ theme_list()

gui2::dialogs::theme_list::theme_list ( const std::vector< theme_info > &  themes,
int  selection = -1 
)
explicit

Definition at line 28 of file theme_list.cpp.

Member Function Documentation

◆ post_show()

void gui2::dialogs::theme_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 63 of file theme_list.cpp.

References gui2::dialogs::modal_dialog::get_retval(), gui2::listbox::get_selected_row(), index_, and gui2::OK.

◆ pre_show()

void gui2::dialogs::theme_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 33 of file theme_list.cpp.

References gui2::listbox::add_row(), gui2::listbox::get_item_count(), index_, gui2::listbox::select_row(), t, and themes_.

◆ selected_index()

int gui2::dialogs::theme_list::selected_index ( ) const
inline

Returns the selected item index after displaying.

Returns
-1 if the dialog was canceled.

Definition at line 44 of file theme_list.hpp.

References index_.

Referenced by preferences::show_theme_dialog().

◆ set_selected_index()

void gui2::dialogs::theme_list::set_selected_index ( int  index)
inline

Sets the initially selected item index (-1 by default).

Definition at line 50 of file theme_list.hpp.

References utf8::index(), and index_.

Referenced by preferences::show_theme_dialog().

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ index_

int gui2::dialogs::theme_list::index_
private

Definition at line 56 of file theme_list.hpp.

Referenced by post_show(), pre_show(), selected_index(), and set_selected_index().

◆ themes_

std::vector<theme_info> gui2::dialogs::theme_list::themes_
private

Definition at line 58 of file theme_list.hpp.

Referenced by pre_show().


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