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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include "utils_global.h"
#include "optional.h"
#include <QList>
#include <QString>
#include <QVariant>
QT_BEGIN_NAMESPACE
class QLayout;
class QWidget;
QT_END_NAMESPACE
namespace Utils {
class BaseAspect;
class BoolAspect;
namespace Layouting {
enum AttachType {
WithMargins,
WithoutMargins,
WithFormAlignment, // Handle Grid similar to QFormLayout, i.e. use special alignment for the first column on Mac
};
} // Layouting
class QTCREATOR_UTILS_EXPORT LayoutBuilder
{
public:
enum LayoutType {
HBoxLayout,
VBoxLayout,
FormLayout,
GridLayout,
};
enum class AlignmentType {
DefaultAlignment,
AlignAsFormLabel,
};
enum class SpecialType {
NotSpecial,
Space,
Stretch,
Break,
};
using Setter = std::function<void(QObject *target)>;
class QTCREATOR_UTILS_EXPORT LayoutItem
{
public:
LayoutItem();
LayoutItem(QLayout *layout);
LayoutItem(QWidget *widget);
LayoutItem(BaseAspect *aspect); // Remove
LayoutItem(BaseAspect &aspect);
LayoutItem(const QString &text);
LayoutItem(const LayoutBuilder &builder);
LayoutItem(const Setter &setter) { this->setter = setter; }
QLayout *layout = nullptr;
QWidget *widget = nullptr;
BaseAspect *aspect = nullptr;
QString text; // FIXME: Use specialValue for that
int span = 1;
AlignmentType align = AlignmentType::DefaultAlignment;
Setter setter;
SpecialType specialType = SpecialType::NotSpecial;
QVariant specialValue;
};
using LayoutItems = QList<LayoutItem>;
explicit LayoutBuilder(LayoutType layoutType, const LayoutItems &items = {});
LayoutBuilder(const LayoutBuilder &) = delete;
LayoutBuilder(LayoutBuilder &&) = default;
LayoutBuilder &operator=(const LayoutBuilder &) = delete;
LayoutBuilder &operator=(LayoutBuilder &&) = default;
~LayoutBuilder();
LayoutBuilder &setSpacing(int spacing);
LayoutBuilder &addItem(const LayoutItem &item);
LayoutBuilder &addItems(const LayoutItems &items);
LayoutBuilder &finishRow();
LayoutBuilder &addRow(const LayoutItem &item);
LayoutBuilder &addRow(const LayoutItems &items);
LayoutType layoutType() const { return m_layoutType; }
void attachTo(QWidget *w, Layouting::AttachType attachType = Layouting::WithMargins) const;
QWidget *emerge(Layouting::AttachType attachType = Layouting::WithMargins);
class QTCREATOR_UTILS_EXPORT Space : public LayoutItem
{
public:
explicit Space(int space);
};
class QTCREATOR_UTILS_EXPORT Span : public LayoutItem
{
public:
Span(int span, const LayoutItem &item);
};
class QTCREATOR_UTILS_EXPORT Stretch : public LayoutItem
{
public:
explicit Stretch(int stretch = 1);
};
class QTCREATOR_UTILS_EXPORT Break : public LayoutItem
{
public:
Break();
};
protected:
explicit LayoutBuilder(); // Adds to existing layout.
QLayout *createLayout() const;
void doLayout(QWidget *parent, Layouting::AttachType attachType) const;
LayoutItems m_items;
LayoutType m_layoutType;
Utils::optional<int> m_spacing;
};
class QTCREATOR_UTILS_EXPORT LayoutExtender : public LayoutBuilder
{
public:
explicit LayoutExtender(QLayout *layout, Layouting::AttachType attachType);
~LayoutExtender();
private:
QLayout *m_layout = nullptr;
Layouting::AttachType m_attachType = {};
};
namespace Layouting {
QTCREATOR_UTILS_EXPORT LayoutBuilder::Setter title(const QString &title,
BoolAspect *checker = nullptr);
QTCREATOR_UTILS_EXPORT LayoutBuilder::Setter text(const QString &text);
QTCREATOR_UTILS_EXPORT LayoutBuilder::Setter tooltip(const QString &toolTip);
QTCREATOR_UTILS_EXPORT LayoutBuilder::Setter onClicked(const std::function<void()> &func,
QObject *guard = nullptr);
class QTCREATOR_UTILS_EXPORT Group : public LayoutBuilder::LayoutItem
{
public:
Group(std::initializer_list<LayoutItem> items);
};
class QTCREATOR_UTILS_EXPORT PushButton : public LayoutBuilder::LayoutItem
{
public:
PushButton(std::initializer_list<LayoutItem> items);
};
class QTCREATOR_UTILS_EXPORT Column : public LayoutBuilder
{
public:
Column() : LayoutBuilder(VBoxLayout) {}
Column(std::initializer_list<LayoutItem> items) : LayoutBuilder(VBoxLayout, items) {}
};
class QTCREATOR_UTILS_EXPORT Row : public LayoutBuilder
{
public:
Row() : LayoutBuilder(HBoxLayout) {}
Row(std::initializer_list<LayoutItem> items) : LayoutBuilder(HBoxLayout, items) {}
};
class QTCREATOR_UTILS_EXPORT Grid : public LayoutBuilder
{
public:
Grid() : LayoutBuilder(GridLayout) {}
Grid(std::initializer_list<LayoutItem> items) : LayoutBuilder(GridLayout, items) {}
};
class QTCREATOR_UTILS_EXPORT Form : public LayoutBuilder
{
public:
Form() : LayoutBuilder(FormLayout) {}
Form(std::initializer_list<LayoutItem> items) : LayoutBuilder(FormLayout, items) {}
};
using Space = LayoutBuilder::Space;
using Span = LayoutBuilder::Span;
QTCREATOR_UTILS_EXPORT extern LayoutBuilder::Break br;
QTCREATOR_UTILS_EXPORT extern LayoutBuilder::Stretch st;
QTCREATOR_UTILS_EXPORT extern LayoutBuilder::Space empty;
} // Layouting
} // Utils
|