The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
gui2::teditor_edit_label Class Reference

#include <edit_label.hpp>

Inheritance diagram for gui2::teditor_edit_label:
Inheritance graph

Public Member Functions

 teditor_edit_label (std::string &text, bool &immutable, bool &visible_fog, bool &visible_shroud, SDL_Color &color, std::string &category)
 Constructor. More...
 
- Public Member Functions inherited from gui2::tdialog
 tdialog ()
 
virtual ~tdialog ()
 
bool show (CVideo &video, const unsigned auto_close_time=0)
 Shows the window. More...
 
int get_retval () const
 
void set_always_save_fields (const bool always_save_fields)
 
void set_restore (const bool restore)
 

Static Public Member Functions

static bool execute (std::string &text, bool &immutable, bool &visible_fog, bool &visible_shroud, SDL_Color &color, std::string &category, CVideo &video)
 The execute function see tdialog for more information. More...
 

Private Member Functions

int load_color_component (Uint8 SDL_Color::*component)
 
void save_color_component (Uint8 SDL_Color::*component, const int value)
 
void register_color_component (std::string widget_id, Uint8 SDL_Color::*component)
 
virtual const std::stringwindow_id () const
 Inherited from tdialog, implemented by REGISTER_DIALOG. More...
 

Private Attributes

SDL_Color & color_store
 

Additional Inherited Members

- Protected Member Functions inherited from gui2::tdialog
tfield_boolregister_bool (const std::string &id, const bool mandatory, const std::function< bool()> &callback_load_value=std::function< bool()>(), const std::function< void(const bool)> &callback_save_value=std::function< void(const bool)>(), const std::function< void(twidget &)> &callback_change=std::function< void(twidget &)>())
 Creates a new boolean field. More...
 
tfield_boolregister_bool (const std::string &id, const bool mandatory, bool &linked_variable, const std::function< void(twidget &)> &callback_change=std::function< void(twidget &)>())
 Creates a new boolean field. More...
 
tfield_integerregister_integer (const std::string &id, const bool mandatory, const std::function< int()> &callback_load_value=std::function< int()>(), const std::function< void(const int)> &callback_save_value=std::function< void(const int)>())
 Creates a new integer field. More...
 
tfield_integerregister_integer (const std::string &id, const bool mandatory, int &linked_variable)
 Creates a new integer field. More...
 
tfield_textregister_text (const std::string &id, const bool mandatory, const std::function< std::string()> &callback_load_value=std::function< std::string()>(), const std::function< void(const std::string &)> &callback_save_value=std::function< void(const std::string &)>(), const bool capture_focus=false)
 Creates a new text field. More...
 
tfield_textregister_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
 Creates a new text field. More...
 
tfield_labelregister_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup=false)
 Registers a new control as a label. More...
 
tfield_labelregister_image (const std::string &id, const bool mandatory, const std::string &filename)
 Registers a new control as image. More...
 

Detailed Description

Definition at line 24 of file edit_label.hpp.

Constructor & Destructor Documentation

gui2::teditor_edit_label::teditor_edit_label ( std::string text,
bool &  immutable,
bool &  visible_fog,
bool &  visible_shroud,
SDL_Color &  color,
std::string category 
)

Constructor.

Parameters
[in,out]textThe parameter's usage is:
  • Input: The initial value of the label.
  • Output: The label text the user entered if the dialog returns twindow::OK undefined otherwise.

Definition at line 52 of file edit_label.cpp.

References g.

Referenced by execute().

Member Function Documentation

static bool gui2::teditor_edit_label::execute ( std::string text,
bool &  immutable,
bool &  visible_fog,
bool &  visible_shroud,
SDL_Color &  color,
std::string category,
CVideo video 
)
inlinestatic

The execute function see tdialog for more information.

Definition at line 44 of file edit_label.hpp.

References teditor_edit_label().

int gui2::teditor_edit_label::load_color_component ( Uint8 SDL_Color::*  component)
private

Definition at line 89 of file edit_label.cpp.

References color_store.

Referenced by register_color_component().

void gui2::teditor_edit_label::register_color_component ( std::string  widget_id,
Uint8 SDL_Color::*  component 
)
private
void gui2::teditor_edit_label::save_color_component ( Uint8 SDL_Color::*  component,
const int  value 
)
private

Definition at line 93 of file edit_label.cpp.

References color_store.

Referenced by register_color_component().

virtual const std::string& gui2::teditor_edit_label::window_id ( ) const
privatevirtual

Inherited from tdialog, implemented by REGISTER_DIALOG.

Implements gui2::tdialog.

Member Data Documentation

SDL_Color& gui2::teditor_edit_label::color_store
private

Definition at line 57 of file edit_label.hpp.

Referenced by load_color_component(), and save_color_component().


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