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

#include <end_credits.hpp>

Inheritance diagram for gui2::dialogs::end_credits:
Inheritance graph

Public Member Functions

 end_credits (const std::string &campaign="")
 
- 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 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...
 
void timer_callback ()
 
void key_press_callback (const SDL_Keycode key)
 

Private Attributes

const std::string & focus_on_
 
std::vector< std::string > backgrounds_
 
scroll_labeltext_widget_
 
int scroll_speed_
 
uint32_t last_scroll_
 

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 31 of file end_credits.hpp.

Constructor & Destructor Documentation

◆ end_credits()

gui2::dialogs::end_credits::end_credits ( const std::string &  campaign = "")
explicit

Definition at line 41 of file end_credits.cpp.

Member Function Documentation

◆ key_press_callback()

void gui2::dialogs::end_credits::key_press_callback ( const SDL_Keycode  key)
private

Definition at line 135 of file end_credits.cpp.

References scroll_speed_.

Referenced by pre_show().

◆ pre_show()

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

◆ timer_callback()

void gui2::dialogs::end_credits::timer_callback ( )
private

◆ window_id()

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

Inherited from modal_dialog, implemented by REGISTER_DIALOG.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ backgrounds_

std::vector<std::string> gui2::dialogs::end_credits::backgrounds_
private

Definition at line 50 of file end_credits.hpp.

Referenced by pre_show().

◆ focus_on_

const std::string& gui2::dialogs::end_credits::focus_on_
private

Definition at line 48 of file end_credits.hpp.

Referenced by pre_show().

◆ last_scroll_

uint32_t gui2::dialogs::end_credits::last_scroll_
private

Definition at line 57 of file end_credits.hpp.

Referenced by pre_show(), and timer_callback().

◆ scroll_speed_

int gui2::dialogs::end_credits::scroll_speed_
private

Definition at line 55 of file end_credits.hpp.

Referenced by key_press_callback(), and timer_callback().

◆ text_widget_

scroll_label* gui2::dialogs::end_credits::text_widget_
private

Definition at line 52 of file end_credits.hpp.

Referenced by pre_show(), and timer_callback().


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