The Battle for Wesnoth  1.17.0-dev
Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
gui2::dialogs::gamestate_inspector Class Reference

This shows the gamestate inspector. More...

#include <gamestate_inspector.hpp>

Inheritance diagram for gui2::dialogs::gamestate_inspector:

Classes

class  controller
 
class  model
 
class  view
 

Public Member Functions

 gamestate_inspector (const config &vars, const game_events::manager &events, const display_context &dc, const std::string &title="")
 
 DEFINE_SIMPLE_DISPLAY_WRAPPER (gamestate_inspector)
 
- 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

virtual void pre_show (window &window) override
 Actions to be taken before showing the window. More...
 
virtual const std::string & window_id () const override
 The id of the window to build. More...
 

Private Attributes

std::shared_ptr< viewview_
 
std::shared_ptr< modelmodel_
 
std::shared_ptr< controllercontroller_
 
std::string title_
 
const configvars_
 
const game_events::managerevents_
 
const display_contextdc_
 

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

This shows the gamestate inspector.

Key Type MandatoryDescription
inspector_name control yes Name of the inspector.
stuff_list control yes List of various stuff that can be viewed.
inspect control yes The state of the variable or event.
copy button yes A button to copy the state to clipboard.

Definition at line 38 of file gamestate_inspector.hpp.

Constructor & Destructor Documentation

◆ gamestate_inspector()

gui2::dialogs::gamestate_inspector::gamestate_inspector ( const config vars,
const game_events::manager events,
const display_context dc,
const std::string &  title = "" 
)

Definition at line 908 of file gamestate_inspector.cpp.

Member Function Documentation

◆ DEFINE_SIMPLE_DISPLAY_WRAPPER()

gui2::dialogs::gamestate_inspector::DEFINE_SIMPLE_DISPLAY_WRAPPER ( gamestate_inspector  )

◆ pre_show()

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

Actions to be taken before showing the window.

At this point the registered fields are registered and initialized with their initial values.

Parameters
windowThe window to be shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 917 of file gamestate_inspector.cpp.

References gui2::dialogs::single_mode_controller::view().

◆ window_id()

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

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ controller_

std::shared_ptr<controller> gui2::dialogs::gamestate_inspector::controller_
private

Definition at line 55 of file gamestate_inspector.hpp.

◆ dc_

const display_context& gui2::dialogs::gamestate_inspector::dc_
private

◆ events_

const game_events::manager& gui2::dialogs::gamestate_inspector::events_
private

Definition at line 58 of file gamestate_inspector.hpp.

◆ model_

std::shared_ptr<model> gui2::dialogs::gamestate_inspector::model_
private

◆ title_

std::string gui2::dialogs::gamestate_inspector::title_
private

Definition at line 56 of file gamestate_inspector.hpp.

◆ vars_

const config& gui2::dialogs::gamestate_inspector::vars_
private

Definition at line 57 of file gamestate_inspector.hpp.

◆ view_

std::shared_ptr<view> gui2::dialogs::gamestate_inspector::view_
private

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