The Battle for Wesnoth  1.15.2+dev
window_private.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2009 - 2018 by Mark de Wever <koraq@xs4all.nl>
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 
17 /**
18  * @file
19  * Helper for header for the window.
20  *
21  * @note This file should only be included by window.cpp.
22  *
23  * This file is being used for a small experiment similar like
24  * gui/widgets/grid_private.hpp.
25  */
26 
27 #include "gui/widgets/window.hpp"
28 
29 namespace gui2
30 {
31 
32 /**
33  * Helper to implement private functions without modifying the header.
34  *
35  * The class is a helper to avoid recompilation and only has static
36  * functions.
37  */
39 {
40  /**
41  * Layouts the window.
42  *
43  * This part handles the actual layouting of the window.
44  *
45  * See @ref layout_algorithm for more information.
46  *
47  * @param window The window to operate upon.
48  * @param maximum_width The maximum width of the window.
49  * @param maximum_height The maximum height of the window.
50  */
51  static void layout(window& window,
52  const unsigned maximum_width,
53  const unsigned maximum_height);
54 };
55 
56 } // namespace gui2
This file contains the window object, this object is a top level container which has the event manage...
Generic file dialog.
Definition: field-fwd.hpp:22
Helper to implement private functions without modifying the header.
static void layout(window &window, const unsigned maximum_width, const unsigned maximum_height)
Layouts the window.
Definition: window.cpp:1202
base class of top level items, the only item which needs to store the final canvases to draw on ...
Definition: window.hpp:62