QItemSelection

Synopsis

Functions

• def __add__ (l)
• def __eq__ (l)
• def __iadd__ (l)
• def __iadd__ (t)
• def __lshift__ (l)
• def __lshift__ (t)
• def __ne__ (l)
• def append (t)
• def append (t)
• def at (i)
• def back ()
• def clear ()
• def contains (index)
• def count ()
• def count (t)
• def detachShared ()
• def detach_helper ()
• def detach_helper (alloc)
• def empty ()
• def endsWith (t)
• def first ()
• def front ()
• def indexOf (t[, from=0])
• def indexes ()
• def insert (i, t)
• def isEmpty ()
• def isSharedWith (other)
• def last ()
• def lastIndexOf (t[, from=-1])
• def length ()
• def merge (other, command)
• def mid (pos[, length=-1])
• def move (from, to)
• def operator[] (i)
• def pop_back ()
• def pop_front ()
• def prepend (t)
• def push_back (t)
• def push_front (t)
• def removeAll (t)
• def removeAt (i)
• def removeFirst ()
• def removeLast ()
• def removeOne (t)
• def replace (i, t)
• def reserve (size)
• def select (topLeft, bottomRight)
• def setSharable (sharable)
• def size ()
• def startsWith (t)
• def swap (i, j)
• def takeAt (i)
• def takeFirst ()
• def takeLast ()
• def toSet ()
• def toVector ()
• def value (i)
• def value (i, defaultValue)

Static functions

• def fromSet (set)
• def fromVector (vector)
• def split (range, other, result)

Detailed Description

The PySide.QtGui.QItemSelection class manages information about selected items in a model.

A PySide.QtGui.QItemSelection describes the items in a model that have been selected by the user. A PySide.QtGui.QItemSelection is basically a list of selection ranges, see PySide.QtGui.QItemSelectionRange . It provides functions for creating and manipulating selections, and selecting a range of items from a model.

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

An item selection can be constructed and initialized to contain a range of items from an existing model. The following example constructs a selection that contains a range of items from the given model , beginning at the topLeft , and ending at the bottomRight .

selection = QItemSelection(topLeft, bottomRight)

An empty item selection can be constructed, and later populated as required. So, if the model is going to be unavailable when we construct the item selection, we can rewrite the above code in the following way:

selection = QItemSelection()
...
selection.select(topLeft, bottomRight)

PySide.QtGui.QItemSelection saves memory, and avoids unnecessary work, by working with selection ranges rather than recording the model item index for each item in the selection. Generally, an instance of this class will contain a list of non-overlapping selection ranges.

Use PySide.QtGui.QItemSelection.merge() to merge one item selection into another without making overlapping ranges. Use PySide.QtGui.QItemSelection.split() to split one selection range into smaller ranges based on a another selection range.

See also

Model/View Programming PySide.QtGui.QItemSelectionModel

class PySide.QtGui.QItemSelection

class PySide.QtGui.QItemSelection(QItemSelection)

class PySide.QtGui.QItemSelection(topLeft, bottomRight)

Parameters:

• topLeft – PySide.QtCore.QModelIndex
• bottomRight – PySide.QtCore.QModelIndex
• QItemSelection – PySide.QtGui.QItemSelection

Constructs an empty selection.

Constructs an item selection that extends from the top-left model item, specified by the topLeft index, to the bottom-right item, specified by bottomRight .

PySide.QtGui.QItemSelection.append(t)

Parameters:t –

PySide.QtGui.QItemSelection.append(t)

Parameters:t – PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.at(i)

Parameters:i – PySide.QtCore.int Return type:PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.back()

Return type:PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.clear()

PySide.QtGui.QItemSelection.contains(index)

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

Returns true if the selection contains the given index ; otherwise returns false.

PySide.QtGui.QItemSelection.count()

Return type:PySide.QtCore.int

PySide.QtGui.QItemSelection.count(t)

Parameters:t – PySide.QtGui.QItemSelectionRange Return type:PySide.QtCore.int

PySide.QtGui.QItemSelection.detachShared()

PySide.QtGui.QItemSelection.detach_helper(alloc)

Parameters:alloc – PySide.QtCore.int

PySide.QtGui.QItemSelection.detach_helper()

PySide.QtGui.QItemSelection.empty()

Return type:PySide.QtCore.bool

PySide.QtGui.QItemSelection.endsWith(t)

Parameters:t – PySide.QtGui.QItemSelectionRange Return type:PySide.QtCore.bool

PySide.QtGui.QItemSelection.first()

Return type:PySide.QtGui.QItemSelectionRange

static PySide.QtGui.QItemSelection.fromSet(set)

Parameters:set – Return type:

static PySide.QtGui.QItemSelection.fromVector(vector)

Parameters:vector – Return type:

PySide.QtGui.QItemSelection.front()

Return type:PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.indexOf(t[, from=0])

Parameters:

• t – PySide.QtGui.QItemSelectionRange
• from – PySide.QtCore.int

Return type:

PySide.QtCore.int

PySide.QtGui.QItemSelection.indexes()

Return type:

Returns a list of model indexes that correspond to the selected items.

PySide.QtGui.QItemSelection.insert(i, t)

Parameters:

• i – PySide.QtCore.int
• t – PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.isEmpty()

Return type:PySide.QtCore.bool

PySide.QtGui.QItemSelection.isSharedWith(other)

Parameters:other – Return type:PySide.QtCore.bool

PySide.QtGui.QItemSelection.last()

Return type:PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.lastIndexOf(t[, from=-1])

Parameters:

• t – PySide.QtGui.QItemSelectionRange
• from – PySide.QtCore.int

Return type:

PySide.QtCore.int

PySide.QtGui.QItemSelection.length()

Return type:PySide.QtCore.int

PySide.QtGui.QItemSelection.merge(other, command)

Parameters:

• other – PySide.QtGui.QItemSelection
• command – PySide.QtGui.QItemSelectionModel.SelectionFlags

PySide.QtGui.QItemSelection.mid(pos[, length=-1])

Parameters:

• pos – PySide.QtCore.int
• length – PySide.QtCore.int

Return type:

PySide.QtGui.QItemSelection.move(from, to)

Parameters:

• from – PySide.QtCore.int
• to – PySide.QtCore.int

PySide.QtGui.QItemSelection.__ne__(l)

Parameters:l – Return type:PySide.QtCore.bool

PySide.QtGui.QItemSelection.__add__(l)

Parameters:l – Return type:

PySide.QtGui.QItemSelection.__iadd__(l)

Parameters:l – Return type:

PySide.QtGui.QItemSelection.__iadd__(t)

Parameters:t – PySide.QtGui.QItemSelectionRange Return type:

PySide.QtGui.QItemSelection.__lshift__(l)

Parameters:l – Return type:

PySide.QtGui.QItemSelection.__lshift__(t)

Parameters:t – PySide.QtGui.QItemSelectionRange Return type:

PySide.QtGui.QItemSelection.__eq__(l)

Parameters:l – Return type:PySide.QtCore.bool

PySide.QtGui.QItemSelection.operator[](i)

Parameters:i – PySide.QtCore.int Return type:PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.pop_back()

PySide.QtGui.QItemSelection.pop_front()

PySide.QtGui.QItemSelection.prepend(t)

Parameters:t – PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.push_back(t)

Parameters:t – PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.push_front(t)

Parameters:t – PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.removeAll(t)

Parameters:t – PySide.QtGui.QItemSelectionRange Return type:PySide.QtCore.int

PySide.QtGui.QItemSelection.removeAt(i)

Parameters:i – PySide.QtCore.int

PySide.QtGui.QItemSelection.removeFirst()

PySide.QtGui.QItemSelection.removeLast()

PySide.QtGui.QItemSelection.removeOne(t)

Parameters:t – PySide.QtGui.QItemSelectionRange Return type:PySide.QtCore.bool

PySide.QtGui.QItemSelection.replace(i, t)

Parameters:

• i – PySide.QtCore.int
• t – PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.reserve(size)

Parameters:size – PySide.QtCore.int

PySide.QtGui.QItemSelection.select(topLeft, bottomRight)

Parameters:

• topLeft – PySide.QtCore.QModelIndex
• bottomRight – PySide.QtCore.QModelIndex

Adds the items in the range that extends from the top-left model item, specified by the topLeft index, to the bottom-right item, specified by bottomRight to the list.

Note

topLeft and bottomRight must have the same parent.

PySide.QtGui.QItemSelection.setSharable(sharable)

Parameters:sharable – PySide.QtCore.bool

PySide.QtGui.QItemSelection.size()

Return type:PySide.QtCore.int

static PySide.QtGui.QItemSelection.split(range, other, result)

Parameters:

• range – PySide.QtGui.QItemSelectionRange
• other – PySide.QtGui.QItemSelectionRange
• result – PySide.QtGui.QItemSelection

Splits the selection range using the selection other range. Removes all items in other from range and puts the result in result . This can be compared with the semantics of the subtract operation of a set.

See also

PySide.QtGui.QItemSelection.merge()

PySide.QtGui.QItemSelection.startsWith(t)

Parameters:t – PySide.QtGui.QItemSelectionRange Return type:PySide.QtCore.bool

PySide.QtGui.QItemSelection.swap(i, j)

Parameters:

• i – PySide.QtCore.int
• j – PySide.QtCore.int

PySide.QtGui.QItemSelection.takeAt(i)

Parameters:i – PySide.QtCore.int Return type:PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.takeFirst()

Return type:PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.takeLast()

Return type:PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.toSet()

Return type:

PySide.QtGui.QItemSelection.toVector()

Return type:

PySide.QtGui.QItemSelection.value(i)

Parameters:i – PySide.QtCore.int Return type:PySide.QtGui.QItemSelectionRange

PySide.QtGui.QItemSelection.value(i, defaultValue)

Parameters:

• i – PySide.QtCore.int
• defaultValue – PySide.QtGui.QItemSelectionRange

Return type:

PySide.QtGui.QItemSelectionRange