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 QABSTRACTSCROLLAREA_P_H
41#define QABSTRACTSCROLLAREA_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtWidgets/private/qtwidgetsglobal_p.h>
55#include "private/qframe_p.h"
56#include "qabstractscrollarea.h"
57
58QT_BEGIN_NAMESPACE
59
60#if QT_CONFIG(scrollarea)
61
62class QScrollBar;
63class QAbstractScrollAreaScrollBarContainer;
64
65// ### Qt 6: is the export still needed? If not, unexport QFramePrivate, too.
66class Q_WIDGETS_EXPORT QAbstractScrollAreaPrivate: public QFramePrivate
67{
68 Q_DECLARE_PUBLIC(QAbstractScrollArea)
69
70public:
71 QAbstractScrollAreaPrivate();
72 ~QAbstractScrollAreaPrivate();
73
74 void replaceScrollBar(QScrollBar *scrollBar, Qt::Orientation orientation);
75
76 QAbstractScrollAreaScrollBarContainer *scrollBarContainers[Qt::Vertical + 1];
77 QScrollBar *hbar, *vbar;
78 Qt::ScrollBarPolicy vbarpolicy, hbarpolicy;
79
80 bool shownOnce;
81 bool inResize;
82 mutable QSize sizeHint;
83 QAbstractScrollArea::SizeAdjustPolicy sizeAdjustPolicy;
84
85 QWidget *viewport;
86 QWidget *cornerWidget;
87 QRect cornerPaintingRect;
88#if 0 // Used to be included in Qt4 for Q_WS_MAC
89 QRect reverseCornerPaintingRect;
90#endif
91 int left, top, right, bottom; // viewport margin
92
93 int xoffset, yoffset;
94 QPoint overshoot;
95
96 void init();
97 void layoutChildren();
98 void layoutChildren_helper(bool *needHorizontalScrollbar, bool *needVerticalScrollbar);
99 // ### Fix for 4.4, talk to Bjoern E or Girish.
100 virtual void scrollBarPolicyChanged(Qt::Orientation, Qt::ScrollBarPolicy) {}
101 bool canStartScrollingAt( const QPoint &startPos );
102
103 void flashScrollBars();
104 void setScrollBarTransient(QScrollBar *scrollBar, bool transient);
105
106 void _q_hslide(int);
107 void _q_vslide(int);
108 void _q_showOrHideScrollBars();
109
110 virtual QPoint contentsOffset() const;
111
112 inline bool viewportEvent(QEvent *event)
113 { return q_func()->viewportEvent(event); }
114 QScopedPointer<QObject> viewportFilter;
115
116#if 0 // Used to be included in Qt4 for Q_WS_WIN
117 bool singleFingerPanEnabled;
118 void setSingleFingerPanEnabled(bool on = true);
119#endif
120};
121
122class QAbstractScrollAreaFilter : public QObject
123{
124 Q_OBJECT
125public:
126 QAbstractScrollAreaFilter(QAbstractScrollAreaPrivate *p) : d(p)
127 { setObjectName(QLatin1String("qt_abstractscrollarea_filter")); }
128 bool eventFilter(QObject *o, QEvent *e) override
129 { return (o == d->viewport ? d->viewportEvent(e) : false); }
130private:
131 QAbstractScrollAreaPrivate *d;
132};
133
134class QBoxLayout;
135class QAbstractScrollAreaScrollBarContainer : public QWidget
136{
137public:
138 enum LogicalPosition { LogicalLeft = 1, LogicalRight = 2 };
139
140 QAbstractScrollAreaScrollBarContainer(Qt::Orientation orientation, QWidget *parent);
141 void addWidget(QWidget *widget, LogicalPosition position);
142 QWidgetList widgets(LogicalPosition position);
143 void removeWidget(QWidget *widget);
144
145 QScrollBar *scrollBar;
146 QBoxLayout *layout;
147private:
148 int scrollBarLayoutIndex() const;
149
150 Qt::Orientation orientation;
151};
152
153#endif // QT_CONFIG(scrollarea)
154
155QT_END_NAMESPACE
156
157#endif // QABSTRACTSCROLLAREA_P_H
158