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

#include <unit_advance.hpp>

Inheritance diagram for gui2::dialogs::unit_advance:
Inheritance graph

Public Member Functions

 unit_advance (const unit_ptr_vector &samples, std::size_t real)
 
int get_selected_index () const
 
- 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
 
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 Types

typedef std::vector< unit_const_ptrunit_ptr_vector
 

Private Member Functions

virtual const std::string & window_id () const override
 Inherited from modal_dialog, implemented by REGISTER_DIALOG. More...
 
virtual void pre_show (window &window) override
 Inherited from modal_dialog. More...
 
virtual void post_show (window &window) override
 Actions to be taken after the window has been shown. More...
 
void list_item_clicked (window &window)
 
void show_help ()
 

Private Attributes

const unit_ptr_vectorpreviews_
 
std::size_t selected_index_
 
std::size_t last_real_advancement_
 

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 24 of file unit_advance.hpp.

Member Typedef Documentation

◆ unit_ptr_vector

Definition at line 26 of file unit_advance.hpp.

Constructor & Destructor Documentation

◆ unit_advance()

gui2::dialogs::unit_advance::unit_advance ( const unit_ptr_vector samples,
std::size_t  real 
)

Definition at line 38 of file unit_advance.cpp.

Member Function Documentation

◆ get_selected_index()

int gui2::dialogs::unit_advance::get_selected_index ( ) const
inline

◆ list_item_clicked()

void gui2::dialogs::unit_advance::list_item_clicked ( window window)
private

Definition at line 96 of file unit_advance.cpp.

References previews_.

Referenced by get_selected_index(), and pre_show().

◆ post_show()

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

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

Referenced by get_selected_index().

◆ pre_show()

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

◆ show_help()

void gui2::dialogs::unit_advance::show_help ( )
private

Definition at line 109 of file unit_advance.cpp.

References help::show_help().

Referenced by get_selected_index(), and pre_show().

◆ window_id()

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

Inherited from modal_dialog, implemented by REGISTER_DIALOG.

Implements gui2::dialogs::modal_dialog.

Referenced by get_selected_index().

Member Data Documentation

◆ last_real_advancement_

std::size_t gui2::dialogs::unit_advance::last_real_advancement_
private

Definition at line 49 of file unit_advance.hpp.

Referenced by pre_show().

◆ previews_

const unit_ptr_vector& gui2::dialogs::unit_advance::previews_
private

Definition at line 47 of file unit_advance.hpp.

Referenced by list_item_clicked(), and pre_show().

◆ selected_index_

std::size_t gui2::dialogs::unit_advance::selected_index_
private

Definition at line 49 of file unit_advance.hpp.

Referenced by get_selected_index(), and post_show().


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