class QItemSelectionModel#

The QItemSelectionModel class keeps track of a view’s selected items. More…

Synopsis#

Properties#

currentIndexᅟ
hasSelectionᅟ
modelᅟ
selectedIndexesᅟ
selectionᅟ

Methods#

def __init__()
def columnIntersectsSelection()
def currentIndex()
def emitSelectionChanged()
def hasSelection()
def isColumnSelected()
def isRowSelected()
def isSelected()
def model()
def rowIntersectsSelection()
def selectedColumns()
def selectedIndexes()
def selectedRows()
def selection()
def setModel()

Slots#

def clearSelection()

Signals#

def currentChanged()
def currentColumnChanged()
def currentRowChanged()
def modelChanged()
def selectionChanged()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

A QItemSelectionModel keeps track of the selected items in a view, or in several views onto the same model. It also keeps track of the currently selected item in a view.

The QItemSelectionModel class is one of the Model/View Classes and is part of Qt’s model/view framework.

The selected items are stored using ranges. Whenever you want to modify the selected items use select() and provide either a QItemSelection , or a QModelIndex and a SelectionFlag .

The QItemSelectionModel takes a two layer approach to selection management, dealing with both selected items that have been committed and items that are part of the current selection. The current selected items are part of the current interactive selection (for example with rubber-band selection or keyboard-shift selections).

To update the currently selected items, use the bitwise OR of Current and any of the other SelectionFlags . If you omit the Current command, a new current selection will be created, and the previous one added to the whole selection. All functions operate on both layers; for example, selecteditems() will return items from both layers.

Note

Since 5.5, model , hasSelection , and currentIndex are meta-object properties.

See also

QAbstractItemModel

class SelectionFlag#

(inherits enum.Flag) This enum describes the way the selection model will be updated.

Constant

Description

QItemSelectionModel.NoUpdate

No selection will be made.

QItemSelectionModel.Clear

The complete selection will be cleared.

QItemSelectionModel.Select

All specified indexes will be selected.

QItemSelectionModel.Deselect

All specified indexes will be deselected.

QItemSelectionModel.Toggle

All specified indexes will be selected or deselected depending on their current state.

QItemSelectionModel.Current

The current selection will be updated.

QItemSelectionModel.Rows

All indexes will be expanded to span rows.

QItemSelectionModel.Columns

All indexes will be expanded to span columns.

QItemSelectionModel.SelectCurrent

A combination of Select and Current, provided for convenience.

QItemSelectionModel.ToggleCurrent

A combination of Toggle and Current, provided for convenience.

QItemSelectionModel.ClearAndSelect

A combination of Clear and Select, provided for convenience.

Constant	Description
QItemSelectionModel.NoUpdate	No selection will be made.
QItemSelectionModel.Clear	The complete selection will be cleared.
QItemSelectionModel.Select	All specified indexes will be selected.
QItemSelectionModel.Deselect	All specified indexes will be deselected.
QItemSelectionModel.Toggle	All specified indexes will be selected or deselected depending on their current state.
QItemSelectionModel.Current	The current selection will be updated.
QItemSelectionModel.Rows	All indexes will be expanded to span rows.
QItemSelectionModel.Columns	All indexes will be expanded to span columns.
QItemSelectionModel.SelectCurrent	A combination of Select and Current, provided for convenience.
QItemSelectionModel.ToggleCurrent	A combination of Toggle and Current, provided for convenience.
QItemSelectionModel.ClearAndSelect	A combination of Clear and Select, provided for convenience.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property currentIndexᅟ: QModelIndex#

Access functions:

currentIndex()
Signal currentChanged()

property hasSelectionᅟ: bool#

Access functions:

hasSelection()
Signal selectionChanged()

property modelᅟ: QAbstractItemModel#

Access functions:

model()
setModel()
Signal modelChanged()

property selectedIndexesᅟ: list of QModelIndex#

Access functions:

selectedIndexes()
Signal selectionChanged()

property selectionᅟ: QItemSelection#

Access functions:

selection()
Signal selectionChanged()

__init__(model, parent)#

Parameters:

model – QAbstractItemModel
parent – QObject

Constructs a selection model that operates on the specified item model with parent.

__init__([model=None])

Parameters:: model – QAbstractItemModel

Constructs a selection model that operates on the specified item model.

clear()#

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

clearCurrentIndex()#

Clears the current index. Emits currentChanged() .

clearSelection()#

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

columnIntersectsSelection(column[, parent=QModelIndex()])#

Parameters:

column – int
parent – QModelIndex

Return type:

bool

Returns true if there are any items selected in the column with the given parent.

Note

Since Qt 5.15, the default argument for parent is an empty model index.

currentChanged(current, previous)#

Parameters:

current – QModelIndex
previous – QModelIndex

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

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

See also

currentIndex() setCurrentIndex() selectionChanged()

Notification signal of property currentIndexᅟ .

currentColumnChanged(current, previous)#

Parameters:

current – QModelIndex
previous – QModelIndex

This signal is emitted if the current item changes and its column is different to the column of the previous current item.

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

See also

currentChanged() currentRowChanged() currentIndex() setCurrentIndex()

currentIndex()#

Return type:: QModelIndex

Returns the model item index for the current item, or an invalid index if there is no current item.

See also

setCurrentIndex()

Getter of property currentIndexᅟ .

currentRowChanged(current, previous)#

Parameters:

current – QModelIndex
previous – QModelIndex

This signal is emitted if the current item changes and its row is different to the row of the previous current item.

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

See also

currentChanged() currentColumnChanged() currentIndex() setCurrentIndex()

emitSelectionChanged(newSelection, oldSelection)#

Parameters:

newSelection – QItemSelection
oldSelection – QItemSelection

Compares the two selections newSelection and oldSelection and emits selectionChanged() with the deselected and selected items.

hasSelection()#

Return type:: bool

Returns true if the selection model contains any selected item, otherwise returns false.

Getter of property hasSelectionᅟ .

isColumnSelected(column[, parent=QModelIndex()])#

Parameters:

column – int
parent – QModelIndex

Return type:

bool

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

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

Note

Since Qt 5.15, the default argument for parent is an empty model index.

isRowSelected(row[, parent=QModelIndex()])#

Parameters:

row – int
parent – QModelIndex

Return type:

bool

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

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

Note

Since Qt 5.15, the default argument for parent is an empty model index.

isSelected(index)#

Parameters:: index – QModelIndex
Return type:: bool

Returns true if the given model item index is selected.

model()#

Return type:: QAbstractItemModel

Returns the item model operated on by the selection model.

See also

setModel()

Getter of property modelᅟ .

modelChanged(model)#

Parameters:: model – QAbstractItemModel

This signal is emitted when the model is successfully set with setModel() .

See also

model() setModel()

Notification signal of property modelᅟ .

reset()#

Clears the selection model. Does not emit any signals.

rowIntersectsSelection(row[, parent=QModelIndex()])#

Parameters:

row – int
parent – QModelIndex

Return type:

bool

Returns true if there are any items selected in the row with the given parent.

Note

Since Qt 5.15, the default argument for parent is an empty model index.

select(selection, command)#

Parameters:

selection – QItemSelection
command – Combination of SelectionFlag

Selects the item selection using the specified command, and emits selectionChanged() .

See also

SelectionFlag

select(index, command)

Parameters:

index – QModelIndex
command – Combination of SelectionFlag

Selects the model item index using the specified command, and emits selectionChanged() .

See also

SelectionFlags

selectedColumns([row=0])#

Parameters:: row – int
Return type:: .list of QModelIndex

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

See also

selectedIndexes() selectedRows()

selectedIndexes()#

Return type:: .list of QModelIndex

Returns a list of all selected model item indexes. The list contains no duplicates, and is not sorted.

Getter of property selectedIndexesᅟ .

selectedRows([column=0])#

Parameters:: column – int
Return type:: .list of QModelIndex

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

See also

selectedIndexes() selectedColumns()

selection()#

Return type:: QItemSelection

Returns the selection ranges stored in the selection model.

Getter of property selectionᅟ .

selectionChanged(selected, deselected)#

Parameters:

selected – QItemSelection
deselected – QItemSelection

This signal is emitted whenever the selection changes. The change in the selection is represented as an item selection of deselected items and an item selection of 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.

Items which stay selected but change their index are not included in selected and deselected. Thus, this signal might be emitted with both selected and deselected empty, if only the indices of selected items change.

See also

select() currentChanged()

Notification signal of property hasSelectionᅟ .

setCurrentIndex(index, command)#

Parameters:

index – QModelIndex
command – Combination of SelectionFlag

Sets the model item index to be the current item, and emits currentChanged() . The current item is used for keyboard navigation and focus indication; it is independent of any selected items, although a selected item can also be the current item.

Depending on the specified command, the index can also become part of the current selection.

See also

currentIndex() select()

setModel(model)#

Parameters:: model – QAbstractItemModel

Sets the model to model. The modelChanged() signal will be emitted.

See also

model() modelChanged()

Setter of property modelᅟ .