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

#include <lua_interpreter.hpp>

Inheritance diagram for gui2::dialogs::lua_interpreter:
Inheritance graph

Classes

class  controller
 The controller is responsible to hold all the input widgets, and a pointer to the model and view. More...
 
class  input_model
 The input_model keeps track of what commands were executed before, and figures out what should be displayed when the user presses up / down arrows in the input. More...
 
class  lua_model
 The lua model is responsible to interact with the lua kernel base and keep track of what should be displayed in the console. More...
 
class  view
 

Public Types

enum  WHICH_KERNEL { APP, GAME }
 

Public Member Functions

 lua_interpreter (lua_kernel_base &lk)
 
virtual void pre_show (window &window) override
 Inherited from modal_dialog. 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)
 

Static Public Member Functions

static void display (lua_kernel_base *lk)
 Display a new console, using given video and lua kernel. More...
 
static void display (WHICH_KERNEL which)
 Helper function to assist those callers which don't want to include resources.hpp. More...
 

Private Member Functions

virtual const std::string & window_id () const override
 Inherited from modal_dialog, implemented by REGISTER_DIALOG. More...
 

Private Attributes

const std::unique_ptr< controllercontroller_
 

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 26 of file lua_interpreter.hpp.

Member Enumeration Documentation

◆ WHICH_KERNEL

Enumerator
APP 
GAME 

Definition at line 39 of file lua_interpreter.hpp.

Constructor & Destructor Documentation

◆ lua_interpreter()

gui2::dialogs::lua_interpreter::lua_interpreter ( lua_kernel_base lk)

Definition at line 727 of file lua_interpreter.cpp.

References LOG_LUA.

Referenced by display().

Member Function Documentation

◆ display() [1/2]

void gui2::dialogs::lua_interpreter::display ( lua_kernel_base lk)
static

◆ display() [2/2]

void gui2::dialogs::lua_interpreter::display ( lua_interpreter::WHICH_KERNEL  which)
static

Helper function to assist those callers which don't want to include resources.hpp.

Definition at line 704 of file lua_interpreter.cpp.

References APP, display(), GAME, plugins_manager::get(), and resources::lua_kernel.

◆ pre_show()

void gui2::dialogs::lua_interpreter::pre_show ( window window)
overridevirtual

Inherited from modal_dialog.

Bind the controller, initialize one of the static labels with info about this kernel, and update the view.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 713 of file lua_interpreter.cpp.

References controller_, LOG_LUA, gui2::dialogs::modal_dialog::register_text(), and gui2::styled_widget::set_label().

◆ window_id()

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

Inherited from modal_dialog, implemented by REGISTER_DIALOG.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ controller_

const std::unique_ptr<controller> gui2::dialogs::lua_interpreter::controller_
private

Definition at line 43 of file lua_interpreter.hpp.

Referenced by pre_show().


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