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

Dialog to display 'The End' at the end of a campaign. More...

#include <outro.hpp>

Inheritance diagram for gui2::dialogs::outro:
Inheritance graph

Public Member Functions

 outro (const std::string &text, unsigned int duration)
 
- 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
 Displays a simple fading screen with any user-provided text. More...
 
virtual void pre_show (window &window) override
 Inherited from modal_dialog. More...
 
virtual void post_show (window &window) override
 Inherited from modal_dialog. More...
 
void set_next_draw ()
 
void draw_callback (window &window)
 

Private Attributes

std::string text_
 
unsigned int duration_
 
int fade_step_
 
bool fading_in_
 
std::size_t timer_id_
 
std::size_t next_draw_
 

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 to display 'The End' at the end of a campaign.

Definition at line 25 of file outro.hpp.

Constructor & Destructor Documentation

◆ outro()

gui2::dialogs::outro::outro ( const std::string &  text,
unsigned int  duration 
)

Definition at line 33 of file outro.cpp.

References _().

Member Function Documentation

◆ draw_callback()

void gui2::dialogs::outro::draw_callback ( window window)
private

◆ post_show()

void gui2::dialogs::outro::post_show ( window window)
overrideprivatevirtual

Inherited from modal_dialog.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 111 of file outro.cpp.

References gui2::remove_timer(), and timer_id_.

◆ pre_show()

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

◆ set_next_draw()

void gui2::dialogs::outro::set_next_draw ( )
private

Definition at line 60 of file outro.cpp.

References next_draw_.

Referenced by draw_callback(), and pre_show().

◆ window_id()

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

Displays a simple fading screen with any user-provided text.

Used after the end of single-player campaigns.

Parameters
textText to display, centered on the screen.
durationIn milliseconds, for how much time the text will be displayed on screen.Inherited from modal_dialog, implemented by REGISTER_DIALOG.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ duration_

unsigned int gui2::dialogs::outro::duration_
private

Definition at line 57 of file outro.hpp.

Referenced by draw_callback().

◆ fade_step_

int gui2::dialogs::outro::fade_step_
private

Definition at line 58 of file outro.hpp.

Referenced by draw_callback().

◆ fading_in_

bool gui2::dialogs::outro::fading_in_
private

Definition at line 60 of file outro.hpp.

Referenced by draw_callback().

◆ next_draw_

std::size_t gui2::dialogs::outro::next_draw_
private

Definition at line 63 of file outro.hpp.

Referenced by draw_callback(), and set_next_draw().

◆ text_

std::string gui2::dialogs::outro::text_
private

Definition at line 55 of file outro.hpp.

Referenced by pre_show().

◆ timer_id_

std::size_t gui2::dialogs::outro::timer_id_
private

Definition at line 62 of file outro.hpp.

Referenced by draw_callback(), and post_show().


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