gui2::dialogs::edit_label Class Reference

Dialog for editing gamemap labels. More...

#include <edit_label.hpp>

Inheritance diagram for gui2::dialogs::edit_label:

Public Member Functions
	edit_label (std::string &label, bool &team_only)
	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...
window *	get_window () const
	Returns a pointer to the dialog's window. More...
int	get_retval () const
	Returns the cached window exit code. More...
void	set_retval (int retval)
	Convenience wrapper to set the window's exit code. More...
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
	The execute function. More...

Additional Inherited Members
Protected Member Functions inherited from gui2::dialogs::modal_dialog
field_bool *	register_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_bool *	register_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_integer *	register_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_integer *	register_integer (const std::string &id, const bool mandatory, int &linked_variable)
	Creates a new integer field. More...
field_text *	register_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_text *	register_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
	Creates a new text field. More...
field_label *	register_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_label *	register_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< window >	window_
	The window object build for this dialog. More...

Detailed Description

Dialog for editing gamemap labels.

Key	Type	Mandatory	Description
title	label	yes	Dialog title label.
label	text_box	yes	Input field for the map label.
team_only_toggle	toggle_button	yes	Checkbox for whether to make the label visible to the player's team only or not.

Definition at line 32 of file edit_label.hpp.

Constructor & Destructor Documentation

edit_label()

gui2::dialogs::edit_label::edit_label	(	std::string &	label,
		bool &	team_only
	)

Constructor.

Parameters

[in,out]	label	The parameter's usage is: Input: The initial value of the label. Output: The label text the user entered if the dialog returns retval::OK undefined otherwise.
[in,out]	team_only	The 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 retval::OK undefined otherwise.

Definition at line 26 of file edit_label.cpp.

Member Function Documentation

window_id()

virtual const std::string& gui2::dialogs::edit_label::window_id ( ) const

overrideprivatevirtual

The execute function.

See modal_dialog for more information.

Implements gui2::dialogs::modal_dialog.

---

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

• gui/dialogs/edit_label.hpp
• gui/dialogs/edit_label.cpp