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

#include <edit_text.hpp>

Inheritance diagram for gui2::dialogs::edit_text:
Inheritance graph

Public Member Functions

 edit_text (const std::string &title, const std::string &label, std::string &text, bool disallow_empty=false)
 Constructor. 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)
 

Private Member Functions

virtual const std::string & window_id () const override
 Executes the dialog. More...
 
virtual void pre_show (window &window) override
 Actions to be taken before showing the window. More...
 
void on_text_change ()
 

Private Attributes

bool disallow_empty_
 

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 24 of file edit_text.hpp.

Constructor & Destructor Documentation

◆ edit_text()

gui2::dialogs::edit_text::edit_text ( const std::string &  title,
const std::string &  label,
std::string &  text,
bool  disallow_empty = false 
)

Constructor.

Parameters
titleThe dialog's title.
labelLabel of the text field.
[in,out]textThe parameter's usage is:
  • Input: The initial value of the text field.
  • Output: The new unit name the user entered if the dialog returns retval::OK, undefined otherwise.
disallow_emptyWhether to prevent the user from entering a string that is empty or consists only of whitespace.

Definition at line 49 of file edit_text.cpp.

Member Function Documentation

◆ on_text_change()

void gui2::dialogs::edit_text::on_text_change ( )
private

◆ pre_show()

void gui2::dialogs::edit_text::pre_show ( window window)
overrideprivatevirtual

Actions to be taken before showing the window.

At this point the registered fields are registered and initialized with their initial values.

Parameters
windowThe window to be shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 60 of file edit_text.cpp.

References gui2::event::connect_signal_notify_modified(), disallow_empty_, and on_text_change().

◆ window_id()

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

Executes the dialog.

See modal_dialog for more information.

Parameters
[in,out]textThe parameter's usage is:
  • Input: The initial value of the unit name.
  • Output: The new unit name the user entered if this method returns true, undefined otherwise.Inherited from modal_dialog, implemented by REGISTER_DIALOG.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ disallow_empty_

bool gui2::dialogs::edit_text::disallow_empty_
private

Definition at line 65 of file edit_text.hpp.

Referenced by pre_show().


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