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 QtQuick 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 QQUICKGRIDVIEW_P_H
41#define QQUICKGRIDVIEW_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 <QtQuick/private/qtquickglobal_p.h>
55
56QT_REQUIRE_CONFIG(quick_gridview);
57
58#include "qquickitemview_p.h"
59
60QT_BEGIN_NAMESPACE
61
62class QQuickGridViewAttached;
63class QQuickGridViewPrivate;
64class Q_AUTOTEST_EXPORT QQuickGridView : public QQuickItemView
65{
66 Q_OBJECT
67 Q_DECLARE_PRIVATE(QQuickGridView)
68
69 Q_PROPERTY(Flow flow READ flow WRITE setFlow NOTIFY flowChanged)
70 Q_PROPERTY(qreal cellWidth READ cellWidth WRITE setCellWidth NOTIFY cellWidthChanged)
71 Q_PROPERTY(qreal cellHeight READ cellHeight WRITE setCellHeight NOTIFY cellHeightChanged)
72
73 Q_PROPERTY(SnapMode snapMode READ snapMode WRITE setSnapMode NOTIFY snapModeChanged)
74
75 Q_CLASSINFO("DefaultProperty", "data")
76 QML_NAMED_ELEMENT(GridView)
77 QML_ATTACHED(QQuickGridViewAttached)
78
79public:
80 enum Flow {
81 FlowLeftToRight = LeftToRight,
82 FlowTopToBottom = TopToBottom
83 };
84 Q_ENUM(Flow)
85
86 QQuickGridView(QQuickItem *parent=nullptr);
87 ~QQuickGridView();
88
89 void setHighlightFollowsCurrentItem(bool) override;
90 void setHighlightMoveDuration(int) override;
91
92 Flow flow() const;
93 void setFlow(Flow);
94
95 qreal cellWidth() const;
96 void setCellWidth(qreal);
97
98 qreal cellHeight() const;
99 void setCellHeight(qreal);
100
101 enum SnapMode { NoSnap, SnapToRow, SnapOneRow };
102 Q_ENUM(SnapMode)
103 SnapMode snapMode() const;
104 void setSnapMode(SnapMode mode);
105
106 static QQuickGridViewAttached *qmlAttachedProperties(QObject *);
107
108public Q_SLOTS:
109 void moveCurrentIndexUp();
110 void moveCurrentIndexDown();
111 void moveCurrentIndexLeft();
112 void moveCurrentIndexRight();
113
114Q_SIGNALS:
115 void cellWidthChanged();
116 void cellHeightChanged();
117 void highlightMoveDurationChanged();
118 void flowChanged();
119 void snapModeChanged();
120
121protected:
122 void viewportMoved(Qt::Orientations) override;
123 void keyPressEvent(QKeyEvent *) override;
124 void geometryChanged(const QRectF &newGeometry, const QRectF &oldGeometry) override;
125 void initItem(int index, QObject *item) override;
126};
127
128class QQuickGridViewAttached : public QQuickItemViewAttached
129{
130 Q_OBJECT
131public:
132 QQuickGridViewAttached(QObject *parent)
133 : QQuickItemViewAttached(parent) {}
134 ~QQuickGridViewAttached() {}
135};
136
137
138QT_END_NAMESPACE
139
140QML_DECLARE_TYPE(QQuickGridView)
141
142#endif // QQUICKGRIDVIEW_P_H
143

source code of qtdeclarative/src/quick/items/qquickgridview_p.h