class QAbstractItemView

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

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

Synopsis

Properties

• alternatingRowColorsᅟ - Whether to draw the background using alternating colors

• autoScrollᅟ - Whether autoscrolling in drag move events is enabled

• autoScrollMarginᅟ - The size of the area when auto scrolling is triggered

• defaultDropActionᅟ - The drop action that will be used by default in QAbstractItemView::drag()

• dragDropModeᅟ - The drag and drop event the view will act upon

• dragDropOverwriteModeᅟ - The view’s drag and drop behavior

• dragEnabledᅟ - Whether the view supports dragging of its own items

• editTriggersᅟ - Which actions will initiate item editing

• horizontalScrollModeᅟ - How the view scrolls its contents in the horizontal direction

• iconSizeᅟ - The size of items’ icons

• selectionBehaviorᅟ - Which selection behavior the view uses

• selectionModeᅟ - Which selection mode the view operates in

• showDropIndicatorᅟ - Whether the drop indicator is shown when dragging items and dropping

• tabKeyNavigationᅟ - Whether item navigation with tab and backtab is enabled

• textElideModeᅟ - The position of the “…” in elided text

• verticalScrollModeᅟ - How the view scrolls its contents in the vertical direction

Methods

• def __init__()

• def alternatingRowColors()

• def autoScrollMargin()

• def closePersistentEditor()

• def currentIndex()

• def defaultDropAction()

• def dirtyRegionOffset()

• def doAutoScroll()

• def dragDropMode()

• def dragDropOverwriteMode()

• def dragEnabled()

• def dropIndicatorPosition()

• def editTriggers()

• def executeDelayedItemsLayout()

• def hasAutoScroll()

• def horizontalScrollMode()

• def iconSize()

• def indexWidget()

• def isPersistentEditorOpen()

• def itemDelegate()

• def itemDelegateForColumn()

• def itemDelegateForRow()

• def model()

• def openPersistentEditor()

• def resetHorizontalScrollMode()

• def resetVerticalScrollMode()

• def rootIndex()

• def scheduleDelayedItemsLayout()

• def scrollDirtyRegion()

• def selectionBehavior()

• def selectionMode()

• def selectionModel()

• def setAlternatingRowColors()

• def setAutoScroll()

• def setAutoScrollMargin()

• def setDefaultDropAction()

• def setDirtyRegion()

• def setDragDropMode()

• def setDragDropOverwriteMode()

• def setDragEnabled()

• def setDropIndicatorShown()

• def setEditTriggers()

• def setHorizontalScrollMode()

• def setIconSize()

• def setIndexWidget()

• def setItemDelegate()

• def setItemDelegateForColumn()

• def setItemDelegateForRow()

• def setSelectionBehavior()

• def setSelectionMode()

• def setState()

• def setTabKeyNavigation()

• def setTextElideMode()

• def setVerticalScrollMode()

• def showDropIndicator()

• def sizeHintForIndex()

• def startAutoScroll()

• def state()

• def stopAutoScroll()

• def tabKeyNavigation()

• def textElideMode()

• def verticalScrollMode()

Virtual methods

• def closeEditor()

• def commitData()

• def currentChanged()

• def dataChanged()

• def doItemsLayout()

• def edit()

• def editorDestroyed()

• def horizontalOffset()

• def horizontalScrollbarAction()

• def horizontalScrollbarValueChanged()

• def indexAt()

• def initViewItemOption()

• def isIndexHidden()

• def itemDelegateForIndex()

• def keyboardSearch()

• def moveCursor()

• def reset()

• def rowsAboutToBeRemoved()

• def rowsInserted()

• def scrollTo()

• def selectAll()

• def selectedIndexes()

• def selectionChanged()

• def selectionCommand()

• def setModel()

• def setRootIndex()

• def setSelection()

• def setSelectionModel()

• def sizeHintForColumn()

• def sizeHintForRow()

• def startDrag()

• def updateEditorData()

• def updateEditorGeometries()

• def updateGeometries()

• def verticalOffset()

• def verticalScrollbarAction()

• def verticalScrollbarValueChanged()

• def visualRect()

• def visualRegionForSelection()

Slots

• def clearSelection()

• def edit()

• def scrollToBottom()

• def scrollToTop()

• def setCurrentIndex()

• def update()

Signals

• def activated()

• def clicked()

• def doubleClicked()

• def entered()

• def iconSizeChanged()

• def pressed()

• def viewportEntered()

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

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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.
Ctrl+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.

See also

View Classes Model/View Programming QAbstractItemModel

class 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 by pressing the Ctrl key when clicking 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 SingleSelection and ExtendedSelection.

class SelectionBehavior

Constant	Description
QAbstractItemView.SelectItems	Selecting single items.
QAbstractItemView.SelectRows	Selecting only rows.
QAbstractItemView.SelectColumns	Selecting only columns.

class 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.

class EditTrigger

(inherits enum.Flag) 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.

class ScrollMode

Describes how the scrollbar should behave. When setting the scroll mode to ScrollPerPixel 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.

class 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.

See also

setDragDropMode() Using drag and drop with item views

class 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()

class 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.

class 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.

Note

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

property alternatingRowColorsᅟ: bool

This property holds whether to draw the background using alternating colors.

If this property is true, the item background will be drawn using QPalette::Base and QPalette::AlternateBase; otherwise the background will be drawn using the QPalette::Base color.

By default, this property is false.

Access functions:

• alternatingRowColors()

• setAlternatingRowColors()

property autoScrollᅟ: bool

This property holds whether autoscrolling in drag move events is enabled.

If this property is set to true (the default), the QAbstractItemView automatically scrolls the contents of the view if the user drags within 16 pixels of the viewport edge. If the current item changes, then the view will scroll automatically to ensure that the current item is fully visible.

This property only works if the viewport accepts drops. Autoscroll is switched off by setting this property to false.

Access functions:

• hasAutoScroll()

• setAutoScroll()

property autoScrollMarginᅟ: int

This property holds the size of the area when auto scrolling is triggered.

This property controls the size of the area at the edge of the viewport that triggers autoscrolling. The default value is 16 pixels.

Access functions:

• autoScrollMargin()

• setAutoScrollMargin()

property defaultDropActionᅟ: Qt.DropAction

This property holds the drop action that will be used by default in QAbstractItemView::drag()..

If the property is not set, the drop action is CopyAction when the supported actions support CopyAction.

See also

showDropIndicator dragDropOverwriteMode

Access functions:

• defaultDropAction()

• setDefaultDropAction()

property dragDropModeᅟ: QAbstractItemView.DragDropMode

This property holds the drag and drop event the view will act upon.

See also

showDropIndicator dragDropOverwriteMode

Access functions:

• dragDropMode()

• setDragDropMode()

property dragDropOverwriteModeᅟ: bool

This property holds the view’s drag and drop behavior.

If its value is true, the selected data will overwrite the existing item data when dropped, while moving the data will clear the item. If its value is false, the selected data will be inserted as a new item when the data is dropped. When the data is moved, the item is removed as well.

The default value is false, as in the QListView and QTreeView subclasses. In the QTableView subclass, on the other hand, the property has been set to true.

Note: This is not intended to prevent overwriting of items. The model’s implementation of flags() should do that by not returning Qt::ItemIsDropEnabled.

See also

dragDropMode

Access functions:

• dragDropOverwriteMode()

• setDragDropOverwriteMode()

property dragEnabledᅟ: bool

This property holds whether the view supports dragging of its own items.

See also

showDropIndicator DragDropMode dragDropOverwriteMode acceptDrops

Access functions:

• dragEnabled()

• setDragEnabled()

property editTriggersᅟ: Combination of QAbstractItemView.EditTrigger

This property holds which actions will initiate item editing.

This property is a selection of flags defined by EditTrigger , combined using the OR operator. The view will only initiate the editing of an item if the action performed is set in this property.

Access functions:

• editTriggers()

• setEditTriggers()

property horizontalScrollModeᅟ: QAbstractItemView.ScrollMode

This property holds how the view scrolls its contents in the horizontal direction.

This property controls how the view scroll its contents horizontally. Scrolling can be done either per pixel or per item. Its default value comes from the style via the SH_ItemView_ScrollMode style hint.

Access functions:

• horizontalScrollMode()

• setHorizontalScrollMode()

• resetHorizontalScrollMode()

property iconSizeᅟ: QSize

This property holds the size of items’ icons.

Setting this property when the view is visible will cause the items to be laid out again.

Access functions:

• iconSize()

• setIconSize()

• Signal iconSizeChanged()

property selectionBehaviorᅟ: QAbstractItemView.SelectionBehavior

This property holds which selection behavior the view uses.

This property holds whether selections are done in terms of single items, rows or columns.

See also

SelectionMode SelectionBehavior

Access functions:

• selectionBehavior()

• setSelectionBehavior()

property selectionModeᅟ: QAbstractItemView.SelectionMode

This property holds which selection mode the view operates in.

This property controls whether the user can select one or many items and, in many-item selections, whether the selection must be a continuous range of items.

See also

SelectionMode SelectionBehavior

Access functions:

• selectionMode()

• setSelectionMode()

property showDropIndicatorᅟ: bool

This property holds whether the drop indicator is shown when dragging items and dropping..

See also

dragEnabled DragDropMode dragDropOverwriteMode acceptDrops

Access functions:

• showDropIndicator()

• setDropIndicatorShown()

property tabKeyNavigationᅟ: bool

This property holds whether item navigation with tab and backtab is enabled..

Access functions:

• tabKeyNavigation()

• setTabKeyNavigation()

property textElideModeᅟ: Qt.TextElideMode

This property holds the position of the “…” in elided text..

The default value for all item views is Qt::ElideRight.

Access functions:

• textElideMode()

• setTextElideMode()

property verticalScrollModeᅟ: QAbstractItemView.ScrollMode

This property holds how the view scrolls its contents in the vertical direction.

This property controls how the view scroll its contents vertically. Scrolling can be done either per pixel or per item. Its default value comes from the style via the SH_ItemView_ScrollMode style hint.

Access functions:

• verticalScrollMode()

• setVerticalScrollMode()

• resetVerticalScrollMode()

__init__([parent=None])

Parameters:

parent – QWidget

Constructs an abstract item view with the given parent.

activated(index)

Parameters:

index – QModelIndex

This signal is emitted when the item specified by index is activated by the user. How to activate items depends on the platform; e.g., by single- or double-clicking the item, or by pressing the Return or Enter key when the item is current.

See also

clicked() doubleClicked() entered() pressed()

alternatingRowColors()

Return type:

bool

See also

setAlternatingRowColors()

Getter of property alternatingRowColorsᅟ .

autoScrollMargin()

Return type:

int

See also

setAutoScrollMargin()

Getter of property autoScrollMarginᅟ .

clearSelection()

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

See also

setSelection() selectAll()

clicked(index)

Parameters:

index – QModelIndex

This signal is emitted when a mouse button is left-clicked. The item the mouse was clicked on is specified by index. The signal is only emitted when the index is valid.

See also

activated() doubleClicked() entered() pressed()

closeEditor(editor, hint)

Parameters:

• editor – QWidget

• hint – EndEditHint

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()

closePersistentEditor(index)

Parameters:

index – QModelIndex

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

See also

openPersistentEditor() isPersistentEditorOpen()

commitData(editor)

Parameters:

editor – QWidget

Commit the data in the editor to the model.

See also

closeEditor()

currentChanged(current, previous)

Parameters:

• current – QModelIndex

• previous – QModelIndex

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.

currentIndex()

Return type:

QModelIndex

Returns the model index of the current item.

See also

setCurrentIndex()

dataChanged(topLeft, bottomRight[, roles=list()])

Parameters:

• topLeft – QModelIndex

• bottomRight – QModelIndex

• roles – .list of int

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.

Note

: Qt::ToolTipRole is not honored by dataChanged() in the views provided by Qt.

defaultDropAction()

Return type:

DropAction

See also

setDefaultDropAction()

Getter of property defaultDropActionᅟ .

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.

See also

scrollDirtyRegion() setDirtyRegion()

doAutoScroll()

doItemsLayout()

doubleClicked(index)

Parameters:

index – QModelIndex

This signal is emitted when a mouse button is double-clicked. The item the mouse was double-clicked on is specified by index. The signal is only emitted when the index is valid.

See also

clicked() activated()

dragDropMode()

Return type:

DragDropMode

See also

setDragDropMode()

Getter of property dragDropModeᅟ .

dragDropOverwriteMode()

Return type:

bool

See also

setDragDropOverwriteMode()

Getter of property dragDropOverwriteModeᅟ .

dragEnabled()

Return type:

bool

See also

setDragEnabled()

Getter of property dragEnabledᅟ .

dropIndicatorPosition()

Return type:

DropIndicatorPosition

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

edit(index)

Parameters:

index – QModelIndex

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()

edit(index, trigger, event)

Parameters:

• index – QModelIndex

• trigger – EditTrigger

• event – QEvent

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()

editTriggers()

Return type:

Combination of EditTrigger

See also

setEditTriggers()

Getter of property editTriggersᅟ .

editorDestroyed(editor)

Parameters:

editor – QObject

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

See also

closeEditor()

entered(index)

Parameters:

index – QModelIndex

This signal is emitted when the mouse cursor enters the item specified by index. Mouse tracking needs to be enabled for this feature to work.

See also

viewportEntered() activated() clicked() doubleClicked() pressed()

executeDelayedItemsLayout()

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

See also

scheduleDelayedItemsLayout()

hasAutoScroll()

Return type:

bool

Getter of property autoScrollᅟ .

abstract horizontalOffset()

Return type:

int

Returns the horizontal offset of the view.

In the base class this is a pure virtual function.

See also

verticalOffset()

horizontalScrollMode()

Return type:

ScrollMode

See also

setHorizontalScrollMode()

Getter of property horizontalScrollModeᅟ .

horizontalScrollbarAction(action)

Parameters:

action – int

horizontalScrollbarValueChanged(value)

Parameters:

value – int

iconSize()

Return type:

QSize

See also

setIconSize()

Getter of property iconSizeᅟ .

iconSizeChanged(size)

Parameters:

size – QSize

Notification signal of property iconSizeᅟ .

abstract indexAt(point)

Parameters:

point – QPoint

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()

indexWidget(index)

Parameters:

index – QModelIndex

Return type:

QWidget

Returns the widget for the item at the given index.

See also

setIndexWidget()

initViewItemOption(option)

Parameters:

option – QStyleOptionViewItem

Initialize the option structure with the view’s palette, font, state, alignments etc.

Note

Implementations of this methods should check the version of the structure received, populate all members the implementation is familiar with, and set the version member to the one supported by the implementation before returning.

abstract isIndexHidden(index)

Parameters:

index – QModelIndex

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.

isPersistentEditorOpen(index)

Parameters:

index – QModelIndex

Return type:

bool

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

See also

openPersistentEditor() closePersistentEditor()

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.

See also

setItemDelegate()

itemDelegate(index)

Parameters:

index – QModelIndex

Return type:

QAbstractItemDelegate

Note

This function is deprecated.

Use itemDelegateForIndex() instead. Returns the item delegate used by this view and model for the given index.

itemDelegateForColumn(column)

Parameters:

column – int

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.

See also

setItemDelegateForColumn() itemDelegateForRow() itemDelegate()

itemDelegateForIndex(index)

Parameters:

index – QModelIndex

Return type:

QAbstractItemDelegate

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

See also

setItemDelegate() setItemDelegateForRow() setItemDelegateForColumn()

itemDelegateForRow(row)

Parameters:

row – int

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.

See also

setItemDelegateForRow() itemDelegateForColumn() setItemDelegate()

keyboardSearch(search)

Parameters:

search – str

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() .

model()

Return type:

QAbstractItemModel

Returns the model that this view is presenting.

See also

setModel()

abstract moveCursor(cursorAction, modifiers)

Parameters:

• cursorAction – CursorAction

• modifiers – Combination of KeyboardModifier

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.

openPersistentEditor(index)

Parameters:

index – QModelIndex

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

See also

closePersistentEditor() isPersistentEditorOpen()

pressed(index)

Parameters:

index – QModelIndex

This signal is emitted when a mouse button is pressed. The item the mouse was pressed on is specified by index. The signal is only emitted when the index is valid.

Use the QGuiApplication::mouseButtons() function to get the state of the mouse buttons.

See also

activated() clicked() doubleClicked() entered()

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.

resetHorizontalScrollMode()

Reset function of property horizontalScrollModeᅟ .

resetVerticalScrollMode()

Reset function of property verticalScrollModeᅟ .

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()

rowsAboutToBeRemoved(parent, start, end)

Parameters:

• parent – QModelIndex

• start – int

• end – int

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()

rowsInserted(parent, start, end)

Parameters:

• parent – QModelIndex

• start – int

• end – int

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.

See also

rowsAboutToBeRemoved()

scheduleDelayedItemsLayout()

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

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

See also

executeDelayedItemsLayout()

scrollDirtyRegion(dx, dy)

Parameters:

• dx – int

• dy – int

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() .

See also

scrollContentsBy() dirtyRegionOffset() setDirtyRegion()

abstract scrollTo(index[, hint=QAbstractItemView.ScrollHint.EnsureVisible])

Parameters:

• index – QModelIndex

• hint – ScrollHint

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.

scrollToBottom()

Scrolls the view to the bottom.

See also

scrollTo() scrollToTop()

scrollToTop()

Scrolls the view to the top.

See also

scrollTo() scrollToBottom()

selectAll()

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

See also

setSelection() selectedIndexes() clearSelection()

selectedIndexes()

Return type:

.list of QModelIndex

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()

selectionBehavior()

Return type:

SelectionBehavior

See also

setSelectionBehavior()

Getter of property selectionBehaviorᅟ .

selectionChanged(selected, deselected)

Parameters:

• selected – QItemSelection

• deselected – QItemSelection

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()

selectionCommand(index[, event=None])

Parameters:

• index – QModelIndex

• event – QEvent

Return type:

Combination of SelectionFlag

Returns the SelectionFlags to be used when updating a selection model for the specified index. The result depends on the current selectionMode() , and on the user input event event, which can be None.

Reimplement this function to define your own selection behavior.

See also

setSelection()

selectionMode()

Return type:

SelectionMode

See also

setSelectionMode()

Getter of property selectionModeᅟ .

selectionModel()

Return type:

QItemSelectionModel

Returns the current selection model.

See also

setSelectionModel() selectedIndexes()

setAlternatingRowColors(enable)

Parameters:

enable – bool

See also

alternatingRowColors()

Setter of property alternatingRowColorsᅟ .

setAutoScroll(enable)

Parameters:

enable – bool

See also

hasAutoScroll()

Setter of property autoScrollᅟ .

setAutoScrollMargin(margin)

Parameters:

margin – int

See also

autoScrollMargin()

Setter of property autoScrollMarginᅟ .

setCurrentIndex(index)

Parameters:

index – QModelIndex

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);

See also

currentIndex() currentChanged() selectionMode

setDefaultDropAction(dropAction)

Parameters:

dropAction – DropAction

See also

defaultDropAction()

Setter of property defaultDropActionᅟ .

setDirtyRegion(region)

Parameters:

region – QRegion

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.

See also

scrollDirtyRegion() dirtyRegionOffset()

setDragDropMode(behavior)

Parameters:

behavior – DragDropMode

See also

dragDropMode()

Setter of property dragDropModeᅟ .

setDragDropOverwriteMode(overwrite)

Parameters:

overwrite – bool

See also

dragDropOverwriteMode()

Setter of property dragDropOverwriteModeᅟ .

setDragEnabled(enable)

Parameters:

enable – bool

See also

dragEnabled()

Setter of property dragEnabledᅟ .

setDropIndicatorShown(enable)

Parameters:

enable – bool

Setter of property showDropIndicatorᅟ .

setEditTriggers(triggers)

Parameters:

triggers – Combination of EditTrigger

See also

editTriggers()

Setter of property editTriggersᅟ .

setHorizontalScrollMode(mode)

Parameters:

mode – ScrollMode

See also

horizontalScrollMode()

Setter of property horizontalScrollModeᅟ .

setIconSize(size)

Parameters:

size – QSize

See also

iconSize()

Setter of property iconSizeᅟ .

setIndexWidget(index, widget)

Parameters:

• index – QModelIndex

• widget – QWidget

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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.

Note

The view takes ownership of the widget. This means 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.

See also

indexWidget() Delegate Classes

setItemDelegate(delegate)

Parameters:

delegate – QAbstractItemDelegate

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()

setItemDelegateForColumn(column, delegate)

Parameters:

• column – int

• delegate – QAbstractItemDelegate

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.

See also

itemDelegateForColumn() setItemDelegateForRow() itemDelegate()

setItemDelegateForRow(row, delegate)

Parameters:

• row – int

• delegate – QAbstractItemDelegate

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.

See also

itemDelegateForRow() setItemDelegateForColumn() itemDelegate()

setModel(model)

Parameters:

model – QAbstractItemModel

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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.

See also

model() selectionModel() setSelectionModel()

setRootIndex(index)

Parameters:

index – QModelIndex

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

See also

rootIndex()

abstract setSelection(rect, command)

Parameters:

• rect – QRect

• command – Combination of SelectionFlag

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

When implementing your own itemview setSelection 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.

See also

selectionCommand() selectedIndexes()

setSelectionBehavior(behavior)

Parameters:

behavior – SelectionBehavior

See also

selectionBehavior()

Setter of property selectionBehaviorᅟ .

setSelectionMode(mode)

Parameters:

mode – SelectionMode

See also

selectionMode()

Setter of property selectionModeᅟ .

setSelectionModel(selectionModel)

Parameters:

selectionModel – QItemSelectionModel

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.

See also

selectionModel() setModel() clearSelection()

setState(state)

Parameters:

state – State

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

See also

state()

setTabKeyNavigation(enable)

Parameters:

enable – bool

See also

tabKeyNavigation()

Setter of property tabKeyNavigationᅟ .

setTextElideMode(mode)

Parameters:

mode – TextElideMode

See also

textElideMode()

Setter of property textElideModeᅟ .

setVerticalScrollMode(mode)

Parameters:

mode – ScrollMode

See also

verticalScrollMode()

Setter of property verticalScrollModeᅟ .

showDropIndicator()

Return type:

bool

Getter of property showDropIndicatorᅟ .

sizeHintForColumn(column)

Parameters:

column – int

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()

sizeHintForIndex(index)

Parameters:

index – QModelIndex

Return type:

QSize

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

See also

sizeHintForRow() sizeHintForColumn()

sizeHintForRow(row)

Parameters:

row – int

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.

See also

sizeHintForColumn()

startAutoScroll()

startDrag(supportedActions)

Parameters:

supportedActions – Combination of DropAction

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

state()

Return type:

State

Returns the item view’s state.

See also

setState()

stopAutoScroll()

tabKeyNavigation()

Return type:

bool

See also

setTabKeyNavigation()

Getter of property tabKeyNavigationᅟ .

textElideMode()

Return type:

TextElideMode

See also

setTextElideMode()

Getter of property textElideModeᅟ .

update(index)

Parameters:

index – QModelIndex

Updates the area occupied by the given index.

updateEditorData()

updateEditorGeometries()

updateGeometries()

Updates the geometry of the child widgets of the view.

abstract verticalOffset()

Return type:

int

Returns the vertical offset of the view.

In the base class this is a pure virtual function.

See also

horizontalOffset()

verticalScrollMode()

Return type:

ScrollMode

See also

setVerticalScrollMode()

Getter of property verticalScrollModeᅟ .

verticalScrollbarAction(action)

Parameters:

action – int

verticalScrollbarValueChanged(value)

Parameters:

value – int

viewportEntered()

This signal is emitted when the mouse cursor enters the viewport. Mouse tracking needs to be enabled for this feature to work.

See also

entered()

abstract visualRect(index)

Parameters:

index – QModelIndex

Return type:

QRect

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

If your item is displayed in several areas then visualRect 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.

See also

indexAt() visualRegionForSelection()

abstract visualRegionForSelection(selection)

Parameters:

selection – QItemSelection

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.

See also

visualRect() selectedIndexes()