The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
gui2::tscreenshot_notification Class Reference

#include <screenshot_notification.hpp>

Inheritance diagram for gui2::tscreenshot_notification:
Inheritance graph

Public Member Functions

 tscreenshot_notification (const std::string &path)
 Constructor. More...
 
- Public Member Functions inherited from gui2::tdialog
 tdialog ()
 
virtual ~tdialog ()
 
bool show (CVideo &video, const unsigned auto_close_time=0)
 Shows the window. More...
 
int get_retval () const
 
void set_always_save_fields (const bool always_save_fields)
 
void set_restore (const bool restore)
 

Static Public Member Functions

static void display (const std::string &path, CVideo &video)
 The display function. More...
 

Private Member Functions

virtual const std::stringwindow_id () const
 Inherited from tdialog, implemented by REGISTER_DIALOG. More...
 
void pre_show (twindow &window)
 Inherited from tdialog. More...
 

Private Attributes

const std::string path_
 
const std::string screenshots_dir_path_
 

Additional Inherited Members

- Protected Member Functions inherited from gui2::tdialog
tfield_boolregister_bool (const std::string &id, const bool mandatory, const std::function< bool()> &callback_load_value=std::function< bool()>(), const std::function< void(const bool)> &callback_save_value=std::function< void(const bool)>(), const std::function< void(twidget &)> &callback_change=std::function< void(twidget &)>())
 Creates a new boolean field. More...
 
tfield_boolregister_bool (const std::string &id, const bool mandatory, bool &linked_variable, const std::function< void(twidget &)> &callback_change=std::function< void(twidget &)>())
 Creates a new boolean field. More...
 
tfield_integerregister_integer (const std::string &id, const bool mandatory, const std::function< int()> &callback_load_value=std::function< int()>(), const std::function< void(const int)> &callback_save_value=std::function< void(const int)>())
 Creates a new integer field. More...
 
tfield_integerregister_integer (const std::string &id, const bool mandatory, int &linked_variable)
 Creates a new integer field. More...
 
tfield_textregister_text (const std::string &id, const bool mandatory, const std::function< std::string()> &callback_load_value=std::function< std::string()>(), const std::function< void(const std::string &)> &callback_save_value=std::function< void(const std::string &)>(), const bool capture_focus=false)
 Creates a new text field. More...
 
tfield_textregister_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
 Creates a new text field. More...
 
tfield_labelregister_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup=false)
 Registers a new control as a label. More...
 
tfield_labelregister_image (const std::string &id, const bool mandatory, const std::string &filename)
 Registers a new control as image. More...
 

Detailed Description

Definition at line 23 of file screenshot_notification.hpp.

Constructor & Destructor Documentation

gui2::tscreenshot_notification::tscreenshot_notification ( const std::string path)

Constructor.

Parameters
pathPath to the screenshot file created. The caller should ensure the file exists, otherwise it will be displayed with size 0.

Definition at line 66 of file screenshot_notification.cpp.

References _(), filesystem::file_size(), and utils::si_string().

Referenced by display().

Member Function Documentation

static void gui2::tscreenshot_notification::display ( const std::string path,
CVideo video 
)
inlinestatic

The display function.

See tdialog for more information.

Definition at line 40 of file screenshot_notification.hpp.

References tscreenshot_notification().

void gui2::tscreenshot_notification::pre_show ( twindow window)
privatevirtual
virtual const std::string& gui2::tscreenshot_notification::window_id ( ) const
privatevirtual

Inherited from tdialog, implemented by REGISTER_DIALOG.

Implements gui2::tdialog.

Member Data Documentation

const std::string gui2::tscreenshot_notification::path_
private

Definition at line 46 of file screenshot_notification.hpp.

Referenced by pre_show().

const std::string gui2::tscreenshot_notification::screenshots_dir_path_
private

Definition at line 47 of file screenshot_notification.hpp.

Referenced by pre_show().


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