aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/types/qqmlitemselectionmodel.qdoc
blob: 1dc959a9cdcb643a01ab6a9b54d43d3a59eb565d (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
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
/****************************************************************************
**
** Copyright (C) 2017 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 ItemSelectionModel
    \instantiates QItemSelectionModel
    \inqmlmodule QtQml.Models
    \since 5.5
    \ingroup qtquick-models

    \brief Instantiates a QItemSelectionModel to be used in conjunction
    with a QAbstractItemModel and any view supporting it.

    \sa QItemSelectionModel, {Models and Views in Qt Quick}
*/


/*!
    \qmlproperty QAbstractItemModel ItemSelectionModel::model

    This property's value must match the view's model.
*/

/*!
    \qmlproperty bool ItemSelectionModel::hasSelection
    \readonly

    It will trigger property binding updates every time \l selectionChanged()
    is emitted, even though its value hasn't changed.

    \sa selection(), selectedIndexes, select(), selectionChanged()
*/

/*!
    \qmlproperty QModelIndex ItemSelectionModel::currentIndex
    \readonly

    Use \l setCurrentIndex() to set its value.

    \sa setCurrentIndex(), currentChanged()
*/

/*!
    \qmlproperty QModelIndexList ItemSelectionModel::selectedIndexes
    \readonly

    Contains the list of all the indexes in the selection model.
*/

/*!
    \qmlmethod bool ItemSelectionModel::isSelected(QModelIndex index)

    Returns \c true if the given model item \a index is selected.
*/

/*!
    \qmlmethod bool ItemSelectionModel::isRowSelected(int row, QModelIndex parent)

    Returns \c true if all items are selected in the \a row with the given
    \a parent.

    Note that this function is usually faster than calling isSelected()
    on all items in the same row, and that unselectable items are ignored.
*/

/*!
    \qmlmethod bool ItemSelectionModel::isColumnSelected(int column, QModelIndex parent)

    Returns \c true if all items are selected in the \a column with the given
    \a parent.

    Note that this function is usually faster than calling isSelected()
    on all items in the same column, and that unselectable items are ignored.
*/

/*!
    \qmlmethod bool ItemSelectionModel::rowIntersectsSelection(int row, QModelIndex parent)

    Returns \c true if there are any items selected in the \a row with the
    given \a parent.
*/

/*!
    \qmlmethod bool ItemSelectionModel::columnIntersectsSelection(int column, QModelIndex parent)

    Returns \c true if there are any items selected in the \a column with the
    given \a parent.
*/

/*!
    \qmlmethod QModelIndexList ItemSelectionModel::selectedRows(int column)

    Returns the indexes in the given \a column for the rows where all columns
    are selected.

    \sa selectedColumns()
*/

/*!
    \qmlmethod QModelIndexList ItemSelectionModel::selectedColumns(int row)

    Returns the indexes in the given \a row for columns where all rows are
    selected.

    \sa selectedRows()
*/

/*!
    \qmlproperty object ItemSelectionModel::selection
    \readonly

    Holds the selection ranges stored in the selection model.
*/

/*!
    \qmlmethod void ItemSelectionModel::setCurrentIndex(QModelIndex index, SelectionFlags command)
*/

/*!
    \qmlmethod void ItemSelectionModel::select(QModelIndex index, SelectionFlags command)
*/

/*!
    \qmlmethod void ItemSelectionModel::select(QItemSelection selection, SelectionFlags command)
*/

/*!
    \qmlmethod void ItemSelectionModel::clear()

    Clears the selection model. Emits selectionChanged() and currentChanged().
*/

/*!
    \qmlmethod void ItemSelectionModel::reset()

    Clears the selection model. Does not emit any signals.
*/

/*!
    \qmlmethod void ItemSelectionModel::clearSelection()

    Clears the selection in the selection model. Emits selectionChanged().
*/

/*!
    \qmlmethod void ItemSelectionModel::clearCurrentIndex()

    Clears the current index. Emits currentChanged().
*/

/*!
    \qmlsignal ItemSelectionModel::selectionChanged(QItemSelection selected, QItemSelection deselected)

    This signal is emitted whenever the selection changes. The change in the
    selection is represented as an item selection of \a deselected items and
    an item selection of \a selected items.

    Note the that the current index changes independently from the selection.
    Also note that this signal will not be emitted when the item model is reset.

    \sa select(), currentChanged()
*/

/*!
    \qmlsignal ItemSelectionModel::currentChanged(QModelIndex current, QModelIndex previous)

    This signal is emitted whenever the current item changes. The \a previous
    model item index is replaced by the \a current index as the selection's
    current item.

    Note that this signal will not be emitted when the item model is reset.

    \sa currentIndex(), setCurrentIndex(), selectionChanged()
*/