QItemSelectionModel¶

Synopsis¶

Functions¶

def columnIntersectsSelection (column, parent)
def currentIndex ()
def emitSelectionChanged (newSelection, oldSelection)
def hasSelection ()
def isColumnSelected (column, parent)
def isRowSelected (row, parent)
def isSelected (index)
def model ()
def rowIntersectsSelection (row, parent)
def selectedColumns ([row=0])
def selectedIndexes ()
def selectedRows ([column=0])
def selection ()

Virtual functions¶

def clear ()
def reset ()
def select (index, command)
def select (selection, command)

Slots¶

def clearSelection ()
def setCurrentIndex (index, command)

Signals¶

def currentChanged (current, previous)
def currentColumnChanged (current, previous)
def currentRowChanged (current, previous)
def selectionChanged (selected, deselected)

Detailed Description¶

The PySide.QtGui.QItemSelectionModel class keeps track of a view’s selected items.

A PySide.QtGui.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 PySide.QtGui.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 PySide.QtGui.QItemSelectionModel.select() and provide either a PySide.QtGui.QItemSelection , or a PySide.QtCore.QModelIndex and a QItemSelectionModel.SelectionFlag .

The PySide.QtGui.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 QItemSelectionModel.Current and any of the other SelectionFlags . If you omit the QItemSelectionModel.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.

See also

Model/View Programming PySide.QtCore.QAbstractItemModel Chart Example

class PySide.QtGui.QItemSelectionModel(model)¶

class PySide.QtGui.QItemSelectionModel(model, parent)

Parameters:	model – `PySide.QtCore.QAbstractItemModel` parent – `PySide.QtCore.QObject`

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

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

PySide.QtGui.QItemSelectionModel.SelectionFlag¶

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.

PySide.QtGui.QItemSelectionModel.clear()¶: Clears the selection model. Emits PySide.QtGui.QItemSelectionModel.selectionChanged() and PySide.QtGui.QItemSelectionModel.currentChanged() .

PySide.QtGui.QItemSelectionModel.clearSelection()¶: Clears the selection in the selection model. Emits PySide.QtGui.QItemSelectionModel.selectionChanged() .

PySide.QtGui.QItemSelectionModel.columnIntersectsSelection(column, parent)¶

Parameters:	column – `PySide.QtCore.int` parent – `PySide.QtCore.QModelIndex`
Return type:	`PySide.QtCore.bool`

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

PySide.QtGui.QItemSelectionModel.currentChanged(current, previous)¶

Parameters:	current – `PySide.QtCore.QModelIndex` previous – `PySide.QtCore.QModelIndex`

PySide.QtGui.QItemSelectionModel.currentColumnChanged(current, previous)¶

Parameters:	current – `PySide.QtCore.QModelIndex` previous – `PySide.QtCore.QModelIndex`

PySide.QtGui.QItemSelectionModel.currentIndex()¶

Return type:	`PySide.QtCore.QModelIndex`

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

PySide.QtGui.QItemSelectionModel.currentRowChanged(current, previous)¶

Parameters:	current – `PySide.QtCore.QModelIndex` previous – `PySide.QtCore.QModelIndex`

PySide.QtGui.QItemSelectionModel.emitSelectionChanged(newSelection, oldSelection)¶

Parameters:	newSelection – `PySide.QtGui.QItemSelection` oldSelection – `PySide.QtGui.QItemSelection`

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

PySide.QtGui.QItemSelectionModel.hasSelection()¶

Return type:	`PySide.QtCore.bool`

Returns true if the selection model contains any selection ranges; otherwise returns false.

PySide.QtGui.QItemSelectionModel.isColumnSelected(column, parent)¶

Parameters:	column – `PySide.QtCore.int` parent – `PySide.QtCore.QModelIndex`
Return type:	`PySide.QtCore.bool`

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

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

PySide.QtGui.QItemSelectionModel.isRowSelected(row, parent)¶

Parameters:	row – `PySide.QtCore.int` parent – `PySide.QtCore.QModelIndex`
Return type:	`PySide.QtCore.bool`

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

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

PySide.QtGui.QItemSelectionModel.isSelected(index)¶

Parameters:	index – `PySide.QtCore.QModelIndex`
Return type:	`PySide.QtCore.bool`

Returns true if the given model item index is selected.

PySide.QtGui.QItemSelectionModel.model()¶

Return type:	`PySide.QtCore.QAbstractItemModel`

Returns the item model operated on by the selection model.

PySide.QtGui.QItemSelectionModel.reset()¶: Clears the selection model. Does not emit any signals.

PySide.QtGui.QItemSelectionModel.rowIntersectsSelection(row, parent)¶

Parameters:	row – `PySide.QtCore.int` parent – `PySide.QtCore.QModelIndex`
Return type:	`PySide.QtCore.bool`

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

PySide.QtGui.QItemSelectionModel.select(index, command)¶

Parameters:	index – `PySide.QtCore.QModelIndex` command – `PySide.QtGui.QItemSelectionModel.SelectionFlags`

PySide.QtGui.QItemSelectionModel.select(selection, command)

Parameters:	selection – `PySide.QtGui.QItemSelection` command – `PySide.QtGui.QItemSelectionModel.SelectionFlags`

PySide.QtGui.QItemSelectionModel.selectedColumns([row=0])¶

Parameters:	row – `PySide.QtCore.int`
Return type:	`PySide.QtCore.QModelIndexList`

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

Table Of Contents

Previous topic

Next topic

QItemSelectionModel¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Detailed Description¶

Parameters:	column – `PySide.QtCore.int`
Return type:	`PySide.QtCore.QModelIndexList`

Table Of Contents

Previous topic

Next topic

Quick search

QItemSelectionModel¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Detailed Description¶