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

A Preferences subdialog including a report on the location and size of the game's WML cache, buttons to copy its path to clipboard or browse to it, and the possibility of clearing stale files from the cache or purging it entirely. More...

#include <game_cache_options.hpp>

Inheritance diagram for gui2::dialogs::game_cache_options:

Public Member Functions

 game_cache_options ()
 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
 Returns the cached window exit code. More...
 
void set_retval (int retval)
 Convenience wrapper to set the window's exit code. More...
 
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 clean_cache_callback ()
 
bool clean_cache ()
 
void purge_cache_callback ()
 
bool purge_cache ()
 
void copy_to_clipboard_callback ()
 
void browse_cache_callback ()
 
void update_cache_size_display ()
 
virtual const std::string & window_id () const override
 The id of the window to build. More...
 
virtual void pre_show (window &window) override
 Actions to be taken before showing the window. More...
 
virtual void post_show (window &window) override
 Actions to be taken after the window has been shown. More...
 

Private Attributes

std::string cache_path_
 The display function. More...
 
buttonclean_button_
 
buttonpurge_button_
 
labelsize_label_
 

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

A Preferences subdialog including a report on the location and size of the game's WML cache, buttons to copy its path to clipboard or browse to it, and the possibility of clearing stale files from the cache or purging it entirely.

Key Type MandatoryDescription
path text_box yes Cache dir path.
copy button yes Copies the cache path to clipboard.
browse button yes Browses to the cache path using the platform's file management application.
size label yes Current total size of the cache dir's contents.
clean button yes Cleans the cache, erasing stale files not used by the Wesnoth version presently running the dialog.
purge button yes Purges the cache in its entirety.

Definition at line 40 of file game_cache_options.hpp.

Constructor & Destructor Documentation

◆ game_cache_options()

gui2::dialogs::game_cache_options::game_cache_options ( )

Constructor.

Definition at line 41 of file game_cache_options.cpp.

Member Function Documentation

◆ browse_cache_callback()

void gui2::dialogs::game_cache_options::browse_cache_callback ( )
private

Definition at line 115 of file game_cache_options.cpp.

References cache_path_, and desktop::open_object().

Referenced by pre_show().

◆ clean_cache()

bool gui2::dialogs::game_cache_options::clean_cache ( )
private

◆ clean_cache_callback()

void gui2::dialogs::game_cache_options::clean_cache_callback ( )
private

◆ copy_to_clipboard_callback()

void gui2::dialogs::game_cache_options::copy_to_clipboard_callback ( )
private

Definition at line 110 of file game_cache_options.cpp.

References cache_path_, and desktop::clipboard::copy_to_clipboard().

Referenced by pre_show().

◆ post_show()

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

References size_label_.

◆ pre_show()

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

◆ purge_cache()

bool gui2::dialogs::game_cache_options::purge_cache ( )
private

◆ purge_cache_callback()

void gui2::dialogs::game_cache_options::purge_cache_callback ( )
private

◆ update_cache_size_display()

void gui2::dialogs::game_cache_options::update_cache_size_display ( )
private

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ cache_path_

std::string gui2::dialogs::game_cache_options::cache_path_
private

The display function.

See modal_dialog for more information.

Definition at line 54 of file game_cache_options.hpp.

Referenced by browse_cache_callback(), copy_to_clipboard_callback(), pre_show(), and update_cache_size_display().

◆ clean_button_

button* gui2::dialogs::game_cache_options::clean_button_
private

Definition at line 56 of file game_cache_options.hpp.

Referenced by pre_show(), and update_cache_size_display().

◆ purge_button_

button* gui2::dialogs::game_cache_options::purge_button_
private

Definition at line 57 of file game_cache_options.hpp.

Referenced by pre_show(), and update_cache_size_display().

◆ size_label_

label* gui2::dialogs::game_cache_options::size_label_
private

Definition at line 58 of file game_cache_options.hpp.

Referenced by post_show(), pre_show(), and update_cache_size_display().


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