The Battle for Wesnoth  1.17.0-dev
edit_label.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2010 - 2021
3  by Iris Morelle <shadowm2006@gmail.com>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 #pragma once
17 
19 
20 namespace gui2::dialogs
21 {
22 
23 /**
24  * @ingroup GUIWindowDefinitionWML
25  *
26  * Dialog for editing gamemap labels.
27  * Key |Type |Mandatory|Description
28  * ------------------|---------------|---------|-----------
29  * title | @ref label |yes |Dialog title label.
30  * label | @ref text_box |yes |Input field for the map label.
31  * team_only_toggle | toggle_button |yes |Checkbox for whether to make the label visible to the player's team only or not.
32  */
33 class edit_label : public modal_dialog
34 {
35 public:
36  /**
37  * Constructor.
38  *
39  * @param [in, out] label The parameter's usage is:
40  * - Input: The initial value of the label.
41  * - Output: The label text the user entered if
42  * the dialog returns retval::OK
43  * undefined otherwise.
44  * @param [in, out] team_only The parameter's usage is:
45  * - Input: The initial value of the team only
46  * toggle.
47  * - Output: The final value of the team only
48  * toggle if the dialog returns retval::OK undefined otherwise.
49  */
50  edit_label(std::string& label, bool& team_only);
51 
52  /** The execute function. See @ref modal_dialog for more information. */
54 
55 private:
56  virtual const std::string& window_id() const override;
57 };
58 } // namespace dialogs
A label displays a text, the text can be wrapped but no scrollbars are provided.
Definition: label.hpp:57
Dialog for editing gamemap labels.
Definition: edit_label.hpp:33
edit_label(std::string &label, bool &team_only)
Constructor.
Definition: edit_label.cpp:27
Abstract base class for all modal dialogs.
virtual const std::string & window_id() const override
The execute function.