QItemDelegate

The QItemDelegate class provides display and editing facilities for data items from a model. More…

Inheritance diagram of PySide2.QtWidgets.QItemDelegate

Synopsis

Functions

Virtual functions

Static functions

Detailed Description

QItemDelegate can be used to provide custom display features and editor widgets for item views based on QAbstractItemView subclasses. Using a delegate for this purpose allows the display and editing mechanisms to be customized and developed independently from the model and view.

The QItemDelegate class is one of the Model/View Classes and is part of Qt’s model/view framework . Note that QStyledItemDelegate has taken over the job of drawing Qt’s item views. We recommend the use of QStyledItemDelegate when creating new delegates.

When displaying items from a custom model in a standard view, it is often sufficient to simply ensure that the model returns appropriate data for each of the roles that determine the appearance of items in views. The default delegate used by Qt’s standard views uses this role information to display items in most of the common forms expected by users. However, it is sometimes necessary to have even more control over the appearance of items than the default delegate can provide.

This class provides default implementations of the functions for painting item data in a view and editing data from item models. Default implementations of the paint() and sizeHint() virtual functions, defined in QAbstractItemDelegate , are provided to ensure that the delegate implements the correct basic behavior expected by views. You can reimplement these functions in subclasses to customize the appearance of items.

When editing data in an item view, QItemDelegate provides an editor widget, which is a widget that is placed on top of the view while editing takes place. Editors are created with a QItemEditorFactory ; a default static instance provided by QItemEditorFactory is installed on all item delegates. You can set a custom factory using setItemEditorFactory() or set a new default factory with setDefaultFactory() . It is the data stored in the item model with the EditRole that is edited.

Only the standard editing functions for widget-based delegates are reimplemented here:

  • createEditor() returns the widget used to change data from the model and can be reimplemented to customize editing behavior.

  • setEditorData() provides the widget with data to manipulate.

  • updateEditorGeometry() ensures that the editor is displayed correctly with respect to the item view.

  • setModelData() returns updated data to the model.

The closeEditor() signal indicates that the user has completed editing the data, and that the editor widget can be destroyed.

Standard Roles and Data Types

The default delegate used by the standard views supplied with Qt associates each standard role (defined by ItemDataRole ) with certain data types. Models that return data in these types can influence the appearance of the delegate as described in the following table.

Role

Accepted Types

BackgroundRole

QBrush (

BackgroundColorRole

QColor (obsolete; use BackgroundRole instead)

CheckStateRole

CheckState

DecorationRole

QIcon , QPixmap and QColor

DisplayRole

QString and types with a string representation

EditRole

See QItemEditorFactory for details

FontRole

QFont

SizeHintRole

QSize

TextAlignmentRole

Alignment

ForegroundRole

QBrush (

TextColorRole

QColor (obsolete; use ForegroundRole instead)

If the default delegate does not allow the level of customization that you need, either for display purposes or for editing data, it is possible to subclass QItemDelegate to implement the desired behavior.

Subclassing

When subclassing QItemDelegate to create a delegate that displays items using a custom renderer, it is important to ensure that the delegate can render items suitably for all the required states; e.g. selected, disabled, checked. The documentation for the paint() function contains some hints to show how this can be achieved.

You can provide custom editors by using a QItemEditorFactory . The Color Editor Factory Example shows how a custom editor can be made available to delegates with the default item editor factory. This way, there is no need to subclass QItemDelegate . An alternative is to reimplement createEditor() , setEditorData() , setModelData() , and updateEditorGeometry() . This process is described in the Spin Box Delegate Example .

QStyledItemDelegate vs. QItemDelegate

Since Qt 4.4, there are two delegate classes: QItemDelegate and QStyledItemDelegate . However, the default delegate is QStyledItemDelegate . These two classes are independent alternatives to painting and providing editors for items in views. The difference between them is that QStyledItemDelegate uses the current style to paint its items. We therefore recommend using QStyledItemDelegate as the base class when implementing custom delegates or when working with Qt style sheets. The code required for either class should be equal unless the custom delegate needs to use the style for drawing.

See also

Delegate Classes QStyledItemDelegate QAbstractItemDelegate Spin Box Delegate Example Settings Editor Example Icons Example

class PySide2.QtWidgets.QItemDelegate([parent=None])
param parent:

PySide2.QtCore.QObject

Constructs an item delegate with the given parent .

PySide2.QtWidgets.QItemDelegate.decoration(option, variant)
Parameters:
Return type:

PySide2.QtGui.QPixmap

Returns the pixmap used to decorate the root of the item view. The style option controls the appearance of the root; the variant refers to the data associated with an item.

PySide2.QtWidgets.QItemDelegate.doCheck(option, bounding, variant)
Parameters:
Return type:

PySide2.QtCore.QRect

PySide2.QtWidgets.QItemDelegate.drawBackground(painter, option, index)
Parameters:

Renders the item background for the given index , using the given painter and style option .

PySide2.QtWidgets.QItemDelegate.drawCheck(painter, option, rect, state)
Parameters:

Renders a check indicator within the rectangle specified by rect , using the given painter and style option , using the given state .

PySide2.QtWidgets.QItemDelegate.drawDecoration(painter, option, rect, pixmap)
Parameters:

Renders the decoration pixmap within the rectangle specified by rect using the given painter and style option .

PySide2.QtWidgets.QItemDelegate.drawDisplay(painter, option, rect, text)
Parameters:

Renders the item view text within the rectangle specified by rect using the given painter and style option .

PySide2.QtWidgets.QItemDelegate.drawFocus(painter, option, rect)
Parameters:

Renders the region within the rectangle specified by rect , indicating that it has the focus, using the given painter and style option .

PySide2.QtWidgets.QItemDelegate.hasClipping()
Return type:

bool

This property holds if the delegate should clip the paint events.

This property will set the paint clip to the size of the item. The default value is on. It is useful for cases such as when images are larger than the size of the item.

PySide2.QtWidgets.QItemDelegate.itemEditorFactory()
Return type:

PySide2.QtWidgets.QItemEditorFactory

Returns the editor factory used by the item delegate. If no editor factory is set, the function will return null.

See also

setItemEditorFactory()

PySide2.QtWidgets.QItemDelegate.rect(option, index, role)
Parameters:
Return type:

PySide2.QtCore.QRect

Only used (and usable) for DecorationRole and CheckStateRole

static PySide2.QtWidgets.QItemDelegate.selectedPixmap(pixmap, palette, enabled)
Parameters:
Return type:

PySide2.QtGui.QPixmap

Returns the selected version of the given pixmap using the given palette . The enabled argument decides whether the normal or disabled highlight color of the palette is used.

PySide2.QtWidgets.QItemDelegate.setClipping(clip)
Parameters:

clip – bool

This property holds if the delegate should clip the paint events.

This property will set the paint clip to the size of the item. The default value is on. It is useful for cases such as when images are larger than the size of the item.

PySide2.QtWidgets.QItemDelegate.setItemEditorFactory(factory)
Parameters:

factory – PySide2.QtWidgets.QItemEditorFactory

Sets the editor factory to be used by the item delegate to be the factory specified. If no editor factory is set, the item delegate will use the default editor factory.

See also

itemEditorFactory()

PySide2.QtWidgets.QItemDelegate.setOptions(index, option)
Parameters:
Return type:

PySide2.QtWidgets.QStyleOptionViewItem

PySide2.QtWidgets.QItemDelegate.textRectangle(painter, rect, font, text)
Parameters:
Return type:

PySide2.QtCore.QRect