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

Specialized field class for a styled_widget, used for labels and images. More...

#include <field.hpp>

Inheritance diagram for gui2::field_label:
Inheritance graph

Public Member Functions

 field_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup)
 
- Public Member Functions inherited from gui2::field< std::string, styled_widget, 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 init_specialized (window &window)
 Overridden from field_base. More...
 

Private Attributes

bool use_markup_
 Whether or not the label uses markup. More...
 

Detailed Description

Specialized field class for a styled_widget, used for labels and images.

Definition at line 626 of file field.hpp.

Constructor & Destructor Documentation

◆ field_label()

gui2::field_label::field_label ( const std::string &  id,
const bool  mandatory,
const std::string &  text,
const bool  use_markup 
)
inline

Definition at line 629 of file field.hpp.

Member Function Documentation

◆ init_specialized()

void gui2::field_label::init_specialized ( window window)
inlineprivatevirtual

Overridden from field_base.

Reimplemented from gui2::field_base.

Definition at line 643 of file field.hpp.

References gui2::field_base::id().

Member Data Documentation

◆ use_markup_

bool gui2::field_label::use_markup_
private

Whether or not the label uses markup.

Definition at line 640 of file field.hpp.


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