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 spacing READ spacing WRITE setSpacing)
67 Q_PROPERTY(QMargins contentsMargins READ contentsMargins WRITE setContentsMargins)
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 virtual int spacing() const;
85 virtual void setSpacing(int);
86
87 void setContentsMargins(int left, int top, int right, int bottom);
88 void setContentsMargins(const QMargins &margins);
89 void getContentsMargins(int *left, int *top, int *right, int *bottom) const;
90 QMargins contentsMargins() const;
91 QRect contentsRect() const;
92
93 bool setAlignment(QWidget *w, Qt::Alignment alignment);
94 bool setAlignment(QLayout *l, Qt::Alignment alignment);
95 using QLayoutItem::setAlignment;
96
97 void setSizeConstraint(SizeConstraint);
98 SizeConstraint sizeConstraint() const;
99 void setMenuBar(QWidget *w);
100 QWidget *menuBar() const;
101
102 QWidget *parentWidget() const;
103
104 void invalidate() override;
105 QRect geometry() const override;
106 bool activate();
107 void update();
108
109 void addWidget(QWidget *w);
110 virtual void addItem(QLayoutItem *) = 0;
111
112 void removeWidget(QWidget *w);
113 void removeItem(QLayoutItem *);
114
115 Qt::Orientations expandingDirections() const override;
116 QSize minimumSize() const override;
117 QSize maximumSize() const override;
118 virtual void setGeometry(const QRect&) override;
119 virtual QLayoutItem *itemAt(int index) const = 0;
120 virtual QLayoutItem *takeAt(int index) = 0;
121 virtual int indexOf(const QWidget *) const;
122 virtual int indexOf(const QLayoutItem *) const;
123 virtual int count() const = 0;
124 bool isEmpty() const override;
125 QSizePolicy::ControlTypes controlTypes() const override;
126
127 virtual QLayoutItem *replaceWidget(QWidget *from, QWidget *to,
128 Qt::FindChildOptions options = Qt::FindChildrenRecursively);
129
130 int totalHeightForWidth(int w) const;
131 QSize totalMinimumSize() const;
132 QSize totalMaximumSize() const;
133 QSize totalSizeHint() const;
134 QLayout *layout() override;
135
136 void setEnabled(bool);
137 bool isEnabled() const;
138
139
140 static QSize closestAcceptableSize(const QWidget *w, const QSize &s);
141
142protected:
143 void widgetEvent(QEvent *);
144 void childEvent(QChildEvent *e) override;
145 void addChildLayout(QLayout *l);
146 void addChildWidget(QWidget *w);
147 bool adoptLayout(QLayout *layout);
148
149 QRect alignmentRect(const QRect&) const;
150protected:
151 QLayout(QLayoutPrivate &d, QLayout*, QWidget*);
152
153private:
154 Q_DISABLE_COPY(QLayout)
155
156 static void activateRecursiveHelper(QLayoutItem *item);
157
158 friend class QApplicationPrivate;
159 friend class QWidget;
160
161};
162
163QT_END_NAMESPACE
164
165//### support old includes
166#include <QtWidgets/qboxlayout.h>
167#include <QtWidgets/qgridlayout.h>
168
169#endif // QLAYOUT_H
170