The Battle for Wesnoth  1.17.8+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 widget_data& 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() override;
130 
131  /** See @ref widget::layout_children. */
132  virtual void layout_children() override;
133 
134  /** See @ref widget::request_reduce_width. */
135  virtual void request_reduce_width(const unsigned maximum_width) override;
136 
137  /** See @ref widget::find_at. */
138  virtual widget* find_at(const point& coordinate,
139  const bool must_be_active) override;
140 
141  /** See @ref widget::find_at. */
142  virtual const widget* find_at(const point& coordinate,
143  const bool must_be_active) const override;
144 
145  /** See @ref widget::find. */
146  widget* find(const std::string& id, const bool must_be_active) override;
147 
148  /** See @ref widget::find. */
149  const widget* find(const std::string& id,
150  const bool must_be_active) const override;
151 
152  /***** ***** ***** ***** Forwarded to pane_. ***** ***** ****** *****/
153  /**
154  * Sorts the contents of the pane.
155  *
156  * @param compare_functor The functor to use to sort the items.
157  */
158  void sort(const pane::compare_functor_t& compare_functor)
159  {
160  /********************** OUTLINE *******************/
161  pane_->sort(compare_functor);
162  }
163 
164  /**
165  * Filters the contents of the pane.
166  *
167  * if the @p filter_functor returns @c true the item shown, else it's
168  * hidden.
169  *
170  * @param filter_functor The functor to determine whether an item
171  * should be shown or hidden.
172  */
173  void filter(const pane::filter_functor_t& filter_functor)
174  {
175  /********************** OUTLINE *******************/
176  pane_->filter(filter_functor);
177  }
178 
179 private:
180  /** See @ref widget::calculate_best_size. */
181  virtual point calculate_best_size() const override;
182 
183 public:
184  /** See @ref widget::disable_click_dismiss. */
185  bool disable_click_dismiss() const override;
186 
187  /** See @ref widget::create_walker. */
188  virtual iteration::walker_ptr create_walker() override;
189 
190  /**
191  * Returns a grid in the pane.
192  *
193  * @param id The id of the item whose grid to return. The
194  * id is the value returned by
195  * @ref create_item().
196  *
197  * @returns The wanted grid.
198  * @retval nullptr The id isn't associated with an item.
199  */
200  grid* get_grid(const unsigned id);
201 
202  /**
203  * Returns a grid in the pane.
204  *
205  * @param id The id of the item whose grid to return. The
206  * id is the value returned by
207  * @ref create_item().
208  *
209  * @returns The wanted grid.
210  * @retval nullptr The id isn't associated with an item.
211  */
212  const grid* get_grid(const unsigned id) const;
213 
214 private:
215  /** The grid containing our children. */
217 
218  /**
219  * Contains the pane used for adding new items to the matrix.
220  *
221  * The pane is owned by a grid in the content layer.
222  */
224 
225 public:
226  /** Static type getter that does not rely on the widget being constructed. */
227  static const std::string& type();
228 
229 private:
230  /** Inherited from styled_widget, implemented by REGISTER_WIDGET. */
231  virtual const std::string& get_control_type() const override;
232 };
233 
234 // }---------- DEFINITION ---------{
235 
237 {
238 
239  explicit matrix_definition(const config& cfg);
240 
242  {
243  explicit resolution(const config& cfg);
244 
246  };
247 };
248 
249 // }---------- BUILDER -----------{
250 
251 namespace implementation
252 {
253 
255 {
256  explicit builder_matrix(const config& cfg);
257 
259 
260  virtual std::unique_ptr<widget> build() const override;
261 
264 
267 
270 
272 };
273 
274 } // namespace implementation
275 
276 // }------------ END --------------
277 
278 } // 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:43
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:53
void sort(const pane::compare_functor_t &compare_functor)
Sorts the contents of the pane.
Definition: matrix.hpp:158
grid content_
The grid containing our children.
Definition: matrix.hpp:216
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:173
Generic file dialog.
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
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:262
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:263
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:271
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:223
point resolution()
Definition: general.cpp:395
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:35
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
Contains the implementation details for lexical_cast and shouldn&#39;t be used directly.