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

#include <unit_list.hpp>

Inheritance diagram for gui2::dialogs::unit_list:

Public Member Functions

 unit_list (std::vector< unit_const_ptr > &unit_list, map_location &scroll_to)
 
- 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 (std::vector< unit_const_ptr > &units, map_location &scroll_to)
 

Private Member Functions

void list_item_clicked ()
 Callbacks. More...
 
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

std::vector< unit_const_ptr > & unit_list_
 
map_locationscroll_to_
 

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 32 of file unit_list.hpp.

Constructor & Destructor Documentation

◆ unit_list()

gui2::dialogs::unit_list::unit_list ( std::vector< unit_const_ptr > &  unit_list,
map_location scroll_to 
)
explicit

Definition at line 46 of file unit_list.cpp.

Referenced by execute(), and gui2::dialogs::show_unit_list().

Member Function Documentation

◆ execute()

static bool gui2::dialogs::unit_list::execute ( std::vector< unit_const_ptr > &  units,
map_location scroll_to 
)
inlinestatic

Definition at line 37 of file unit_list.hpp.

References _(), gui2::show_transient_message(), and unit_list().

Referenced by gui2::dialogs::show_unit_list().

◆ list_item_clicked()

void gui2::dialogs::unit_list::list_item_clicked ( )
private

Callbacks.

Definition at line 175 of file unit_list.cpp.

References gui2::dialogs::modal_dialog::get_window(), and unit_list_.

Referenced by pre_show().

◆ post_show()

void gui2::dialogs::unit_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 188 of file unit_list.cpp.

References gui2::dialogs::modal_dialog::get_retval(), gui2::OK, scroll_to_, and unit_list_.

◆ pre_show()

void gui2::dialogs::unit_list::pre_show ( window window)
overrideprivatevirtual

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ scroll_to_

map_location& gui2::dialogs::unit_list::scroll_to_
private

Definition at line 50 of file unit_list.hpp.

Referenced by post_show().

◆ unit_list_

std::vector<unit_const_ptr>& gui2::dialogs::unit_list::unit_list_
private

Definition at line 48 of file unit_list.hpp.

Referenced by list_item_clicked(), post_show(), and pre_show().


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