The Battle for Wesnoth  1.15.0+dev
Public Member Functions | Private Member Functions | List of all members
gui2::field_text Class Reference

Specialized field class for text. More...

#include <field.hpp>

Inheritance diagram for gui2::field_text:
Inheritance graph

Public Member Functions

 field_text (const std::string &id, const bool mandatory, const std::function< std::string()> &callback_load_value, const std::function< void(const std::string &)> &callback_save_value)
 
 field_text (const std::string &id, const bool mandatory, std::string &linked_variable)
 
- Public Member Functions inherited from gui2::field< std::string, text_box_base, const std::string &>
 field (const std::string &id, const bool mandatory, const std::function< std::string()> &callback_load_value, const std::function< void(const std::string &)> &callback_save_value)
 Constructor. More...
 
 field (const std::string &id, const bool mandatory, std::string &linked_variable)
 Constructor. More...
 
 field (const std::string &id, const bool mandatory, const std::string &value)
 Constructor. More...
 
void widget_restore (window &window)
 Inherited from field_base. More...
 
void set_widget_value (window &window, const std::string & value)
 Sets the value of the field. More...
 
void set_cache_value (const std::string & value)
 Sets the value of the field. More...
 
void widget_save (window &window)
 Inherited from field_base. More...
 
std::string get_widget_value (window &window)
 Gets the value of the field. More...
 
- Public Member Functions inherited from gui2::field_base
 field_base (const std::string &id, const bool mandatory)
 Constructor. More...
 
virtual ~field_base ()
 
void attach_to_window (window &window)
 Attaches the field to a window. More...
 
void widget_init (window &window)
 Initializes the widget. More...
 
void widget_finalize (window &window)
 Finalizes the widget. More...
 
void detach_from_window ()
 Detaches the field from a window. More...
 
void widget_set_enabled (window &window, const bool enable, const bool sync)
 Enables a widget. More...
 
const std::string & id () const
 
bool is_mandatory () const
 
styled_widgetget_widget ()
 
const styled_widgetget_widget () const
 

Private Member Functions

void finalize_specialized (window &window)
 Overridden from field_base. More...
 

Detailed Description

Specialized field class for text.

Definition at line 592 of file field.hpp.

Constructor & Destructor Documentation

◆ field_text() [1/2]

gui2::field_text::field_text ( const std::string &  id,
const bool  mandatory,
const std::function< std::string()> &  callback_load_value,
const std::function< void(const std::string &)> &  callback_save_value 
)
inline

Definition at line 595 of file field.hpp.

◆ field_text() [2/2]

gui2::field_text::field_text ( const std::string &  id,
const bool  mandatory,
std::string &  linked_variable 
)
inline

Definition at line 605 of file field.hpp.

Member Function Documentation

◆ finalize_specialized()

void gui2::field_text::finalize_specialized ( window window)
inlineprivatevirtual

Overridden from field_base.

Reimplemented from gui2::field_base.

Definition at line 615 of file field.hpp.

References gui2::window::find(), and gui2::text_box::save_to_history().


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