QItemSelectionRange

Inheritance diagram of PySide2.QtCore.QItemSelectionRange

Synopsis

Functions

Detailed Description

The PySide2.QtCore.QItemSelectionRange class manages information about a range of selected items in a model.

A PySide2.QtCore.QItemSelectionRange contains information about a range of selected items in a model. A range of items is a contiguous array of model items, extending to cover a number of adjacent rows and columns with a common parent item; this can be visualized as a two-dimensional block of cells in a table. A selection range has a PySide2.QtCore.QItemSelectionRange.top() , PySide2.QtCore.QItemSelectionRange.left() a PySide2.QtCore.QItemSelectionRange.bottom() , PySide2.QtCore.QItemSelectionRange.right() and a PySide2.QtCore.QItemSelectionRange.parent() .

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

The model items contained in the selection range can be obtained using the PySide2.QtCore.QItemSelectionRange.indexes() function. Use QItemSelectionModel.selectedIndexes() to get a list of all selected items for a view.

You can determine whether a given model item lies within a particular range by using the PySide2.QtCore.QItemSelectionRange.contains() function. Ranges can also be compared using the overloaded operators for equality and inequality, and the PySide2.QtCore.QItemSelectionRange.intersects() function allows you to determine whether two ranges overlap.

class PySide2.QtCore.QItemSelectionRange
class PySide2.QtCore.QItemSelectionRange(other)
class PySide2.QtCore.QItemSelectionRange(index)
class PySide2.QtCore.QItemSelectionRange(topL, bottomR)
Parameters:

Constructs an empty selection range.

Copy constructor. Constructs a new selection range with the same contents as the other range given.

Constructs a new selection range containing only the model item specified by the model index index .

Constructs a new selection range containing only the index specified by the topLeft and the index bottomRight .

PySide2.QtCore.QItemSelectionRange.bottom()
Return type:PySide2.QtCore.int

Returns the row index corresponding to the lowermost selected row in the selection range.

PySide2.QtCore.QItemSelectionRange.bottomRight()
Return type:PySide2.QtCore.QPersistentModelIndex

Returns the index for the item located at the bottom-right corner of the selection range.

PySide2.QtCore.QItemSelectionRange.contains(row, column, parentIndex)
Parameters:
Return type:

PySide2.QtCore.bool

This is an overloaded function.

Returns true if the model item specified by (row , column ) and with parentIndex as the parent item lies within the range of selected items; otherwise returns false .

PySide2.QtCore.QItemSelectionRange.contains(index)
Parameters:indexPySide2.QtCore.QModelIndex
Return type:PySide2.QtCore.bool

Returns true if the model item specified by the index lies within the range of selected items; otherwise returns false .

PySide2.QtCore.QItemSelectionRange.height()
Return type:PySide2.QtCore.int

Returns the number of selected rows in the selection range.

PySide2.QtCore.QItemSelectionRange.indexes()
Return type:PySide2.QtCore.QModelIndexList

Returns the list of model index items stored in the selection.

PySide2.QtCore.QItemSelectionRange.intersected(other)
Parameters:otherPySide2.QtCore.QItemSelectionRange
Return type:PySide2.QtCore.QItemSelectionRange

Returns a new selection range containing only the items that are found in both the selection range and the other selection range.

PySide2.QtCore.QItemSelectionRange.intersects(other)
Parameters:otherPySide2.QtCore.QItemSelectionRange
Return type:PySide2.QtCore.bool

Returns true if this selection range intersects (overlaps with) the other range given; otherwise returns false .

PySide2.QtCore.QItemSelectionRange.isEmpty()
Return type:PySide2.QtCore.bool

Returns true if the selection range contains no selectable item

PySide2.QtCore.QItemSelectionRange.isValid()
Return type:PySide2.QtCore.bool

Returns true if the selection range is valid; otherwise returns false .

PySide2.QtCore.QItemSelectionRange.left()
Return type:PySide2.QtCore.int

Returns the column index corresponding to the leftmost selected column in the selection range.

PySide2.QtCore.QItemSelectionRange.model()
Return type:PySide2.QtCore.QAbstractItemModel

Returns the model that the items in the selection range belong to.

PySide2.QtCore.QItemSelectionRange.__ne__(other)
Parameters:otherPySide2.QtCore.QItemSelectionRange
Return type:PySide2.QtCore.bool

Returns true if the selection range differs from the other range given; otherwise returns false .

PySide2.QtCore.QItemSelectionRange.__lt__(other)
Parameters:otherPySide2.QtCore.QItemSelectionRange
Return type:PySide2.QtCore.bool

Returns true if the selection range is less than the other range given; otherwise returns false .

The less than calculation is not directly useful to developers - the way that ranges with different parents compare is not defined. This operator only exists so that the class can be used with QMap .

PySide2.QtCore.QItemSelectionRange.__eq__(other)
Parameters:otherPySide2.QtCore.QItemSelectionRange
Return type:PySide2.QtCore.bool

Returns true if the selection range is exactly the same as the other range given; otherwise returns false .

PySide2.QtCore.QItemSelectionRange.parent()
Return type:PySide2.QtCore.QModelIndex

Returns the parent model item index of the items in the selection range.

PySide2.QtCore.QItemSelectionRange.right()
Return type:PySide2.QtCore.int

Returns the column index corresponding to the rightmost selected column in the selection range.

PySide2.QtCore.QItemSelectionRange.swap(other)
Parameters:otherPySide2.QtCore.QItemSelectionRange

Swaps this selection range’s contents with other . This function is very fast and never fails.

PySide2.QtCore.QItemSelectionRange.top()
Return type:PySide2.QtCore.int

Returns the row index corresponding to the uppermost selected row in the selection range.

PySide2.QtCore.QItemSelectionRange.topLeft()
Return type:PySide2.QtCore.QPersistentModelIndex

Returns the index for the item located at the top-left corner of the selection range.

PySide2.QtCore.QItemSelectionRange.width()
Return type:PySide2.QtCore.int

Returns the number of selected columns in the selection range.