|  | Home · Overviews · Examples

# QItemDelegate Class Reference
[com.trolltech.qt.gui module]

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

Inherits `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.

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 delagates. 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` 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.

See also Delegate Classes, `QAbstractItemDelegate`, Spin Box Delegate Example, Settings Editor Example, and Icons Example.