The Battle for Wesnoth  1.19.0+dev
edit_label.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2010 - 2024
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 class edit_label : public modal_dialog
24 {
25 public:
26  /**
27  * Constructor.
28  *
29  * @param [in, out] label The parameter's usage is:
30  * - Input: The initial value of the label.
31  * - Output: The label text the user entered if
32  * the dialog returns retval::OK
33  * undefined otherwise.
34  * @param [in, out] team_only The parameter's usage is:
35  * - Input: The initial value of the team only
36  * toggle.
37  * - Output: The final value of the team only
38  * toggle if the dialog returns retval::OK undefined otherwise.
39  */
40  edit_label(std::string& label, bool& team_only);
41 
42  /** The execute function. See @ref modal_dialog for more information. */
44 
45 private:
46  virtual const std::string& window_id() const override;
47 };
48 } // namespace dialogs
virtual const std::string & window_id() const override
The execute function.
edit_label(std::string &label, bool &team_only)
Constructor.
Definition: edit_label.cpp:26
Abstract base class for all modal dialogs.
#define DEFINE_SIMPLE_EXECUTE_WRAPPER(dialog)
Adds a bare-bonesstatic execute function to a dialog class that immediately invokes and return the re...