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 QSCROLLAREA_H
41#define QSCROLLAREA_H
42
43#include <QtWidgets/qtwidgetsglobal.h>
44#include <QtWidgets/qabstractscrollarea.h>
45
46QT_REQUIRE_CONFIG(scrollarea);
47
48QT_BEGIN_NAMESPACE
49
50class QScrollAreaPrivate;
51
52class Q_WIDGETS_EXPORT QScrollArea : public QAbstractScrollArea
53{
54 Q_OBJECT
55 Q_PROPERTY(bool widgetResizable READ widgetResizable WRITE setWidgetResizable)
56 Q_PROPERTY(Qt::Alignment alignment READ alignment WRITE setAlignment)
57
58public:
59 explicit QScrollArea(QWidget *parent = nullptr);
60 ~QScrollArea();
61
62 QWidget *widget() const;
63 void setWidget(QWidget *widget);
64 QWidget *takeWidget();
65
66 bool widgetResizable() const;
67 void setWidgetResizable(bool resizable);
68
69 QSize sizeHint() const override;
70
71 bool focusNextPrevChild(bool next) override;
72
73 Qt::Alignment alignment() const;
74 void setAlignment(Qt::Alignment);
75
76 void ensureVisible(int x, int y, int xmargin = 50, int ymargin = 50);
77 void ensureWidgetVisible(QWidget *childWidget, int xmargin = 50, int ymargin = 50);
78
79protected:
80 QScrollArea(QScrollAreaPrivate &dd, QWidget *parent = nullptr);
81 bool event(QEvent *) override;
82 bool eventFilter(QObject *, QEvent *) override;
83 void resizeEvent(QResizeEvent *) override;
84 void scrollContentsBy(int dx, int dy) override;
85
86 QSize viewportSizeHint() const override;
87
88private:
89 Q_DECLARE_PRIVATE(QScrollArea)
90 Q_DISABLE_COPY(QScrollArea)
91};
92
93QT_END_NAMESPACE
94
95#endif // QSCROLLAREA_H
96