Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qquicktableview_p.h
Go to the documentation of this file.
1// Copyright (C) 2018 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#ifndef QQUICKTABLEVIEW_P_H
6#define QQUICKTABLEVIEW_P_H
7
8//
9// W A R N I N G
10// -------------
11//
12// This file is not part of the Qt API. It exists purely as an
13// implementation detail. This header file may change from version to
14// version without notice, or even be removed.
15//
16// We mean it.
17//
18
19#include <private/qtquickglobal_p.h>
20QT_REQUIRE_CONFIG(quick_tableview);
21
22#include <QtCore/qpointer.h>
23#include <QtCore/qpoint.h>
24#include <QtCore/qrect.h>
25#include <QtQuick/private/qtquickglobal_p.h>
26#include <QtQuick/private/qquickflickable_p.h>
27#include <QtQml/qqmlcomponent.h>
28#include <QtQml/private/qqmlnullablevalue_p.h>
29#include <QtQml/private/qqmlfinalizer_p.h>
30#include <QtQml/private/qqmlguard_p.h>
31#include <QtQmlModels/private/qqmldelegatemodel_p.h>
32
33QT_BEGIN_NAMESPACE
34
35class QQuickTableViewAttached;
36class QQuickTableViewPrivate;
37class QItemSelectionModel;
38
39class Q_QUICK_EXPORT QQuickTableView : public QQuickFlickable, public QQmlFinalizerHook
40{
41 Q_OBJECT
42 Q_INTERFACES(QQmlFinalizerHook)
43
44 Q_PROPERTY(int rows READ rows NOTIFY rowsChanged)
45 Q_PROPERTY(int columns READ columns NOTIFY columnsChanged)
46 Q_PROPERTY(qreal rowSpacing READ rowSpacing WRITE setRowSpacing NOTIFY rowSpacingChanged)
47 Q_PROPERTY(qreal columnSpacing READ columnSpacing WRITE setColumnSpacing NOTIFY columnSpacingChanged)
48 Q_PROPERTY(QJSValue rowHeightProvider READ rowHeightProvider WRITE setRowHeightProvider NOTIFY rowHeightProviderChanged)
49 Q_PROPERTY(QJSValue columnWidthProvider READ columnWidthProvider WRITE setColumnWidthProvider NOTIFY columnWidthProviderChanged)
50 Q_PROPERTY(QVariant model READ model WRITE setModel NOTIFY modelChanged)
51 Q_PROPERTY(QQmlComponent *delegate READ delegate WRITE setDelegate NOTIFY delegateChanged)
52 Q_PROPERTY(bool reuseItems READ reuseItems WRITE setReuseItems NOTIFY reuseItemsChanged)
53 Q_PROPERTY(qreal contentWidth READ contentWidth WRITE setContentWidth NOTIFY contentWidthChanged OVERRIDE)
54 Q_PROPERTY(qreal contentHeight READ contentHeight WRITE setContentHeight NOTIFY contentHeightChanged OVERRIDE)
55 Q_PROPERTY(QQuickTableView *syncView READ syncView WRITE setSyncView NOTIFY syncViewChanged REVISION(2, 14))
56 Q_PROPERTY(Qt::Orientations syncDirection READ syncDirection WRITE setSyncDirection NOTIFY syncDirectionChanged REVISION(2, 14))
57 Q_PROPERTY(int leftColumn READ leftColumn NOTIFY leftColumnChanged REVISION(6, 0))
58 Q_PROPERTY(int rightColumn READ rightColumn NOTIFY rightColumnChanged REVISION(6, 0))
59 Q_PROPERTY(int topRow READ topRow NOTIFY topRowChanged REVISION(6, 0))
60 Q_PROPERTY(int bottomRow READ bottomRow NOTIFY bottomRowChanged REVISION(6, 0))
61 Q_PROPERTY(QItemSelectionModel *selectionModel READ selectionModel WRITE setSelectionModel NOTIFY selectionModelChanged REVISION(6, 2))
62 Q_PROPERTY(bool animate READ animate WRITE setAnimate NOTIFY animateChanged REVISION(6, 4))
63 Q_PROPERTY(bool keyNavigationEnabled READ keyNavigationEnabled WRITE setKeyNavigationEnabled NOTIFY keyNavigationEnabledChanged REVISION(6, 4))
64 Q_PROPERTY(bool pointerNavigationEnabled READ pointerNavigationEnabled WRITE setPointerNavigationEnabled NOTIFY pointerNavigationEnabledChanged REVISION(6, 4))
65 Q_PROPERTY(int currentRow READ currentRow NOTIFY currentRowChanged REVISION(6, 4) FINAL)
66 Q_PROPERTY(int currentColumn READ currentColumn NOTIFY currentColumnChanged REVISION(6, 4) FINAL)
67 Q_PROPERTY(bool alternatingRows READ alternatingRows WRITE setAlternatingRows NOTIFY alternatingRowsChanged REVISION(6, 4) FINAL)
68 Q_PROPERTY(SelectionBehavior selectionBehavior READ selectionBehavior WRITE setSelectionBehavior NOTIFY selectionBehaviorChanged REVISION(6, 4) FINAL)
69 Q_PROPERTY(bool resizableColumns READ resizableColumns WRITE setResizableColumns NOTIFY resizableColumnsChanged REVISION(6, 5) FINAL)
70 Q_PROPERTY(bool resizableRows READ resizableRows WRITE setResizableRows NOTIFY resizableRowsChanged REVISION(6, 5) FINAL)
71 Q_PROPERTY(EditTriggers editTriggers READ editTriggers WRITE setEditTriggers NOTIFY editTriggersChanged REVISION(6, 5) FINAL)
72 Q_PROPERTY(SelectionMode selectionMode READ selectionMode WRITE setSelectionMode NOTIFY selectionModeChanged REVISION(6, 6) FINAL)
73 Q_PROPERTY(QQmlDelegateModel::DelegateModelAccess delegateModelAccess READ delegateModelAccess
74 WRITE setDelegateModelAccess NOTIFY delegateModelAccessChanged REVISION(6, 10) FINAL)
75
76 QML_NAMED_ELEMENT(TableView)
77 QML_ADDED_IN_VERSION(2, 12)
78 QML_ATTACHED(QQuickTableViewAttached)
79
80public:
81 enum SelectionBehavior {
82 SelectionDisabled,
83 SelectCells,
84 SelectRows,
85 SelectColumns
86 };
87 Q_ENUM(SelectionBehavior)
88
89 enum SelectionMode {
90 SingleSelection,
91 ContiguousSelection,
92 ExtendedSelection
93 };
94 Q_ENUM(SelectionMode)
95
96 enum EditTrigger {
97 NoEditTriggers = 0x0,
98 SingleTapped = 0x1,
99 DoubleTapped = 0x2,
100 SelectedTapped = 0x4,
101 EditKeyPressed = 0x8,
102 AnyKeyPressed = 0x10,
103 };
104 Q_DECLARE_FLAGS(EditTriggers, EditTrigger)
105 Q_FLAG(EditTriggers)
106
107 QQuickTableView(QQuickItem *parent = nullptr);
108 ~QQuickTableView() override;
109 int rows() const;
110 int columns() const;
111
112 qreal rowSpacing() const;
113 void setRowSpacing(qreal spacing);
114
115 qreal columnSpacing() const;
116 void setColumnSpacing(qreal spacing);
117
118 QJSValue rowHeightProvider() const;
119 void setRowHeightProvider(const QJSValue &provider);
120
121 QJSValue columnWidthProvider() const;
122 void setColumnWidthProvider(const QJSValue &provider);
123
124 QVariant model() const;
125 void setModel(const QVariant &newModel);
126
127 QQmlComponent *delegate() const;
128 void setDelegate(QQmlComponent *);
129
130 bool reuseItems() const;
131 void setReuseItems(bool reuseItems);
132
133 void setContentWidth(qreal width);
134 void setContentHeight(qreal height);
135
136 QQuickTableView *syncView() const;
137 void setSyncView(QQuickTableView *view);
138
139 Qt::Orientations syncDirection() const;
140 void setSyncDirection(Qt::Orientations direction);
141
142 QItemSelectionModel *selectionModel() const;
143 void setSelectionModel(QItemSelectionModel *selectionModel);
144
145 bool animate() const;
146 void setAnimate(bool animate);
147
148 bool keyNavigationEnabled() const;
149 void setKeyNavigationEnabled(bool enabled);
150 bool pointerNavigationEnabled() const;
151 void setPointerNavigationEnabled(bool enabled);
152
153 int leftColumn() const;
154 int rightColumn() const;
155 int topRow() const;
156 int bottomRow() const;
157
158 int currentRow() const;
159 int currentColumn() const;
160
161 bool alternatingRows() const;
162 void setAlternatingRows(bool alternatingRows);
163
164 SelectionBehavior selectionBehavior() const;
165 void setSelectionBehavior(SelectionBehavior selectionBehavior);
166 SelectionMode selectionMode() const;
167 void setSelectionMode(SelectionMode selectionMode);
168
169 bool resizableColumns() const;
170 void setResizableColumns(bool enabled);
171
172 bool resizableRows() const;
173 void setResizableRows(bool enabled);
174
175 EditTriggers editTriggers() const;
176 void setEditTriggers(EditTriggers editTriggers);
177
178 QQmlDelegateModel::DelegateModelAccess delegateModelAccess() const;
179 void setDelegateModelAccess(QQmlDelegateModel::DelegateModelAccess delegateModelAccess);
180
181 Q_INVOKABLE void forceLayout();
182 Q_INVOKABLE void positionViewAtCell(const QPoint &cell, QQuickTableView::PositionMode mode, const QPointF &offset = QPointF(), const QRectF &subRect = QRectF());
183 Q_INVOKABLE void positionViewAtIndex(const QModelIndex &index, QQuickTableView::PositionMode mode, const QPointF &offset = QPointF(), const QRectF &subRect = QRectF());
184 Q_INVOKABLE void positionViewAtRow(int row, QQuickTableView::PositionMode mode, qreal offset = 0, const QRectF &subRect = QRectF());
185 Q_INVOKABLE void positionViewAtColumn(int column, QQuickTableView::PositionMode mode, qreal offset = 0, const QRectF &subRect = QRectF());
186 Q_INVOKABLE QQuickItem *itemAtCell(const QPoint &cell) const;
187
188 Q_REVISION(6, 4) Q_INVOKABLE QPoint cellAtPosition(const QPointF &position, bool includeSpacing = false) const;
189 Q_REVISION(6, 4) Q_INVOKABLE QPoint cellAtPosition(qreal x, qreal y, bool includeSpacing = false) const;
190#if QT_DEPRECATED_SINCE(6, 4)
191 QT_DEPRECATED_VERSION_X_6_4("Use index(row, column) instead")
192 Q_REVISION(6, 4) Q_INVOKABLE virtual QModelIndex modelIndex(int row, int column) const;
193 QT_DEPRECATED_VERSION_X_6_4("Use cellAtPosition() instead")
194 Q_INVOKABLE QPoint cellAtPos(const QPointF &position, bool includeSpacing = false) const;
195 Q_INVOKABLE QPoint cellAtPos(qreal x, qreal y, bool includeSpacing = false) const;
196#endif
197
198 Q_REVISION(6, 2) Q_INVOKABLE bool isColumnLoaded(int column) const;
199 Q_REVISION(6, 2) Q_INVOKABLE bool isRowLoaded(int row) const;
200
201 Q_REVISION(6, 2) Q_INVOKABLE qreal columnWidth(int column) const;
202 Q_REVISION(6, 2) Q_INVOKABLE qreal rowHeight(int row) const;
203 Q_REVISION(6, 2) Q_INVOKABLE qreal implicitColumnWidth(int column) const;
204 Q_REVISION(6, 2) Q_INVOKABLE qreal implicitRowHeight(int row) const;
205
206 Q_REVISION(6, 4) Q_INVOKABLE QModelIndex index(int row, int column) const;
207 Q_REVISION(6, 4) Q_INVOKABLE virtual QModelIndex modelIndex(const QPoint &cell) const;
208 Q_REVISION(6, 4) Q_INVOKABLE virtual QPoint cellAtIndex(const QModelIndex &index) const;
209 Q_REVISION(6, 4) Q_INVOKABLE int rowAtIndex(const QModelIndex &index) const;
210 Q_REVISION(6, 4) Q_INVOKABLE int columnAtIndex(const QModelIndex &index) const;
211
212 Q_REVISION(6, 5) Q_INVOKABLE void setColumnWidth(int column, qreal size);
213 Q_REVISION(6, 5) Q_INVOKABLE void clearColumnWidths();
214 Q_REVISION(6, 5) Q_INVOKABLE qreal explicitColumnWidth(int column) const;
215
216 Q_REVISION(6, 5) Q_INVOKABLE void setRowHeight(int row, qreal size);
217 Q_REVISION(6, 5) Q_INVOKABLE void clearRowHeights();
218 Q_REVISION(6, 5) Q_INVOKABLE qreal explicitRowHeight(int row) const;
219
220 Q_REVISION(6, 5) Q_INVOKABLE void edit(const QModelIndex &index);
221 Q_REVISION(6, 5) Q_INVOKABLE void closeEditor();
222
223 Q_REVISION(6, 5) Q_INVOKABLE QQuickItem *itemAtIndex(const QModelIndex &index) const;
224
225#if QT_DEPRECATED_SINCE(6, 5)
226 QT_DEPRECATED_VERSION_X_6_5("Use itemAtIndex(index(row, column)) instead")
227 Q_INVOKABLE QQuickItem *itemAtCell(int column, int row) const;
228 QT_DEPRECATED_VERSION_X_6_5("Use positionViewAtIndex(index(row, column)) instead")
229 Q_INVOKABLE void positionViewAtCell(int column, int row, QQuickTableView::PositionMode mode, const QPointF &offset = QPointF(), const QRectF &subRect = QRectF());
230#endif
231
232 Q_REVISION(6, 8) Q_INVOKABLE void moveColumn(int source, int destination);
233 Q_REVISION(6, 8) Q_INVOKABLE void moveRow(int source, int destination);
234 Q_REVISION(6, 8) Q_INVOKABLE void clearColumnReordering();
235 Q_REVISION(6, 8) Q_INVOKABLE void clearRowReordering();
236
237 static QQuickTableViewAttached *qmlAttachedProperties(QObject *);
238
239Q_SIGNALS:
240 void rowsChanged();
241 void columnsChanged();
242 void rowSpacingChanged();
243 void columnSpacingChanged();
244 void rowHeightProviderChanged();
245 void columnWidthProviderChanged();
246 void modelChanged();
247 void delegateChanged();
248 void reuseItemsChanged();
249 Q_REVISION(2, 14) void syncViewChanged();
250 Q_REVISION(2, 14) void syncDirectionChanged();
251 Q_REVISION(6, 0) void leftColumnChanged();
252 Q_REVISION(6, 0) void rightColumnChanged();
253 Q_REVISION(6, 0) void topRowChanged();
254 Q_REVISION(6, 0) void bottomRowChanged();
255 Q_REVISION(6, 2) void selectionModelChanged();
256 Q_REVISION(6, 4) void animateChanged();
257 Q_REVISION(6, 4) void keyNavigationEnabledChanged();
258 Q_REVISION(6, 4) void pointerNavigationEnabledChanged();
259 Q_REVISION(6, 4) void currentRowChanged();
260 Q_REVISION(6, 4) void currentColumnChanged();
261 Q_REVISION(6, 4) void alternatingRowsChanged();
262 Q_REVISION(6, 4) void selectionBehaviorChanged();
263 Q_REVISION(6, 5) void resizableColumnsChanged();
264 Q_REVISION(6, 5) void resizableRowsChanged();
265 Q_REVISION(6, 5) void editTriggersChanged();
266 Q_REVISION(6, 5) void layoutChanged();
267 Q_REVISION(6, 6) void selectionModeChanged();
268 Q_REVISION(6, 8) void rowMoved(int logicalIndex, int oldVisualIndex, int newVisualIndex);
269 Q_REVISION(6, 8) void columnMoved(int logicalIndex, int oldVisualIndex, int newVisualIndex);
270 Q_REVISION(6, 10) void delegateModelAccessChanged();
271
272protected:
273 void geometryChange(const QRectF &newGeometry, const QRectF &oldGeometry) override;
274 void viewportMoved(Qt::Orientations orientation) override;
275 void keyPressEvent(QKeyEvent *e) override;
276 bool eventFilter(QObject *obj, QEvent *event) override;
277
278protected:
279 QQuickTableView(QQuickTableViewPrivate &dd, QQuickItem *parent);
280 // QQmlFinalizerHook interface
281 void componentFinalized() override;
282
283private:
284 Q_DISABLE_COPY(QQuickTableView)
285 Q_DECLARE_PRIVATE(QQuickTableView)
286
287 qreal minXExtent() const override;
288 qreal maxXExtent() const override;
289 qreal minYExtent() const override;
290 qreal maxYExtent() const override;
291};
292
293class Q_QUICK_EXPORT QQuickTableViewAttached : public QObject
294{
295 Q_OBJECT
296 Q_PROPERTY(QQuickTableView *view READ view NOTIFY viewChanged FINAL)
297 Q_PROPERTY(QQmlComponent *editDelegate READ editDelegate WRITE setEditDelegate NOTIFY editDelegateChanged FINAL)
298
299public:
300 QQuickTableViewAttached(QObject *parent);
301
302 QQuickTableView *view() const { return m_view; }
303 void setView(QQuickTableView *newTableView) {
304 if (newTableView == m_view)
305 return;
306 m_view = newTableView;
307 Q_EMIT viewChanged();
308 }
309
310 QQmlComponent *editDelegate() const { return m_editDelegate; }
311 void setEditDelegate(QQmlComponent *newEditDelegate)
312 {
313 if (m_editDelegate == newEditDelegate)
314 return;
315 m_editDelegate = newEditDelegate;
316 Q_EMIT editDelegateChanged();
317 }
318
319Q_SIGNALS:
320 void viewChanged();
321 void pooled();
322 void reused();
323 void editDelegateChanged();
324 void commit();
325
326private:
327 QPointer<QQuickTableView> m_view;
328 QQmlGuard<QQmlComponent> m_editDelegate;
329
330 friend class QQuickTableViewPrivate;
331};
332
333Q_DECLARE_OPERATORS_FOR_FLAGS(QQuickTableView::PositionMode)
334Q_DECLARE_OPERATORS_FOR_FLAGS(QQuickTableView::EditTriggers)
335
336QT_END_NAMESPACE
337
338#endif // QQUICKTABLEVIEW_P_H
QQuickTableViewHoverHandler::handleEventPoint
void handleEventPoint(QPointerEvent *event, QEventPoint &point) override
Definition qquicktableview.cpp:7138
QQuickTableViewPointerHandler::QQuickTableViewPointerHandler
QQuickTableViewPointerHandler(QQuickTableView *view)
Definition qquicktableview.cpp:7170
QQuickTableViewPointerHandler::wantsEventPoint
bool wantsEventPoint(const QPointerEvent *event, const QEventPoint &point) override
Returns true if the given point (as part of event) could be relevant at all to this handler,...
Definition qquicktableview.cpp:7178
QQuickTableViewResizeHandler::onGrabChanged
void onGrabChanged(QQuickPointerHandler *grabber, QPointingDevice::GrabTransition transition, QPointerEvent *ev, QEventPoint &point) override
Notification that the grab has changed in some way which is relevant to this handler.
Definition qquicktableview.cpp:7202
QQuickTableViewResizeHandler::updateState
void updateState(QEventPoint &point)
Definition qquicktableview.cpp:7240
QQuickTableViewResizeHandler::updateDrag
void updateDrag(QPointerEvent *event, QEventPoint &point)
Definition qquicktableview.cpp:7282
QQuickTableViewResizeHandler::handleEventPoint
void handleEventPoint(QPointerEvent *event, QEventPoint &point) override
Definition qquicktableview.cpp:7226
QQuickTableViewTapHandler::wantsEventPoint
bool wantsEventPoint(const QPointerEvent *event, const QEventPoint &point) override
Returns true if the given point (as part of event) could be relevant at all to this handler,...
Definition qquicktableview.cpp:7666
Q_LOGGING_CATEGORY
Q_LOGGING_CATEGORY(lcEventDispatcher, "qt.eventdispatcher")
operator<<
QDebug operator<<(QDebug debug, QIODevice::OpenMode modes)
Definition qiodevice.cpp:2374
TV_REBUILDOPTION
#define TV_REBUILDOPTION(OPTION)
allTableEdges
static const Qt::Edge allTableEdges[]
Definition qquicktableview.cpp:1577
Q_TABLEVIEW_ASSERT
#define Q_TABLEVIEW_ASSERT(cond, output)
Definition qquicktableview.cpp:1575
Q_TABLEVIEW_UNREACHABLE
#define Q_TABLEVIEW_UNREACHABLE(output)
Definition qquicktableview.cpp:1574
TV_REBUILDSTATE
#define TV_REBUILDSTATE(STATE)
kRequiredProperty_current
static const char * kRequiredProperty_current
Definition qquicktableview.cpp:1582
kRequiredProperty_tableView
static const char * kRequiredProperty_tableView
Definition qquicktableview.cpp:1579
kRequiredProperty_editing
static const char * kRequiredProperty_editing
Definition qquicktableview.cpp:1583
kRequiredProperty_selected
static const char * kRequiredProperty_selected
Definition qquicktableview.cpp:1581
kRequiredProperty_containsDrag
static const char * kRequiredProperty_containsDrag
Definition qquicktableview.cpp:1584
kRequiredProperties
static const char * kRequiredProperties
Definition qquicktableview.cpp:1580
QT_REQUIRE_CONFIG
QT_REQUIRE_CONFIG(quick_tableview)