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 | List of all members
gui2::tedit_label Class Reference

#include <edit_label.hpp>

Inheritance diagram for gui2::tedit_label:
Inheritance graph

Public Member Functions

 tedit_label (std::string &label, bool &team_only)
 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 &label, bool &team_only, CVideo &video)
 The execute function see tdialog for more information. More...
 

Private Member Functions

virtual const std::stringwindow_id () const
 Inherited from tdialog, implemented by REGISTER_DIALOG. More...
 

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 23 of file edit_label.hpp.

Constructor & Destructor Documentation

gui2::tedit_label::tedit_label ( std::string label,
bool &  team_only 
)

Constructor.

Parameters
[in,out]labelThe 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.
[in,out]team_onlyThe parameter's usage is:
  • Input: The initial value of the team only toggle.
  • Output: The final value of the team only toggle if the dialog returns twindow::OK undefined otherwise.

Definition at line 49 of file edit_label.cpp.

Referenced by execute().

Member Function Documentation

static bool gui2::tedit_label::execute ( std::string label,
bool &  team_only,
CVideo video 
)
inlinestatic

The execute function see tdialog for more information.

Definition at line 44 of file edit_label.hpp.

References tedit_label().

Referenced by events::menu_handler::label_terrain().

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

Inherited from tdialog, implemented by REGISTER_DIALOG.

Implements gui2::tdialog.


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