Qt 5.6 | Qt Widgets | C++ Classes | QItemDelegate

Qt 5.6.2 Reference Documentation

# QItemDelegate Class

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

Header: | #include <QItemDelegate>
qmake: | QT += widgets
Inherits: | QAbstractItemDelegate

- List of all members, including inherited members

## Properties

- clipping : bool

## Public Functions

| QItemDelegate(QObject *parent = Q_NULLPTR)
| ~QItemDelegate()
bool | hasClipping() const
QItemEditorFactory * | itemEditorFactory() const
void | setClipping(bool clip)
void | setItemEditorFactory(QItemEditorFactory *factory)

## Reimplemented Public Functions

virtual QWidget * | createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const
virtual void | paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const
virtual void | setEditorData(QWidget *editor, const QModelIndex &index) const
virtual void | setModelData(QWidget *editor, QAbstractItemModel *model, const QModelIndex &index) const
virtual QSize | sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const
virtual void | updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const

- 9 public functions inherited from QAbstractItemDelegate

## Protected Functions

void | drawBackground(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const
virtual void | drawCheck(QPainter *painter, const QStyleOptionViewItem &option, const QRect &rect, Qt::CheckState state) const
virtual void | drawDecoration(QPainter *painter, const QStyleOptionViewItem &option, const QRect &rect, const QPixmap &pixmap) const
virtual void | drawDisplay(QPainter *painter, const QStyleOptionViewItem &option, const QRect &rect, const QString &text) const
virtual void | drawFocus(QPainter *painter, const QStyleOptionViewItem &option, const QRect &rect) const
bool | eventFilter(QObject *editor, QEvent *event)

## Reimplemented Protected Functions

virtual bool | editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index)

### Additional Inherited Members

- 3 signals inherited from QAbstractItemDelegate

## Detailed Description

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

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 QItemEditorFactory::setDefaultFactory(). It is the data stored in the item model with the Qt::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 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.

Role | Accepted Types
--- | ---
Qt::BackgroundRole | QBrush
Qt::BackgroundColorRole | QColor (obsolete; use Qt::BackgroundRole instead)
Qt::CheckStateRole | Qt::CheckState
Qt::DecorationRole | QIcon, QPixmap and QColor
Qt::DisplayRole | QString and types with a string representation
Qt::EditRole | See QItemEditorFactory for details
Qt::FontRole | QFont
Qt::SizeHintRole | QSize
Qt::TextAlignmentRole | Qt::Alignment
Qt::ForegroundRole | QBrush
Qt::TextColorRole | QColor (obsolete; use Qt::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, and Icons Example.

## Property Documentation

### clipping : 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.

This property was introduced in Qt 4.2.

Access functions:

bool | hasClipping() const
void | setClipping(bool clip)

## Member Function Documentation

### QItemDelegate::QItemDelegate(QObject *parent = Q_NULLPTR)

Constructs an item delegate with the given parent.

### QItemDelegate::~QItemDelegate()

Destroys the item delegate.

### `[virtual]` QWidget *QItemDelegate::createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const

Reimplemented from QAbstractItemDelegate::createEditor().

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.

See also QAbstractItemDelegate::createEditor().

### `[protected]` void QItemDelegate::drawBackground(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const

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

This function was introduced in Qt 4.2.

### `[virtual protected]` void QItemDelegate::drawCheck(QPainter *painter, const QStyleOptionViewItem &option, const QRect &rect, Qt::CheckState state) const

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

### `[virtual protected]` void QItemDelegate::drawDecoration(QPainter *painter, const QStyleOptionViewItem &option, const QRect &rect, const QPixmap &pixmap) const

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

### `[virtual protected]` void QItemDelegate::drawDisplay(QPainter *painter, const QStyleOptionViewItem &option, const QRect &rect, const QString &text) const

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

### `[virtual protected]` void QItemDelegate::drawFocus(QPainter *painter, const QStyleOptionViewItem &option, const QRect &rect) const

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

### `[virtual protected]` bool QItemDelegate::editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index)

Reimplemented from QAbstractItemDelegate::editorEvent().

### `[protected]` bool QItemDelegate::eventFilter(QObject *editor, QEvent *event)

Returns `true` if the given editor is a valid QWidget and the given event is handled; otherwise returns `false`. The following key press events are handled by default:

- Tab
- Backtab
- Enter
- Return
- Esc

In the case of Tab, Backtab, Enter and Return key press events, the editor's data is comitted to the model and the editor is closed. If the event is a Tab key press the view will open an editor on the next item in the view. Likewise, if the event is a Backtab key press the view will open an editor on the previous item in the view.

If the event is a Esc key press event, the editor is closed without committing its data.

See also commitData() and closeEditor().

### QItemEditorFactory *QItemDelegate::itemEditorFactory() const

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

See also setItemEditorFactory().

### `[virtual]` void QItemDelegate::paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const

Reimplemented from QAbstractItemDelegate::paint().

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->fillRect(option.rect, option.palette.highlight());

          int size = qMin(option.rect.width(), option.rect.height());
          int brightness = index.model()->data(index, Qt::DisplayRole).toInt();
          double radius = (size / 2.0) - (brightness / 255.0 * size / 2.0);
          if (radius == 0.0)
              return;

          painter->save();
          painter->setRenderHint(QPainter::Antialiasing, true);
          painter->setPen(Qt::NoPen);
          if (option.state & QStyle::State_Selected)
              painter->setBrush(option.palette.highlightedText());
          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.

See also QStyle::State.

### `[virtual]` void QItemDelegate::setEditorData(QWidget *editor, const QModelIndex &index) const

Reimplemented from QAbstractItemDelegate::setEditorData().

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

The default implementation stores the data in the editor widget's user property.

See also QMetaProperty::isUser().

### void QItemDelegate::setItemEditorFactory(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().

### `[virtual]` void QItemDelegate::setModelData(QWidget *editor, QAbstractItemModel *model, const QModelIndex &index) const

Reimplemented from QAbstractItemDelegate::setModelData().

Gets data from the editor widget and stores it in the specified model at the item index.

The default implementation gets the value to be stored in the data model from the editor widget's user property.

See also QMetaProperty::isUser().

### `[virtual]` QSize QItemDelegate::sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const

Reimplemented from QAbstractItemDelegate::sizeHint().

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

When reimplementing this function, note that in case of text items, QItemDelegate adds a margin (i.e. 2 * QStyle::PM_FocusFrameHMargin) to the length of the text.

### `[virtual]` void QItemDelegate::updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const

Reimplemented from QAbstractItemDelegate::updateEditorGeometry().

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