The Battle for Wesnoth  1.15.1+dev
edit_label.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2010 - 2018 by Iris Morelle <shadowm2006@gmail.com>
3  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 
15 #pragma once
16 
18 
19 namespace gui2
20 {
21 namespace dialogs
22 {
23 
24 class edit_label : public modal_dialog
25 {
26 public:
27  /**
28  * Constructor.
29  *
30  * @param [in, out] label The parameter's usage is:
31  * - Input: The initial value of the label.
32  * - Output: The label text the user entered if
33  * the dialog returns @ref retval::OK
34  * undefined otherwise.
35  * @param [in, out] team_only The parameter's usage is:
36  * - Input: The initial value of the team only
37  * toggle.
38  * - Output: The final value of the team only
39  * toggle if the dialog returns @ref
40  * retval::OK undefined otherwise.
41  */
42  edit_label(std::string& label, bool& team_only);
43 
44  /** The execute function. See @ref modal_dialog for more information. */
46 
47 private:
48  /** Inherited from modal_dialog, implemented by REGISTER_DIALOG. */
49  virtual const std::string& window_id() const override;
50 };
51 } // namespace dialogs
52 } // namespace gui2
Label showing a text.
Definition: label.hpp:32
Generic file dialog.
Definition: field-fwd.hpp:22
edit_label(std::string &label, bool &team_only)
Constructor.
Definition: edit_label.cpp:51
Various uncategorised dialogs.
Abstract base class for all modal dialogs.
virtual const std::string & window_id() const override
The execute function.