The Battle for Wesnoth  1.17.4+dev
matrix.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2012 - 2022
3  by Mark de Wever <koraq@xs4all.nl>
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 #pragma once
16 
18 #include "gui/widgets/pane.hpp"
20 
23 
24 namespace gui2
25 {
26 
27 // ------------ WIDGET -----------{
28 
29 namespace implementation
30 {
31 struct builder_matrix;
32 }
33 
35 {
36 public:
37  state_default();
38 
39  void set_active(const bool active);
40 
41  bool get_active() const;
42 
43  unsigned get_state() const;
44 
45 protected:
46  /**
47  * Possible states of the widget.
48  *
49  * Note the order of the states must be the same as defined in settings.hpp.
50  */
51  enum state_t {
54  };
55 
56 private:
57  /**
58  * Current state of the widget.
59  *
60  * The state of the widget determines what to render and how the widget
61  * reacts to certain 'events'.
62  */
64 };
65 
66 template <class STATE>
67 class control_NEW : public styled_widget, public STATE
68 {
69 public:
71  const std::string& control_type)
72  : styled_widget(builder, control_type)
73 
74  {
75  }
76 
77  /** See @ref styled_widget::set_active. */
78  virtual void set_active(const bool active) override
79  {
80  STATE::set_active(active);
81  }
82 
83  /** See @ref styled_widget::get_active. */
84  virtual bool get_active() const override
85  {
86  return STATE::get_active();
87  }
88 
89  /** See @ref styled_widget::get_state. */
90  virtual unsigned get_state() const override
91  {
92  return STATE::get_state();
93  }
94 };
95 
97 
98 /**
99  * @ingroup GUIWidgetWML
100  *
101  * List with the matrix specific variables:
102  * Key |Type |Default |Description
103  * -------------------------|------------------------------------------------|------------|-----------
104  * vertical_scrollbar_mode | @ref guivartype_scrollbar_mode "scrollbar_mode"|initial_auto|Determines whether or not to show the scrollbar.
105  * horizontal_scrollbar_mode| @ref guivartype_scrollbar_mode "scrollbar_mode"|initial_auto|Determines whether or not to show the scrollbar.
106  */
107 class matrix : public tbase
108 {
109  friend class debug_layout_graph;
110 
111 public:
112  explicit matrix(const implementation::builder_matrix& builder);
113 
114  /***** ***** ***** ***** Item handling. ***** ***** ****** *****/
115 
116  unsigned create_item(const std::map<std::string, string_map>& item_data,
117  const std::map<std::string, std::string>& tags);
118 
119 
120  /***** ***** ***** ***** Inherited operations. ***** ***** ****** *****/
121 
122  /** See @ref widget::place. */
123  virtual void place(const point& origin, const point& size) override;
124 
125  /** See @ref widget::layout_initialize. */
126  virtual void layout_initialize(const bool full_initialization) override;
127 
128  /** See @ref widget::impl_draw_children. */
129  virtual void impl_draw_children(int x_offset, int y_offset) override;
130 
131  /** See @ref widget::layout_children. */
132  virtual void layout_children() override;
133 
134  /** See @ref widget::child_populate_dirty_list. */
135  virtual void
136  child_populate_dirty_list(window& caller,
137  const std::vector<widget*>& call_stack) override;
138 
139  /** See @ref widget::request_reduce_width. */
140  virtual void request_reduce_width(const unsigned maximum_width) override;
141 
142  /** See @ref widget::find_at. */
143  virtual widget* find_at(const point& coordinate,
144  const bool must_be_active) override;
145 
146  /** See @ref widget::find_at. */
147  virtual const widget* find_at(const point& coordinate,
148  const bool must_be_active) const override;
149 
150  /** See @ref widget::find. */
151  widget* find(const std::string& id, const bool must_be_active) override;
152 
153  /** See @ref widget::find. */
154  const widget* find(const std::string& id,
155  const bool must_be_active) const override;
156 
157  /***** ***** ***** ***** Forwarded to pane_. ***** ***** ****** *****/
158  /**
159  * Sorts the contents of the pane.
160  *
161  * @param compare_functor The functor to use to sort the items.
162  */
163  void sort(const pane::compare_functor_t& compare_functor)
164  {
165  /********************** OUTLINE *******************/
166  pane_->sort(compare_functor);
167  }
168 
169  /**
170  * Filters the contents of the pane.
171  *
172  * if the @p filter_functor returns @c true the item shown, else it's
173  * hidden.
174  *
175  * @param filter_functor The functor to determine whether an item
176  * should be shown or hidden.
177  */
178  void filter(const pane::filter_functor_t& filter_functor)
179  {
180  /********************** OUTLINE *******************/
181  pane_->filter(filter_functor);
182  }
183 
184 private:
185  /** See @ref widget::calculate_best_size. */
186  virtual point calculate_best_size() const override;
187 
188 public:
189  /** See @ref widget::disable_click_dismiss. */
190  bool disable_click_dismiss() const override;
191 
192  /** See @ref widget::create_walker. */
193  virtual iteration::walker_ptr create_walker() override;
194 
195  /**
196  * Returns a grid in the pane.
197  *
198  * @param id The id of the item whose grid to return. The
199  * id is the value returned by
200  * @ref create_item().
201  *
202  * @returns The wanted grid.
203  * @retval nullptr The id isn't associated with an item.
204  */
205  grid* get_grid(const unsigned id);
206 
207  /**
208  * Returns a grid in the pane.
209  *
210  * @param id The id of the item whose grid to return. The
211  * id is the value returned by
212  * @ref create_item().
213  *
214  * @returns The wanted grid.
215  * @retval nullptr The id isn't associated with an item.
216  */
217  const grid* get_grid(const unsigned id) const;
218 
219 private:
220  /** The grid containing our children. */
222 
223  /**
224  * Contains the pane used for adding new items to the matrix.
225  *
226  * The pane is owned by a grid in the content layer.
227  */
229 
230 public:
231  /** Static type getter that does not rely on the widget being constructed. */
232  static const std::string& type();
233 
234 private:
235  /** Inherited from styled_widget, implemented by REGISTER_WIDGET. */
236  virtual const std::string& get_control_type() const override;
237 };
238 
239 // }---------- DEFINITION ---------{
240 
242 {
243 
244  explicit matrix_definition(const config& cfg);
245 
247  {
248  explicit resolution(const config& cfg);
249 
251  };
252 };
253 
254 // }---------- BUILDER -----------{
255 
256 namespace implementation
257 {
258 
260 {
261  explicit builder_matrix(const config& cfg);
262 
264 
265  virtual std::unique_ptr<widget> build() const override;
266 
269 
272 
275 
277 };
278 
279 } // namespace implementation
280 
281 // }------------ END --------------
282 
283 } // namespace gui2
Base class of a resolution, contains the common keys for a resolution.
std::unique_ptr< class walker_base > walker_ptr
Definition: widget.hpp:39
std::shared_ptr< builder_widget > builder_widget_ptr
List with the matrix specific variables: Key Type Default Description vertical_scrollbar_mode scroll...
Definition: matrix.hpp:107
Base class for all widgets.
Definition: widget.hpp:49
void sort(const pane::compare_functor_t &compare_functor)
Sorts the contents of the pane.
Definition: matrix.hpp:163
grid content_
The grid containing our children.
Definition: matrix.hpp:221
std::function< bool(const item &)> filter_functor_t
Definition: pane.hpp:60
void filter(const pane::filter_functor_t &filter_functor)
Filters the contents of the pane.
Definition: matrix.hpp:178
Generic file dialog.
Definition: field-fwd.hpp:23
virtual unsigned get_state() const override
See styled_widget::get_state.
Definition: matrix.hpp:90
Base container class.
Definition: grid.hpp:31
std::size_t size(const std::string &str)
Length in characters of a UTF-8 string.
Definition: unicode.cpp:87
control_NEW(const implementation::builder_styled_widget &builder, const std::string &control_type)
Definition: matrix.hpp:70
static thread_local std::deque< std::string > call_stack
For printing error messages when WFL parsing or evaluation fails, this contains the names of the WFL ...
Definition: function.cpp:47
virtual void set_active(const bool active) override
See styled_widget::set_active.
Definition: matrix.hpp:78
scrollbar_container::scrollbar_mode vertical_scrollbar_mode
Definition: matrix.hpp:267
virtual std::unique_ptr< widget > build() const =0
A pane is a container where new members can be added and removed during run-time. ...
Definition: pane.hpp:43
scrollbar_container::scrollbar_mode horizontal_scrollbar_mode
Definition: matrix.hpp:268
control_NEW< state_default > tbase
Definition: matrix.hpp:96
virtual bool get_active() const override
See styled_widget::get_active.
Definition: matrix.hpp:84
state_t state_
Current state of the widget.
Definition: matrix.hpp:63
Holds a 2D point.
Definition: point.hpp:24
Base class for all visible items.
std::function< bool(const item &, const item &)> compare_functor_t
Definition: pane.hpp:58
std::shared_ptr< builder_grid > builder_grid_ptr
scrollbar_mode
The way to handle the showing or hiding of the scrollbar.
builder_widget_ptr builder_main
Definition: matrix.hpp:276
state_t
Possible states of the widget.
Definition: matrix.hpp:51
pane * pane_
Contains the pane used for adding new items to the matrix.
Definition: matrix.hpp:228
point resolution()
Definition: general.cpp:399
std::unique_ptr< window > build(const builder_window::window_resolution &definition)
Builds a window.
map_location coordinate
Contains an x and y coordinate used for starting positions in maps.
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:60
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:65
Contains the implementation details for lexical_cast and shouldn&#39;t be used directly.