1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\qmltype TableView
\inqmlmodule QtQuick.Controls
\inherits BasicTableView
\since 5.1
\ingroup views
\ingroup controls
\brief Provides a list view with scroll bars, styling and header sections.
\image tableview.png
A TableView is similar to \l ListView, and adds scroll bars, selection, and
resizable header sections. As with \l ListView, data for each row is provided through a \l model:
\code
ListModel {
id: libraryModel
ListElement {
title: "A Masterpiece"
author: "Gabriel"
}
ListElement {
title: "Brilliance"
author: "Jens"
}
ListElement {
title: "Outstanding"
author: "Frederik"
}
}
\endcode
You provide title and size of a column header
by adding a \l TableViewColumn as demonstrated below.
\code
TableView {
TableViewColumn {
role: "title"
title: "Title"
width: 100
}
TableViewColumn {
role: "author"
title: "Author"
width: 200
}
model: libraryModel
}
\endcode
The header sections are attached to values in the \l model by defining
the model role they attach to. Each property in the model will
then be shown in their corresponding column.
You can customize the look by overriding the \l {BasicTableView::}{itemDelegate},
\l {BasicTableView::}{rowDelegate}, or \l {BasicTableView::}{headerDelegate} properties.
The view itself does not provide sorting. This has to
be done on the model itself. However you can provide sorting
on the model, and enable sort indicators on headers.
\list
\li int sortIndicatorColumn - The index of the current sort column
\li bool sortIndicatorVisible - Whether the sort indicator should be enabled
\li enum sortIndicatorOrder - Qt.AscendingOrder or Qt.DescendingOrder depending on state
\endlist
You can create a custom appearance for a TableView by
assigning a \l {TableViewStyle}.
*/
/*! \qmlproperty model TableView::model
This property holds the model providing data for the table view.
The model provides the set of data that is used to create the items in the view.
Models can be created directly in QML using ListModel, XmlListModel or VisualItemModel,
or provided by C++ model classes. \sa ListView::model
Example model:
\code
model: ListModel {
ListElement {
column1: "value 1"
column2: "value 2"
}
ListElement {
column1: "value 3"
column2: "value 4"
}
}
\endcode
\sa {qml-data-models}{Data Models}
*/
/*! \qmlproperty int TableView::rowCount
The current number of rows
*/
/*! \qmlproperty int TableView::currentRow
The current row index of the view.
The default value is \c -1 to indicate that no row is selected.
*/
/*! \qmlsignal TableView::activated(int row)
Emitted when the user activates an item by mouse or keyboard interaction.
Mouse activation is triggered by single- or double-clicking, depending on the platform.
\a row int provides access to the activated row index.
\note This signal is only emitted for mouse interaction that is not blocked in the row or item delegate.
The corresponding handler is \c onActivated.
*/
/*! \qmlsignal TableView::clicked(int row)
Emitted when the user clicks a valid row by single clicking
\a row int provides access to the clicked row index.
\note This signal is only emitted if the row or item delegate does not accept mouse events.
The corresponding handler is \c onClicked.
*/
/*! \qmlsignal TableView::doubleClicked(int row)
Emitted when the user double clicks a valid row.
\a row int provides access to the clicked row index.
\note This signal is only emitted if the row or item delegate does not accept mouse events.
The corresponding handler is \c onDoubleClicked.
*/
/*! \qmlsignal TableView::pressAndHold(int row)
\since QtQuick.Controls 1.3
Emitted when the user presses and holds a valid row.
\a row int provides access to the pressed row index.
\note This signal is only emitted if the row or item delegate does not accept mouse events.
The corresponding handler is \c onPressAndHold.
*/
/*!
\qmlmethod void TableView::positionViewAtRow( int row, PositionMode mode )
Positions the view such that the specified \a row is at the position defined by \a mode:
\list
\li ListView.Beginning - position item at the top of the view.
\li ListView.Center - position item in the center of the view.
\li ListView.End - position item at bottom of the view.
\li ListView.Visible - if any part of the item is visible then take no action, otherwise bring the item into view.
\li ListView.Contain - ensure the entire item is visible. If the item is larger than the view the item is positioned
at the top of the view.
\endlist
If positioning the \a row creates an empty space at the beginning
or end of the view, then the view is positioned at the boundary.
For example, to position the view at the end at startup:
\code
Component.onCompleted: table.positionViewAtRow(rowCount -1, ListView.Contain)
\endcode
Depending on how the model is populated, the model may not be ready when
TableView Component.onCompleted is called. In that case you may need to
delay the call to positionViewAtRow by using a \l [QtQml]{Timer}.
\note This method should only be called after the component has completed.
*/
/*!
\qmlmethod int TableView::rowAt( int x, int y )
Returns the index of the visible row at the point \a x, \a y in content
coordinates. If there is no visible row at the point specified, \c -1 is returned.
\note This method should only be called after the component has completed.
*/
/*! \qmlproperty Selection TableView::selection
\since QtQuick.Controls 1.1
This property contains the current row-selection of the \l TableView.
The selection allows you to select, deselect or iterate over selected rows.
\list
\li function \b clear() - deselects all rows
\li function \b selectAll() - selects all rows
\li function \b select(from, to) - selects a range
\li function \b deselect(from, to) - deselects a range
\li function \b forEach(callback) - iterates over all selected rows
\li function \b contains(index) - checks whether the selection includes the given index
\li signal \b selectionChanged() - the current row selection changed
\li readonly property int \b count - the number of selected rows
\endlist
\b Example:
\code
tableview.selection.select(0) // select row index 0
tableview.selection.select(1, 3) // select row indexes 1, 2 and 3
tableview.selection.deselect(0, 1) // deselects row index 0 and 1
tableview.selection.deselect(2) // deselects row index 2
\endcode
\b Example: To iterate over selected indexes, you can pass a callback function.
\a rowIndex is passed as an argument to the callback function.
\code
tableview.selection.forEach( function(rowIndex) {console.log(rowIndex)} )
\endcode
*/
/*!
\qmlproperty Component TableView::itemDelegate
This property defines a delegate to draw a specific cell.
In the item delegate you have access to the following special properties:
\list
\li styleData.selected - if the item is currently selected
\li styleData.value - the value or text for this item
\li styleData.textColor - the default text color for an item
\li styleData.row - the index of the view row
\li styleData.column - the index of the view column
\li styleData.elideMode - the elide mode of the column
\li styleData.textAlignment - the horizontal text alignment of the column
\li styleData.role - the role of the view column
\li styleData.pressed - true when the item is pressed (since QtQuick.Controls 1.3)
\li styleData.hasActiveFocus - true when the row has focus (since QtQuick.Controls 1.3)
\endlist
Example:
\code
itemDelegate: Item {
Text {
anchors.verticalCenter: parent.verticalCenter
color: styleData.textColor
elide: styleData.elideMode
text: styleData.value
}
}
\endcode
\note For performance reasons, created delegates can be recycled
across multiple table rows. This implies that when you make use of implicit
properties such as \c styleData.row or \c model, these values can change
after the delegate has been constructed. This means that you should not assume
that content is fixed when \c Component.onCompleted is called, but instead rely on
bindings to such properties.
*/
/*!
\qmlpropertygroup QtQuick.Controls::TableView::section
\qmlproperty string TableView::section.property
\qmlproperty enumeration TableView::section.criteria
\qmlproperty Component TableView::section.delegate
\qmlproperty enumeration TableView::section.labelPositioning
These properties determine the section labels.
\sa {QtQuick::ListView::section}{ListView.section}
*/
|
