QAbstractItemView

The QAbstractItemView class provides the basic functionality for item view classes. More

Inheritance diagram of PySide2.QtWidgets.QAbstractItemView

Inherited by: QHelpContentWidget, QHelpIndexWidget, QColumnView, QHeaderView, QListView, QListWidget, QTableView, QTableWidget, QTreeView, QTreeWidget, QUndoView

Synopsis

Functions

Virtual functions

Slots

Signals

Detailed Description

QAbstractItemView class is the base class for every standard view that uses a QAbstractItemModel . QAbstractItemView is an abstract class and cannot itself be instantiated. It provides a standard interface for interoperating with models through the signals and slots mechanism, enabling subclasses to be kept up-to-date with changes to their models. This class provides standard support for keyboard and mouse navigation, viewport scrolling, item editing, and selections. The keyboard navigation implements this functionality:

Keys

Functionality

Arrow keys

Changes the current item and selects it.

Ctrl+Arrow keys

Changes the current item but does not select it.

Shift+Arrow keys

Changes the current item and selects it. The previously selected item(s) is not deselected.

Ctr+Space

Toggles selection of the current item.

Tab/Backtab

Changes the current item to the next/previous item.

Home/End

Selects the first/last item in the model.

Page up/Page down

Scrolls the rows shown up/down by the number of visible rows in the view.

Ctrl+A

Selects all items in the model.

Note that the above table assumes that the selection mode allows the operations. For instance, you cannot select items if the selection mode is NoSelection .

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

The view classes that inherit QAbstractItemView only need to implement their own view-specific functionality, such as drawing items, returning the geometry of items, finding items, etc.

QAbstractItemView provides common slots such as edit() and setCurrentIndex() . Many protected slots are also provided, including dataChanged() , rowsInserted() , rowsAboutToBeRemoved() , selectionChanged() , and currentChanged() .

The root item is returned by rootIndex() , and the current item by currentIndex() . To make sure that an item is visible use scrollTo() .

Some of QAbstractItemView ‘s functions are concerned with scrolling, for example setHorizontalScrollMode() and setVerticalScrollMode() . To set the range of the scroll bars, you can, for example, reimplement the view’s resizeEvent() function:

def resizeEvent(self, event):
    horizontalScrollBar().setRange(0, realWidth - width())
    ...

Note that the range is not updated until the widget is shown.

Several other functions are concerned with selection control; for example setSelectionMode() , and setSelectionBehavior() . This class provides a default selection model to work with ( selectionModel() ), but this can be replaced by using setSelectionModel() with an instance of QItemSelectionModel .

For complete control over the display and editing of items you can specify a delegate with setItemDelegate() .

QAbstractItemView provides a lot of protected functions. Some are concerned with editing, for example, edit() , and commitData() , whilst others are keyboard and mouse event handlers.

Note

If you inherit QAbstractItemView and intend to update the contents of the viewport, you should use viewport-> update() instead of update() as all painting operations take place on the viewport.

class QAbstractItemView([parent=None])
param parent

QWidget

Constructs an abstract item view with the given parent .

PySide2.QtWidgets.QAbstractItemView.SelectionMode

This enum indicates how the view responds to user selections:

Constant

Description

QAbstractItemView.SingleSelection

When the user selects an item, any already-selected item becomes unselected. It is possible for the user to deselect the selected item.

QAbstractItemView.ContiguousSelection

When the user selects an item in the usual way, the selection is cleared and the new item selected. However, if the user presses the Shift key while clicking on an item, all items between the current item and the clicked item are selected or unselected, depending on the state of the clicked item.

QAbstractItemView.ExtendedSelection

When the user selects an item in the usual way, the selection is cleared and the new item selected. However, if the user presses the Ctrl key when clicking on an item, the clicked item gets toggled and all other items are left untouched. If the user presses the Shift key while clicking on an item, all items between the current item and the clicked item are selected or unselected, depending on the state of the clicked item. Multiple items can be selected by dragging the mouse over them.

QAbstractItemView.MultiSelection

When the user selects an item in the usual way, the selection status of that item is toggled and the other items are left alone. Multiple items can be toggled by dragging the mouse over them.

QAbstractItemView.NoSelection

Items cannot be selected.

The most commonly used modes are and .

PySide2.QtWidgets.QAbstractItemView.SelectionBehavior

Constant

Description

QAbstractItemView.SelectItems

Selecting single items.

QAbstractItemView.SelectRows

Selecting only rows.

QAbstractItemView.SelectColumns

Selecting only columns.

PySide2.QtWidgets.QAbstractItemView.ScrollHint

Constant

Description

QAbstractItemView.EnsureVisible

Scroll to ensure that the item is visible.

QAbstractItemView.PositionAtTop

Scroll to position the item at the top of the viewport.

QAbstractItemView.PositionAtBottom

Scroll to position the item at the bottom of the viewport.

QAbstractItemView.PositionAtCenter

Scroll to position the item at the center of the viewport.

PySide2.QtWidgets.QAbstractItemView.EditTrigger

This enum describes actions which will initiate item editing.

Constant

Description

QAbstractItemView.NoEditTriggers

No editing possible.

QAbstractItemView.CurrentChanged

Editing start whenever current item changes.

QAbstractItemView.DoubleClicked

Editing starts when an item is double clicked.

QAbstractItemView.SelectedClicked

Editing starts when clicking on an already selected item.

QAbstractItemView.EditKeyPressed

Editing starts when the platform edit key has been pressed over an item.

QAbstractItemView.AnyKeyPressed

Editing starts when any key is pressed over an item.

QAbstractItemView.AllEditTriggers

Editing starts for all above actions.

PySide2.QtWidgets.QAbstractItemView.ScrollMode

Describes how the scrollbar should behave. When setting the scroll mode to the single step size will adjust automatically unless it was set explicitly using setSingleStep() . The automatic adjustment can be restored by setting the single step size to -1.

Constant

Description

QAbstractItemView.ScrollPerItem

The view will scroll the contents one item at a time.

QAbstractItemView.ScrollPerPixel

The view will scroll the contents one pixel at a time.

PySide2.QtWidgets.QAbstractItemView.DragDropMode

Describes the various drag and drop events the view can act upon. By default the view does not support dragging or dropping (NoDragDrop ).

Constant

Description

QAbstractItemView.NoDragDrop

Does not support dragging or dropping.

QAbstractItemView.DragOnly

The view supports dragging of its own items

QAbstractItemView.DropOnly

The view accepts drops

QAbstractItemView.DragDrop

The view supports both dragging and dropping

QAbstractItemView.InternalMove

The view accepts move (not copy) operations only from itself.

Note that the model used needs to provide support for drag and drop operations.

PySide2.QtWidgets.QAbstractItemView.CursorAction

This enum describes the different ways to navigate between items,

Constant

Description

QAbstractItemView.MoveUp

Move to the item above the current item.

QAbstractItemView.MoveDown

Move to the item below the current item.

QAbstractItemView.MoveLeft

Move to the item left of the current item.

QAbstractItemView.MoveRight

Move to the item right of the current item.

QAbstractItemView.MoveHome

Move to the top-left corner item.

QAbstractItemView.MoveEnd

Move to the bottom-right corner item.

QAbstractItemView.MovePageUp

Move one page up above the current item.

QAbstractItemView.MovePageDown

Move one page down below the current item.

QAbstractItemView.MoveNext

Move to the item after the current item.

QAbstractItemView.MovePrevious

Move to the item before the current item.

See also

moveCursor()

PySide2.QtWidgets.QAbstractItemView.State

Describes the different states the view can be in. This is usually only interesting when reimplementing your own view.

Constant

Description

QAbstractItemView.NoState

The is the default state.

QAbstractItemView.DraggingState

The user is dragging items.

QAbstractItemView.DragSelectingState

The user is selecting items.

QAbstractItemView.EditingState

The user is editing an item in a widget editor.

QAbstractItemView.ExpandingState

The user is opening a branch of items.

QAbstractItemView.CollapsingState

The user is closing a branch of items.

QAbstractItemView.AnimatingState

The item view is performing an animation.

PySide2.QtWidgets.QAbstractItemView.DropIndicatorPosition

This enum indicates the position of the drop indicator in relation to the index at the current mouse position:

Constant

Description

QAbstractItemView.OnItem

The item will be dropped on the index.

QAbstractItemView.AboveItem

The item will be dropped above the index.

QAbstractItemView.BelowItem

The item will be dropped below the index.

QAbstractItemView.OnViewport

The item will be dropped onto a region of the viewport with no items. The way each view handles items dropped onto the viewport depends on the behavior of the underlying model in use.

PySide2.QtWidgets.QAbstractItemView.activated(index)
Parameters

indexQModelIndex

PySide2.QtWidgets.QAbstractItemView.alternatingRowColors()
Return type

bool

PySide2.QtWidgets.QAbstractItemView.autoScrollMargin()
Return type

int

PySide2.QtWidgets.QAbstractItemView.clearSelection()

Deselects all selected items. The current index will not be changed.

PySide2.QtWidgets.QAbstractItemView.clicked(index)
Parameters

indexQModelIndex

PySide2.QtWidgets.QAbstractItemView.closeEditor(editor, hint)
Parameters
  • editorQWidget

  • hintEndEditHint

Closes the given editor , and releases it. The hint is used to specify how the view should respond to the end of the editing operation. For example, the hint may indicate that the next item in the view should be opened for editing.

See also

edit() commitData()

PySide2.QtWidgets.QAbstractItemView.closePersistentEditor(index)
Parameters

indexQModelIndex

Closes the persistent editor for the item at the given index .

PySide2.QtWidgets.QAbstractItemView.commitData(editor)
Parameters

editorQWidget

Commit the data in the editor to the model.

See also

closeEditor()

PySide2.QtWidgets.QAbstractItemView.currentChanged(current, previous)
Parameters
  • currentQModelIndex

  • previousQModelIndex

This slot is called when a new item becomes the current item. The previous current item is specified by the previous index, and the new item by the current index.

If you want to know about changes to items see the dataChanged() signal.

PySide2.QtWidgets.QAbstractItemView.currentIndex()
Return type

QModelIndex

Returns the model index of the current item.

PySide2.QtWidgets.QAbstractItemView.dataChanged(topLeft, bottomRight[, roles=list()])
Parameters
  • topLeftQModelIndex

  • bottomRightQModelIndex

  • roles

This slot is called when items with the given roles are changed in the model. The changed items are those from topLeft to bottomRight inclusive. If just one item is changed topLeft == bottomRight .

The roles which have been changed can either be an empty container (meaning everything has changed), or a non-empty container with the subset of roles which have changed.

PySide2.QtWidgets.QAbstractItemView.defaultDropAction()
Return type

DropAction

PySide2.QtWidgets.QAbstractItemView.dirtyRegionOffset()
Return type

QPoint

Returns the offset of the dirty regions in the view.

If you use scrollDirtyRegion() and implement a paintEvent() in a subclass of QAbstractItemView , you should translate the area given by the paint event with the offset returned from this function.

PySide2.QtWidgets.QAbstractItemView.doAutoScroll()
PySide2.QtWidgets.QAbstractItemView.doItemsLayout()

This function is intended to lay out the items in the view. The default implementation just calls updateGeometries() and updates the viewport.

PySide2.QtWidgets.QAbstractItemView.doubleClicked(index)
Parameters

indexQModelIndex

PySide2.QtWidgets.QAbstractItemView.dragDropMode()
Return type

DragDropMode

PySide2.QtWidgets.QAbstractItemView.dragDropOverwriteMode()
Return type

bool

PySide2.QtWidgets.QAbstractItemView.dragEnabled()
Return type

bool

See also

setDragEnabled()

PySide2.QtWidgets.QAbstractItemView.dropIndicatorPosition()
Return type

DropIndicatorPosition

Returns the position of the drop indicator in relation to the closest item.

PySide2.QtWidgets.QAbstractItemView.edit(index)
Parameters

indexQModelIndex

Starts editing the item corresponding to the given index if it is editable.

Note that this function does not change the current index. Since the current index defines the next and previous items to edit, users may find that keyboard navigation does not work as expected. To provide consistent navigation behavior, call setCurrentIndex() before this function with the same model index.

See also

flags()

PySide2.QtWidgets.QAbstractItemView.edit(index, trigger, event)
Parameters
  • indexQModelIndex

  • triggerEditTrigger

  • eventQEvent

Return type

bool

Starts editing the item at index , creating an editor if necessary, and returns true if the view’s State is now EditingState ; otherwise returns false .

The action that caused the editing process is described by trigger , and the associated event is specified by event .

Editing can be forced by specifying the trigger to be AllEditTriggers .

See also

closeEditor()

PySide2.QtWidgets.QAbstractItemView.editTriggers()
Return type

EditTriggers

PySide2.QtWidgets.QAbstractItemView.editorDestroyed(editor)
Parameters

editorQObject

This function is called when the given editor has been destroyed.

See also

closeEditor()

PySide2.QtWidgets.QAbstractItemView.entered(index)
Parameters

indexQModelIndex

PySide2.QtWidgets.QAbstractItemView.executeDelayedItemsLayout()

Executes the scheduled layouts without waiting for the event processing to begin.

PySide2.QtWidgets.QAbstractItemView.hasAutoScroll()
Return type

bool

PySide2.QtWidgets.QAbstractItemView.horizontalOffset()
Return type

int

Returns the horizontal offset of the view.

In the base class this is a pure virtual function.

See also

verticalOffset()

PySide2.QtWidgets.QAbstractItemView.horizontalScrollMode()
Return type

ScrollMode

PySide2.QtWidgets.QAbstractItemView.horizontalScrollbarAction(action)
Parameters

actionint

PySide2.QtWidgets.QAbstractItemView.horizontalScrollbarValueChanged(value)
Parameters

valueint

PySide2.QtWidgets.QAbstractItemView.horizontalStepsPerItem()
Return type

int

Note

This function is deprecated.

Returns the horizontal scroll bar’s steps per item.

PySide2.QtWidgets.QAbstractItemView.iconSize()
Return type

QSize

See also

setIconSize()

PySide2.QtWidgets.QAbstractItemView.iconSizeChanged(size)
Parameters

sizeQSize

PySide2.QtWidgets.QAbstractItemView.indexAt(point)
Parameters

pointQPoint

Return type

QModelIndex

Returns the model index of the item at the viewport coordinates point .

In the base class this is a pure virtual function.

See also

visualRect()

PySide2.QtWidgets.QAbstractItemView.indexWidget(index)
Parameters

indexQModelIndex

Return type

QWidget

Returns the widget for the item at the given index .

See also

setIndexWidget()

PySide2.QtWidgets.QAbstractItemView.isIndexHidden(index)
Parameters

indexQModelIndex

Return type

bool

Returns true if the item referred to by the given index is hidden in the view, otherwise returns false .

Hiding is a view specific feature. For example in TableView a column can be marked as hidden or a row in the TreeView.

In the base class this is a pure virtual function.

PySide2.QtWidgets.QAbstractItemView.isPersistentEditorOpen(index)
Parameters

indexQModelIndex

Return type

bool

Returns whether a persistent editor is open for the item at index index .

PySide2.QtWidgets.QAbstractItemView.itemDelegate()
Return type

QAbstractItemDelegate

Returns the item delegate used by this view and model. This is either one set with setItemDelegate() , or the default one.

PySide2.QtWidgets.QAbstractItemView.itemDelegate(index)
Parameters

indexQModelIndex

Return type

QAbstractItemDelegate

Returns the item delegate used by this view and model for the given index .

PySide2.QtWidgets.QAbstractItemView.itemDelegateForColumn(column)
Parameters

columnint

Return type

QAbstractItemDelegate

Returns the item delegate used by this view and model for the given column . You can call itemDelegate() to get a pointer to the current delegate for a given index.

PySide2.QtWidgets.QAbstractItemView.itemDelegateForRow(row)
Parameters

rowint

Return type

QAbstractItemDelegate

Returns the item delegate used by this view and model for the given row , or None if no delegate has been assigned. You can call itemDelegate() to get a pointer to the current delegate for a given index.

PySide2.QtWidgets.QAbstractItemView.keyboardSearch(search)
Parameters

search – unicode

Moves to and selects the item best matching the string search . If no item is found nothing happens.

In the default implementation, the search is reset if search is empty, or the time interval since the last search has exceeded keyboardInputInterval() .

PySide2.QtWidgets.QAbstractItemView.model()
Return type

QAbstractItemModel

Returns the model that this view is presenting.

See also

setModel()

PySide2.QtWidgets.QAbstractItemView.moveCursor(cursorAction, modifiers)
Parameters
  • cursorActionCursorAction

  • modifiersKeyboardModifiers

Return type

QModelIndex

Returns a QModelIndex object pointing to the next object in the view, based on the given cursorAction and keyboard modifiers specified by modifiers .

In the base class this is a pure virtual function.

PySide2.QtWidgets.QAbstractItemView.openPersistentEditor(index)
Parameters

indexQModelIndex

Opens a persistent editor on the item at the given index . If no editor exists, the delegate will create a new editor.

PySide2.QtWidgets.QAbstractItemView.pressed(index)
Parameters

indexQModelIndex

PySide2.QtWidgets.QAbstractItemView.reset()

Reset the internal state of the view.

Warning

This function will reset open editors, scroll bar positions, selections, etc. Existing changes will not be committed. If you would like to save your changes when resetting the view, you can reimplement this function, commit your changes, and then call the superclass’ implementation.

PySide2.QtWidgets.QAbstractItemView.resetHorizontalScrollMode()
PySide2.QtWidgets.QAbstractItemView.resetVerticalScrollMode()
PySide2.QtWidgets.QAbstractItemView.rootIndex()
Return type

QModelIndex

Returns the model index of the model’s root item. The root item is the parent item to the view’s toplevel items. The root can be invalid.

See also

setRootIndex()

PySide2.QtWidgets.QAbstractItemView.rowsAboutToBeRemoved(parent, start, end)
Parameters
  • parentQModelIndex

  • startint

  • endint

This slot is called when rows are about to be removed. The deleted rows are those under the given parent from start to end inclusive.

See also

rowsInserted()

PySide2.QtWidgets.QAbstractItemView.rowsInserted(parent, start, end)
Parameters
  • parentQModelIndex

  • startint

  • endint

This slot is called when rows are inserted. The new rows are those under the given parent from start to end inclusive. The base class implementation calls fetchMore() on the model to check for more data.

PySide2.QtWidgets.QAbstractItemView.scheduleDelayedItemsLayout()

Schedules a layout of the items in the view to be executed when the event processing starts.

Even if is called multiple times before events are processed, the view will only do the layout once.

PySide2.QtWidgets.QAbstractItemView.scrollDirtyRegion(dx, dy)
Parameters
  • dxint

  • dyint

Prepares the view for scrolling by (dx ,``dy`` ) pixels by moving the dirty regions in the opposite direction. You only need to call this function if you are implementing a scrolling viewport in your view subclass.

If you implement scrollContentsBy() in a subclass of QAbstractItemView , call this function before you call scroll() on the viewport. Alternatively, just call update() .

PySide2.QtWidgets.QAbstractItemView.scrollTo(index[, hint=EnsureVisible])
Parameters

Scrolls the view if necessary to ensure that the item at index is visible. The view will try to position the item according to the given hint .

In the base class this is a pure virtual function.

PySide2.QtWidgets.QAbstractItemView.scrollToBottom()

Scrolls the view to the bottom.

PySide2.QtWidgets.QAbstractItemView.scrollToTop()

Scrolls the view to the top.

PySide2.QtWidgets.QAbstractItemView.selectAll()

Selects all items in the view. This function will use the selection behavior set on the view when selecting.

PySide2.QtWidgets.QAbstractItemView.selectedIndexes()
Return type

QModelIndexList

This convenience function returns a list of all selected and non-hidden item indexes in the view. The list contains no duplicates, and is not sorted.

See also

selectedIndexes()

PySide2.QtWidgets.QAbstractItemView.selectionBehavior()
Return type

SelectionBehavior

PySide2.QtWidgets.QAbstractItemView.selectionChanged(selected, deselected)
Parameters
  • selectedQItemSelection

  • deselectedQItemSelection

This slot is called when the selection is changed. The previous selection (which may be empty), is specified by deselected , and the new selection by selected .

See also

setSelection()

PySide2.QtWidgets.QAbstractItemView.selectionCommand(index[, event=None])
Parameters
  • indexQModelIndex

  • eventQEvent

Return type

SelectionFlags

Returns the SelectionFlags to be used when updating a selection with to include the index specified. The event is a user input event, such as a mouse or keyboard event.

Reimplement this function to define your own selection behavior.

See also

setSelection()

PySide2.QtWidgets.QAbstractItemView.selectionMode()
Return type

SelectionMode

PySide2.QtWidgets.QAbstractItemView.selectionModel()
Return type

QItemSelectionModel

Returns the current selection model.

PySide2.QtWidgets.QAbstractItemView.setAlternatingRowColors(enable)
Parameters

enablebool

PySide2.QtWidgets.QAbstractItemView.setAutoScroll(enable)
Parameters

enablebool

See also

hasAutoScroll()

PySide2.QtWidgets.QAbstractItemView.setAutoScrollMargin(margin)
Parameters

marginint

PySide2.QtWidgets.QAbstractItemView.setCurrentIndex(index)
Parameters

indexQModelIndex

Sets the current item to be the item at index .

Unless the current selection mode is NoSelection , the item is also selected. Note that this function also updates the starting position for any new selections the user performs.

To set an item as the current item without selecting it, call

selectionModel()->setCurrentIndex(index, QItemSelectionModel::NoUpdate);

PySide2.QtWidgets.QAbstractItemView.setDefaultDropAction(dropAction)
Parameters

dropActionDropAction

PySide2.QtWidgets.QAbstractItemView.setDirtyRegion(region)
Parameters

regionQRegion

Marks the given region as dirty and schedules it to be updated. You only need to call this function if you are implementing your own view subclass.

PySide2.QtWidgets.QAbstractItemView.setDragDropMode(behavior)
Parameters

behaviorDragDropMode

See also

dragDropMode()

PySide2.QtWidgets.QAbstractItemView.setDragDropOverwriteMode(overwrite)
Parameters

overwritebool

PySide2.QtWidgets.QAbstractItemView.setDragEnabled(enable)
Parameters

enablebool

See also

dragEnabled()

PySide2.QtWidgets.QAbstractItemView.setDropIndicatorShown(enable)
Parameters

enablebool

PySide2.QtWidgets.QAbstractItemView.setEditTriggers(triggers)
Parameters

triggersEditTriggers

See also

editTriggers()

PySide2.QtWidgets.QAbstractItemView.setHorizontalScrollMode(mode)
Parameters

modeScrollMode

PySide2.QtWidgets.QAbstractItemView.setHorizontalStepsPerItem(steps)
Parameters

stepsint

Note

This function is deprecated.

Sets the horizontal scroll bar’s steps per item to steps .

This is the number of steps used by the horizontal scroll bar to represent the width of an item.

Note that if the view has a horizontal header, the item steps will be ignored and the header section size will be used instead.

PySide2.QtWidgets.QAbstractItemView.setIconSize(size)
Parameters

sizeQSize

See also

iconSize()

PySide2.QtWidgets.QAbstractItemView.setIndexWidget(index, widget)
Parameters
  • indexQModelIndex

  • widgetQWidget

Sets the given widget on the item at the given index , passing the ownership of the widget to the viewport.

If index is invalid (e.g., if you pass the root index), this function will do nothing.

The given widget ‘s autoFillBackground property must be set to true, otherwise the widget’s background will be transparent, showing both the model data and the item at the given index .

If index widget A is replaced with index widget B, index widget A will be deleted. For example, in the code snippet below, the QLineEdit object will be deleted.

setIndexWidget(index, QLineEdit())
...
setIndexWidget(index, QTextEdit())

This function should only be used to display static content within the visible area corresponding to an item of data. If you want to display custom dynamic content or implement a custom editor widget, subclass QStyledItemDelegate instead.

PySide2.QtWidgets.QAbstractItemView.setItemDelegate(delegate)
Parameters

delegateQAbstractItemDelegate

Sets the item delegate for this view and its model to delegate . This is useful if you want complete control over the editing and display of items.

Any existing delegate will be removed, but not deleted. QAbstractItemView does not take ownership of delegate .

Warning

You should not share the same instance of a delegate between views. Doing so can cause incorrect or unintuitive editing behavior since each view connected to a given delegate may receive the closeEditor() signal, and attempt to access, modify or close an editor that has already been closed.

See also

itemDelegate()

PySide2.QtWidgets.QAbstractItemView.setItemDelegateForColumn(column, delegate)
Parameters

Sets the given item delegate used by this view and model for the given column . All items on column will be drawn and managed by delegate instead of using the default delegate (i.e., itemDelegate() ).

Any existing column delegate for column will be removed, but not deleted. QAbstractItemView does not take ownership of delegate .

Note

If a delegate has been assigned to both a row and a column, the row delegate will take precedence and manage the intersecting cell index.

Warning

You should not share the same instance of a delegate between views. Doing so can cause incorrect or unintuitive editing behavior since each view connected to a given delegate may receive the closeEditor() signal, and attempt to access, modify or close an editor that has already been closed.

PySide2.QtWidgets.QAbstractItemView.setItemDelegateForRow(row, delegate)
Parameters

Sets the given item delegate used by this view and model for the given row . All items on row will be drawn and managed by delegate instead of using the default delegate (i.e., itemDelegate() ).

Any existing row delegate for row will be removed, but not deleted. QAbstractItemView does not take ownership of delegate .

Note

If a delegate has been assigned to both a row and a column, the row delegate (i.e., this delegate) will take precedence and manage the intersecting cell index.

Warning

You should not share the same instance of a delegate between views. Doing so can cause incorrect or unintuitive editing behavior since each view connected to a given delegate may receive the closeEditor() signal, and attempt to access, modify or close an editor that has already been closed.

PySide2.QtWidgets.QAbstractItemView.setModel(model)
Parameters

modelQAbstractItemModel

Sets the model for the view to present.

This function will create and set a new selection model, replacing any model that was previously set with setSelectionModel() . However, the old selection model will not be deleted as it may be shared between several views. We recommend that you delete the old selection model if it is no longer required. This is done with the following code:

m = view->selectionModel()
view->setModel(model())
del m

If both the old model and the old selection model do not have parents, or if their parents are long-lived objects, it may be preferable to call their deleteLater() functions to explicitly delete them.

The view does not take ownership of the model unless it is the model’s parent object because the model may be shared between many different views.

PySide2.QtWidgets.QAbstractItemView.setRootIndex(index)
Parameters

indexQModelIndex

Sets the root item to the item at the given index .

See also

rootIndex()

PySide2.QtWidgets.QAbstractItemView.setSelection(rect, command)
Parameters
  • rectQRect

  • commandSelectionFlags

Applies the selection flags to the items in or touched by the rectangle, rect .

When implementing your own itemview should call selectionModel() ->select(selection, flags) where selection is either an empty QModelIndex or a QItemSelection that contains all items that are contained in rect .

PySide2.QtWidgets.QAbstractItemView.setSelectionBehavior(behavior)
Parameters

behaviorSelectionBehavior

PySide2.QtWidgets.QAbstractItemView.setSelectionMode(mode)
Parameters

modeSelectionMode

See also

selectionMode()

PySide2.QtWidgets.QAbstractItemView.setSelectionModel(selectionModel)
Parameters

selectionModelQItemSelectionModel

Sets the current selection model to the given selectionModel .

Note that, if you call setModel() after this function, the given selectionModel will be replaced by one created by the view.

Note

It is up to the application to delete the old selection model if it is no longer needed; i.e., if it is not being used by other views. This will happen automatically when its parent object is deleted. However, if it does not have a parent, or if the parent is a long-lived object, it may be preferable to call its deleteLater() function to explicitly delete it.

PySide2.QtWidgets.QAbstractItemView.setState(state)
Parameters

stateState

Sets the item view’s state to the given state .

See also

state()

PySide2.QtWidgets.QAbstractItemView.setTabKeyNavigation(enable)
Parameters

enablebool

PySide2.QtWidgets.QAbstractItemView.setTextElideMode(mode)
Parameters

modeTextElideMode

See also

textElideMode()

PySide2.QtWidgets.QAbstractItemView.setVerticalScrollMode(mode)
Parameters

modeScrollMode

PySide2.QtWidgets.QAbstractItemView.setVerticalStepsPerItem(steps)
Parameters

stepsint

Note

This function is deprecated.

Sets the vertical scroll bar’s steps per item to steps .

This is the number of steps used by the vertical scroll bar to represent the height of an item.

Note that if the view has a vertical header, the item steps will be ignored and the header section size will be used instead.

PySide2.QtWidgets.QAbstractItemView.showDropIndicator()
Return type

bool

PySide2.QtWidgets.QAbstractItemView.sizeHintForColumn(column)
Parameters

columnint

Return type

int

Returns the width size hint for the specified column or -1 if there is no model.

This function is used in views with a horizontal header to find the size hint for a header section based on the contents of the given column .

See also

sizeHintForRow()

PySide2.QtWidgets.QAbstractItemView.sizeHintForIndex(index)
Parameters

indexQModelIndex

Return type

QSize

Returns the size hint for the item with the specified index or an invalid size for invalid indexes.

PySide2.QtWidgets.QAbstractItemView.sizeHintForRow(row)
Parameters

rowint

Return type

int

Returns the height size hint for the specified row or -1 if there is no model.

The returned height is calculated using the size hints of the given row ‘s items, i.e. the returned value is the maximum height among the items. Note that to control the height of a row, you must reimplement the sizeHint() function.

This function is used in views with a vertical header to find the size hint for a header section based on the contents of the given row .

PySide2.QtWidgets.QAbstractItemView.startAutoScroll()
PySide2.QtWidgets.QAbstractItemView.startDrag(supportedActions)
Parameters

supportedActionsDropActions

Starts a drag by calling drag->exec() using the given supportedActions .

PySide2.QtWidgets.QAbstractItemView.state()
Return type

State

Returns the item view’s state.

See also

setState()

PySide2.QtWidgets.QAbstractItemView.stopAutoScroll()
PySide2.QtWidgets.QAbstractItemView.tabKeyNavigation()
Return type

bool

PySide2.QtWidgets.QAbstractItemView.textElideMode()
Return type

TextElideMode

PySide2.QtWidgets.QAbstractItemView.update(index)
Parameters

indexQModelIndex

Updates the area occupied by the given index .

PySide2.QtWidgets.QAbstractItemView.updateEditorData()

Updates the data shown in the open editor widgets in the view.

PySide2.QtWidgets.QAbstractItemView.updateEditorGeometries()

Updates the geometry of the open editor widgets in the view.

PySide2.QtWidgets.QAbstractItemView.updateGeometries()

Updates the geometry of the child widgets of the view.

PySide2.QtWidgets.QAbstractItemView.verticalOffset()
Return type

int

Returns the vertical offset of the view.

In the base class this is a pure virtual function.

PySide2.QtWidgets.QAbstractItemView.verticalScrollMode()
Return type

ScrollMode

PySide2.QtWidgets.QAbstractItemView.verticalScrollbarAction(action)
Parameters

actionint

PySide2.QtWidgets.QAbstractItemView.verticalScrollbarValueChanged(value)
Parameters

valueint

PySide2.QtWidgets.QAbstractItemView.verticalStepsPerItem()
Return type

int

Note

This function is deprecated.

Returns the vertical scroll bar’s steps per item.

PySide2.QtWidgets.QAbstractItemView.viewOptions()
Return type

QStyleOptionViewItem

Returns a QStyleOptionViewItem structure populated with the view’s palette, font, state, alignments etc.

PySide2.QtWidgets.QAbstractItemView.viewportEntered()
PySide2.QtWidgets.QAbstractItemView.visualRect(index)
Parameters

indexQModelIndex

Return type

QRect

Returns the rectangle on the viewport occupied by the item at index .

If your item is displayed in several areas then should return the primary area that contains index and not the complete area that index might encompasses, touch or cause drawing.

In the base class this is a pure virtual function.

PySide2.QtWidgets.QAbstractItemView.visualRegionForSelection(selection)
Parameters

selectionQItemSelection

Return type

QRegion

Returns the region from the viewport of the items in the given selection .

In the base class this is a pure virtual function.