aboutsummaryrefslogtreecommitdiffstats
path: root/src/quickcontrols/doc/src/includes/qquickheaderview.qdocinc
blob: 5115149762cc45f52f2c1c3ea507d73be32912e7 (plain)
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
//! [detailed-description]
A \1 provides a styled table header.
It can either be used as an independent view or header for a \l TableView.

You can add a header for a TableView by assigning a \1
to the \l {TableView::syncView} property. The header and the table will
then be kept in sync while flicking.

By default, \1 displays
\l {QAbstractItemModel::headerData()}{header data}
from the \l {TableView::syncView}{sync view's} \l {TableView::model}{model}.
If you don't wish to use this model, you can assign a different model to the
\l {TableView::model}{model} property. If you assign a model that is a
QAbstractItemModel, its header data will be used. Otherwise the data in
the model will be used directly (for example, if you assign a model that
is simply an array of strings).

\note In order to show the header data of a QAbstractItemModel, \1
will internally wrap the model's header data in an independent proxy
model. This model shares no model items with the \l {TableView::model}{application model}.
This means that if you call functions such as \l {TableView::index()}{index()}, the model
index you get back will belong to the proxy model and not the application model.

By default, \l textRole is set to \c "display", meaning that data from the
model's \l {Qt::ItemDataRole}{Qt::DisplayRole} will be used. You can set
this to another role name in order to have that data displayed instead.

The application is responsible for placing the header at the
correct location in the scene. You can add as many headers as you
want to a single TableView, which can be useful if you for example want
to place headers on all four sides of the table.

The following snippet shows how you can add a horizontal and vertical header
view to a table view:

\snippet qtquickcontrols-headerview.qml 0

A \1 will have
\l {TableView::resizableColumns}{resizableColumns} set to \c true by default.
//! [detailed-description]

//! [syncView]
This property holds the TableView to synchronize with.

Once this property is bound to another TableView, both header and table
will synchronize with regard to column widths, column spacing, and flicking
\1.

If the \l model is not explicitly set, then the header will use the syncView's
model to label the columns.

\sa model TableView
//! [syncView]

//! [model]
This property holds the model providing data for the \1 header view.

When model is not explicitly set, the header will use the syncView's
model once syncView is set.

If model is a QAbstractTableModel, its \1 headerData() will
be accessed.

If model is a QAbstractItemModel other than QAbstractTableModel, model's data()
will be accessed.

Otherwise, the behavior is same as setting TableView::model.

\sa TableView {TableView::model} {model} QAbstractTableModel
//! [model]

//! [textRole]
This property holds the model role used to display text in each header cell.

When the model has multiple roles, textRole can be set to determine which
role should be displayed.

If model is a QAbstractItemModel then it will default to "display"; otherwise
it is empty.

A warning is given if the model's \l {QAbstractItemModel::}{roleNames()}
doesn't provide the role specified in \l textRole.
The warning can be silenced by setting the \l textRole.

\sa QAbstractItemModel::roleNames()
//! [textRole]