The Battle for Wesnoth  1.15.12+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 #include "color.hpp"
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  */
34 {
35 public:
36  /**
37  * Constructor.
38  *
39  * @param[in, out] text 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 immutable Sets immutable_toggle attribute.
45  * @param visible_fog Sets visible_fog_toggle attribute.
46  * @param visible_shroud Sets visible_shroud_toggle attribute.
47  * @param color Sets slider color.
48  * @param category Sets category attribute.
49  */
50  editor_edit_label(std::string& text,
51  bool& immutable,
52  bool& visible_fog,
53  bool& visible_shroud,
54  color_t& color,
55  std::string& category);
56 
57  /** The execute function. See @ref modal_dialog for more information. */
59 
60 private:
62  int load_color_component(uint8_t color_t::* component);
63  void save_color_component(uint8_t color_t::* component, const int value);
64  void register_color_component(std::string widget_id, uint8_t color_t::* component);
65  virtual const std::string& window_id() const override;
66  virtual void pre_show(window& window) override;
67 };
68 } // namespace dialogs
int load_color_component(uint8_t color_t::*component)
Definition: edit_label.cpp:61
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:31
void register_color_component(std::string widget_id, uint8_t color_t::*component)
Definition: edit_label.cpp:55
virtual const std::string & window_id() const override
The id of the window to build.
Dialog for editing gamemap labels.
Definition: edit_label.hpp:33
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
Definition: edit_label.cpp:49
color_t & color_store
The execute function.
Definition: edit_label.hpp:61
Abstract base class for all modal dialogs.
void save_color_component(uint8_t color_t::*component, const int value)
Definition: edit_label.cpp:65
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:64