Home · All Classes · Modules

QItemDelegate Class Reference
^{[QtGui module]}

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

Inherits QAbstractItemDelegate.

Inherited by QSqlRelationalDelegate.

Methods

• __init__ (self, QObject parent = None)
• QRect check (self, QStyleOptionViewItem option, QRect bounding, QVariant variant)
• QWidget createEditor (self, QWidget parent, QStyleOptionViewItem option, QModelIndex index)
• QPixmap decoration (self, QStyleOptionViewItem option, QVariant variant)
• doLayout (self, QStyleOptionViewItem option, QRect checkRect, QRect iconRect, QRect textRect, bool hint)
• drawCheck (self, QPainter painter, QStyleOptionViewItem option, QRect rect, Qt.CheckState state)
• drawDecoration (self, QPainter painter, QStyleOptionViewItem option, QRect rect, QPixmap pixmap)
• drawDisplay (self, QPainter painter, QStyleOptionViewItem option, QRect rect, QString text)
• drawFocus (self, QPainter painter, QStyleOptionViewItem option, QRect rect)
• bool editorEvent (self, QEvent event, QAbstractItemModel model, QStyleOptionViewItem option, QModelIndex index)
• bool eventFilter (self, QObject object, QEvent event)
• QItemEditorFactory itemEditorFactory (self)
• paint (self, QPainter painter, QStyleOptionViewItem option, QModelIndex index)
• QPixmap selected (self, QPixmap pixmap, QPalette palette, bool enabled)
• setEditorData (self, QWidget editor, QModelIndex index)
• setItemEditorFactory (self, QItemEditorFactory factory)
• setModelData (self, QWidget editor, QAbstractItemModel model, QModelIndex index)
• QSize sizeHint (self, QStyleOptionViewItem option, QModelIndex index)
• updateEditorGeometry (self, QWidget editor, QStyleOptionViewItem option, QModelIndex index)

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.

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 obtained from a model. 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.

Delegates can be used to manipulate item data in two complementary ways: by processing events in the normal manner, or by implementing a custom editor widget. The item delegate takes the approach of providing a widget for editing purposes that can be supplied to QAbstractItemView.setDelegate() or the equivalent function in subclasses of QAbstractItemView.

Only the standard editing functions for widget-based delegates are reimplemented here: editor() returns the widget used to change data from the model; setEditorData() provides the widget with data to manipulate; updateEditorGeometry() ensures that the editor is displayed correctly with respect to the item view; setModelData() returns the updated data to the model; releaseEditor() indicates that the user has completed editing the data, and that the editor widget can be destroyed.

The default delegate used by the standard views supplied with Qt associates each standard role (defined by Qt.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.

If the default delegate does not allow the level of customization that you need, it is possible to subclass QItemDelegate to implement the desired behavior.

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.

See also Model/View Programming and QAbstractItemDelegate.

Method Documentation

QItemDelegate.__init__ (self, QObject parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs an item delegate with the given parent.

QRect QItemDelegate.check (self, QStyleOptionViewItem option, QRect bounding, QVariant variant)

QWidget QItemDelegate.createEditor (self, QWidget parent, QStyleOptionViewItem option, QModelIndex index)

Returns the widget used to edit the item specified by index for editing. The parent widget and style option are used to control how the editor widget appears.

Reimplemented from QAbstractItemDelegate.

See also QAbstractItemDelegate.createEditor().

QPixmap QItemDelegate.decoration (self, QStyleOptionViewItem option, QVariant variant)

QItemDelegate.doLayout (self, QStyleOptionViewItem option, QRect checkRect, QRect iconRect, QRect textRect, bool hint)

QItemDelegate.drawCheck (self, QPainter painter, QStyleOptionViewItem option, QRect rect, Qt.CheckState state)

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

QItemDelegate.drawDecoration (self, QPainter painter, QStyleOptionViewItem option, QRect rect, QPixmap pixmap)

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

QItemDelegate.drawDisplay (self, QPainter painter, QStyleOptionViewItem option, QRect rect, QString text)

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

QItemDelegate.drawFocus (self, QPainter painter, QStyleOptionViewItem option, QRect rect)

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

bool QItemDelegate.editorEvent (self, QEvent event, QAbstractItemModel model, QStyleOptionViewItem option, QModelIndex index)

bool QItemDelegate.eventFilter (self, QObject object, QEvent event)

If the object is the current editor: if the event is an Esc key press the current edit is cancelled and ended, or if the event is an Enter or Return key press the current edit is accepted and ended. If editing is ended the event filter returns true to signify that it has handled the event; in all other cases it does nothing and returns false to signify that the event hasn't been handled.

Reimplemented from QObject.

See also closeEditor().

QItemEditorFactory QItemDelegate.itemEditorFactory (self)

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

See also setItemEditorFactory().

QItemDelegate.paint (self, QPainter painter, QStyleOptionViewItem option, QModelIndex index)

Renders the delegate using the given painter and style option for the item specified by index.

When reimplementing this function in a subclass, you should update the area held by the option's rect variable, using the option's state variable to determine the state of the item to be displayed, and adjust the way it is painted accordingly.

For example, a selected item may need to be displayed differently to unselected items, as shown in the following code:

        if (option.state & QStyle.State_Selected)
            painter->setBrush(option.palette.highlight());
        else
        ...

After painting, you should ensure that the painter is returned to its the state it was supplied in when this function was called. For example, it may be useful to call QPainter.save() before painting and QPainter.restore() afterwards.

Reimplemented from QAbstractItemDelegate.

See also QStyle.State.

QPixmap QItemDelegate.selected (self, QPixmap pixmap, QPalette palette, bool enabled)

QItemDelegate.setEditorData (self, QWidget editor, QModelIndex index)

Sets the data to be displayed and edited by the editor for the item specified by index.

Reimplemented from QAbstractItemDelegate.

QItemDelegate.setItemEditorFactory (self, QItemEditorFactory factory)

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

QItemDelegate.setModelData (self, QWidget editor, QAbstractItemModel model, QModelIndex index)

Sets the data for the specified model and item index from that supplied by the editor.

Reimplemented from QAbstractItemDelegate.

QSize QItemDelegate.sizeHint (self, QStyleOptionViewItem option, QModelIndex index)

Returns the size needed by the delegate to display the item specified by index, taking into account the style information provided by option.

Reimplemented from QAbstractItemDelegate.

QItemDelegate.updateEditorGeometry (self, QWidget editor, QStyleOptionViewItem option, QModelIndex index)

Updates the editor for the item specified by index according to the style option given.

Reimplemented from QAbstractItemDelegate.