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

#include <screenshot_notification.hpp>

Inheritance diagram for gui2::dialogs::screenshot_notification:
Inheritance graph

Public Member Functions

 screenshot_notification (const std::string &path, surface screenshot)
 Constructor. 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
 
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

void save_screenshot ()
 
void keypress_callback (bool &handled, const SDL_Keycode key)
 
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...
 

Private Attributes

const std::string path_
 The display function. More...
 
const std::string screenshots_dir_path_
 
surface screenshot_
 

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 25 of file screenshot_notification.hpp.

Constructor & Destructor Documentation

◆ screenshot_notification()

gui2::dialogs::screenshot_notification::screenshot_notification ( const std::string &  path,
surface  screenshot 
)

Constructor.

Parameters
pathPath to the screenshot file to create.
screenshotScreenshot to save.

Definition at line 76 of file screenshot_notification.cpp.

Member Function Documentation

◆ keypress_callback()

void gui2::dialogs::screenshot_notification::keypress_callback ( bool &  handled,
const SDL_Keycode  key 
)
private

Definition at line 153 of file screenshot_notification.cpp.

References save_screenshot().

Referenced by pre_show().

◆ pre_show()

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

◆ save_screenshot()

void gui2::dialogs::screenshot_notification::save_screenshot ( )
private

◆ window_id()

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

Inherited from modal_dialog, implemented by REGISTER_DIALOG.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ path_

const std::string gui2::dialogs::screenshot_notification::path_
private

The display function.

See modal_dialog for more information.

Definition at line 44 of file screenshot_notification.hpp.

Referenced by pre_show().

◆ screenshot_

surface gui2::dialogs::screenshot_notification::screenshot_
private

Definition at line 46 of file screenshot_notification.hpp.

Referenced by save_screenshot().

◆ screenshots_dir_path_

const std::string gui2::dialogs::screenshot_notification::screenshots_dir_path_
private

Definition at line 45 of file screenshot_notification.hpp.

Referenced by pre_show(), and save_screenshot().


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