1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtWidgets module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QLAYOUT_H
41#define QLAYOUT_H
42
43#include <QtWidgets/qtwidgetsglobal.h>
44#include <QtCore/qobject.h>
45#include <QtWidgets/qlayoutitem.h>
46#include <QtWidgets/qsizepolicy.h>
47#include <QtCore/qrect.h>
48#include <QtCore/qmargins.h>
49
50#include <limits.h>
51
52QT_BEGIN_NAMESPACE
53
54
55class QLayout;
56class QSize;
57
58
59class QLayoutPrivate;
60
61class Q_WIDGETS_EXPORT QLayout : public QObject, public QLayoutItem
62{
63 Q_OBJECT
64 Q_DECLARE_PRIVATE(QLayout)
65
66 Q_PROPERTY(int margin READ margin WRITE setMargin)
67 Q_PROPERTY(int spacing READ spacing WRITE setSpacing)
68 Q_PROPERTY(SizeConstraint sizeConstraint READ sizeConstraint WRITE setSizeConstraint)
69public:
70 enum SizeConstraint {
71 SetDefaultConstraint,
72 SetNoConstraint,
73 SetMinimumSize,
74 SetFixedSize,
75 SetMaximumSize,
76 SetMinAndMaxSize
77 };
78 Q_ENUM(SizeConstraint)
79
80 QLayout(QWidget *parent);
81 QLayout();
82 ~QLayout();
83
84 int margin() const;
85 int spacing() const;
86
87 void setMargin(int);
88 void setSpacing(int);
89
90 void setContentsMargins(int left, int top, int right, int bottom);
91 void setContentsMargins(const QMargins &margins);
92 void getContentsMargins(int *left, int *top, int *right, int *bottom) const;
93 QMargins contentsMargins() const;
94 QRect contentsRect() const;
95
96 bool setAlignment(QWidget *w, Qt::Alignment alignment);
97 bool setAlignment(QLayout *l, Qt::Alignment alignment);
98 using QLayoutItem::setAlignment;
99
100 void setSizeConstraint(SizeConstraint);
101 SizeConstraint sizeConstraint() const;
102 void setMenuBar(QWidget *w);
103 QWidget *menuBar() const;
104
105 QWidget *parentWidget() const;
106
107 void invalidate() override;
108 QRect geometry() const override;
109 bool activate();
110 void update();
111
112 void addWidget(QWidget *w);
113 virtual void addItem(QLayoutItem *) = 0;
114
115 void removeWidget(QWidget *w);
116 void removeItem(QLayoutItem *);
117
118 Qt::Orientations expandingDirections() const override;
119 QSize minimumSize() const override;
120 QSize maximumSize() const override;
121 virtual void setGeometry(const QRect&) override;
122 virtual QLayoutItem *itemAt(int index) const = 0;
123 virtual QLayoutItem *takeAt(int index) = 0;
124 virtual int indexOf(QWidget *) const;
125 QT6_VIRTUAL int indexOf(QLayoutItem *) const;
126 virtual int count() const = 0;
127 bool isEmpty() const override;
128 QSizePolicy::ControlTypes controlTypes() const override;
129
130 QT6_VIRTUAL QLayoutItem *replaceWidget(QWidget *from, QWidget *to,
131 Qt::FindChildOptions options = Qt::FindChildrenRecursively);
132
133 int totalHeightForWidth(int w) const;
134 QSize totalMinimumSize() const;
135 QSize totalMaximumSize() const;
136 QSize totalSizeHint() const;
137 QLayout *layout() override;
138
139 void setEnabled(bool);
140 bool isEnabled() const;
141
142
143 static QSize closestAcceptableSize(const QWidget *w, const QSize &s);
144
145protected:
146 void widgetEvent(QEvent *);
147 void childEvent(QChildEvent *e) override;
148 void addChildLayout(QLayout *l);
149 void addChildWidget(QWidget *w);
150 bool adoptLayout(QLayout *layout);
151
152 QRect alignmentRect(const QRect&) const;
153protected:
154 QLayout(QLayoutPrivate &d, QLayout*, QWidget*);
155
156private:
157 Q_DISABLE_COPY(QLayout)
158
159 static void activateRecursiveHelper(QLayoutItem *item);
160
161 friend class QApplicationPrivate;
162 friend class QWidget;
163
164};
165
166QT_END_NAMESPACE
167
168//### support old includes
169#include <QtWidgets/qboxlayout.h>
170#include <QtWidgets/qgridlayout.h>
171
172#endif // QLAYOUT_H
173