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 #include "color.hpp"
20 
21 namespace gui2::dialogs
22 {
23 
24 /**
25  * @ingroup GUIWindowDefinitionWML
26  *
27  * Dialog for editing gamemap labels.
28  * Key |Type |Mandatory|Description
29  * ------------------|---------------|---------|-----------
30  * title | @ref label |yes |Dialog title label.
31  * label | @ref text_box |yes |Input field for the map label.
32  * team_only_toggle | toggle_button |yes |Checkbox for whether to make the label visible to the player's team only or not.
33  */
35 {
36 public:
37  /**
38  * Constructor.
39  *
40  * @param[in, out] text The parameter's usage is:
41  * - Input: The initial value of the label.
42  * - Output: The label text the user entered if
43  * the dialog returns retval::OK
44  * undefined otherwise.
45  * @param immutable Sets immutable_toggle attribute.
46  * @param visible_fog Sets visible_fog_toggle attribute.
47  * @param visible_shroud Sets visible_shroud_toggle attribute.
48  * @param color Sets slider color.
49  * @param category Sets category attribute.
50  */
51  editor_edit_label(std::string& text,
52  bool& immutable,
53  bool& visible_fog,
54  bool& visible_shroud,
55  color_t& color,
56  std::string& category);
57 
58  /** The execute function. See @ref modal_dialog for more information. */
60 
61 private:
63  int load_color_component(uint8_t color_t::* component);
64  void save_color_component(uint8_t color_t::* component, const int value);
65  void register_color_component(std::string widget_id, uint8_t color_t::* component);
66  virtual const std::string& window_id() const override;
67  virtual void pre_show(window& window) override;
68 };
69 } // namespace dialogs
int load_color_component(uint8_t color_t::*component)
Definition: edit_label.cpp:62
editor_edit_label(std::string &text, bool &immutable, bool &visible_fog, bool &visible_shroud, color_t &color, std::string &category)
Constructor.
Definition: edit_label.cpp:32
void register_color_component(std::string widget_id, uint8_t color_t::*component)
Definition: edit_label.cpp:56
virtual const std::string & window_id() const override
The id of the window to build.
Dialog for editing gamemap labels.
Definition: edit_label.hpp:34
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
Definition: edit_label.cpp:50
color_t & color_store
The execute function.
Definition: edit_label.hpp:62
Abstract base class for all modal dialogs.
void save_color_component(uint8_t color_t::*component, const int value)
Definition: edit_label.cpp:66
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:65