1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/*
* The ManaPlus Client
* Copyright (C) 2007-2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
* Copyright (C) 2011-2014 The ManaPlus Developers
*
* This file is part of The ManaPlus Client.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef GUI_WIDGETS_LAYOUT_H
#define GUI_WIDGETS_LAYOUT_H
#include "gui/widgets/layoutcell.h"
#include <vector>
#include "localconsts.h"
class BasicContainer2;
class Widget;
/**
* This class contains a rectangular array of cells.
*/
class LayoutArray final
{
friend class LayoutCell;
public:
LayoutArray();
~LayoutArray();
/**
* Returns a reference on the cell at given position.
*/
LayoutCell &at(const int x, const int y,
const int w = 1, const int h = 1) A_WARN_UNUSED;
/**
* Places a widget in a given cell.
* @param w number of columns the widget spawns.
* @param h number of rows the widget spawns.
* @note When @a w is 1, the width of column @a x is reset to zero if
* it was AUTO_DEF. Similarly for @a h.
*/
LayoutCell &place(Widget *const widget, const int x, const int y,
const int w = 1, const int h = 1);
/**
* Sets the minimum width of a column.
*/
void setColWidth(const int n, const int w);
/**
* Sets the minimum height of a row.
*/
void setRowHeight(const int n, const int h);
/**
* Sets the widths of two columns to the maximum of their widths.
*/
void matchColWidth(const int n1, const int n2);
/**
* Spawns a cell over several columns/rows.
*/
void extend(const int x, const int y, const int w, const int h);
/**
* Computes and sets the positions of all the widgets.
* @param nW width of the array, used to resize the AUTO_ columns.
* @param nH height of the array, used to resize the AUTO_ rows.
*/
void reflow(const int nX, const int nY, const int nW, const int nH);
private:
// Copy not allowed, as the array owns all its cells.
explicit LayoutArray(LayoutArray const &);
LayoutArray &operator=(LayoutArray const &);
/**
* Gets the position and size of a widget along a given axis
*/
void align(int &restrict pos, int &restrict size, const int dim,
LayoutCell const &restrict cell,
const int *restrict const sizes, const int sizeCount) const;
/**
* Ensures the private vectors are large enough.
*/
void resizeGrid(int w, const int h);
/**
* Gets the column/row sizes along a given axis.
* @param upp target size for the array. Ignored if AUTO_DEF.
*/
std::vector<int> getSizes(const int dim, int upp) const A_WARN_UNUSED;
/**
* Gets the total size along a given axis.
*/
int getSize(const int dim) const A_WARN_UNUSED;
std::vector<int> mSizes[2];
std::vector< std::vector < LayoutCell * > > mCells;
int mSpacing;
};
/**
* This class is an helper for setting the position of widgets. They are
* positioned along the cells of some rectangular tables. The layout may either
* be a single table or a tree of nested tables.
*
* The size of a given table column can either be set manually or be chosen
* from the widest widget of the column. An empty column has a AUTO_DEF width,
* which means it will be extended so that the layout fits its minimum width.
*
* The process is similar for table rows. By default, there is a spacing of 4
* pixels between rows and between columns, and a margin of 6 pixels around the
* whole layout.
*/
class Layout final : public LayoutCell
{
public:
Layout();
A_DELETE_COPY(Layout)
/**
* Sets the margin around the layout.
*/
void setMargin(int m)
{ setPadding(m); }
/**
* Sets the positions of all the widgets.
* @see LayoutArray::reflow
*/
void reflow(int &restrict nW, int &restrict nH);
/**
* When the minimum size of the layout is less than the available size,
* the remaining pixels are equally split amongst the FILL items.
*/
enum
{
AUTO_DEF = -42, /**< Default value, behaves like AUTO_ADD. */
AUTO_SET = -43, /**< Uses the share as the new size. */
AUTO_ADD = -44 /**< Adds the share to the current size. */
};
private:
bool mComputed;
};
#endif // GUI_WIDGETS_LAYOUT_H
|
