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

#include <qstyleditemdelegate.h>

Inheritance diagram for QStyledItemDelegate:

Collaboration diagram for QStyledItemDelegate:

Public Member Functions
	QStyledItemDelegate (QObject *parent=nullptr)

	~QStyledItemDelegate ()

void	paint (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override

QSize	sizeHint (const QStyleOptionViewItem &option, const QModelIndex &index) const override

QWidget *	createEditor (QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const override

void	setEditorData (QWidget *editor, const QModelIndex &index) const override

void	setModelData (QWidget editor, QAbstractItemModel model, const QModelIndex &index) const override

void	updateEditorGeometry (QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const override

QItemEditorFactory *	itemEditorFactory () const

void	setItemEditorFactory (QItemEditorFactory *factory)

virtual QString	displayText (const QVariant &value, const QLocale &locale) const

Public Member Functions inherited from QAbstractItemDelegate
	QAbstractItemDelegate (QObject *parent=nullptr)

virtual	~QAbstractItemDelegate ()

virtual void	destroyEditor (QWidget *editor, const QModelIndex &index) const

virtual bool	helpEvent (QHelpEvent event, QAbstractItemView view, const QStyleOptionViewItem &option, const QModelIndex &index)

virtual QList< int >	paintingRoles () const

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	event (QEvent *event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Protected Member Functions
virtual void	initStyleOption (QStyleOptionViewItem *option, const QModelIndex &index) const

bool	eventFilter (QObject object, QEvent event) override

bool	editorEvent (QEvent event, QAbstractItemModel model, const QStyleOptionViewItem &option, const QModelIndex &index) override

Protected Member Functions inherited from QAbstractItemDelegate
	QAbstractItemDelegate (QObjectPrivate &, QObject *parent=nullptr)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Additional Inherited Members
Public Types inherited from QAbstractItemDelegate
enum	EndEditHint { NoHint , EditNextItem , EditPreviousItem , SubmitModelCache , RevertModelCache }

Public Slots inherited from QObject
void	deleteLater ()

Signals inherited from QAbstractItemDelegate
void	commitData (QWidget *editor)

void	closeEditor (QWidget *editor, QAbstractItemDelegate::EndEditHint hint=NoHint)

void	sizeHintChanged (const QModelIndex &)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object More...

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList

Detailed Description

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

\inmodule QtWidgets

Since: 4.4

When displaying data from models in Qt item views, e.g., a QTableView, the individual items are drawn by a delegate. Also, when an item is edited, it provides an editor widget, which is placed on top of the item view while editing takes place. QStyledItemDelegate is the default delegate for all Qt item views, and is installed upon them when they are created.

The QStyledItemDelegate class is one of the \l{Model/View Classes} and is part of Qt's \l{Model/View Programming}{model/view framework}. The delegate allows the display and editing of items to be developed independently from the model and view.

The data of items in models are assigned an \l{Qt::}{ItemDataRole}; each item can store a QVariant for each role. QStyledItemDelegate implements display and editing for the most common datatypes expected by users, including booleans, integers, and strings.

The data will be drawn differently depending on which role they have in the model. The following table describes the roles and the data types the delegate can handle for each of them. It is often sufficient to ensure that the model returns appropriate data for each of the roles to determine the appearance of items in views.

\table \header

Role
Accepted Types \omit \row
\l Qt::AccessibleDescriptionRole
QString \row
\l Qt::AccessibleTextRole
QString \endomit \row
\l Qt::BackgroundRole
QBrush (
Since
4.2) \row
\l Qt::CheckStateRole
Qt::CheckState \row
\l Qt::DecorationRole
QIcon, QPixmap, QImage and QColor \row
\l Qt::DisplayRole
QString and types with a string representation \row
\l Qt::EditRole
See QItemEditorFactory for details \row
\l Qt::FontRole
QFont \row
\l Qt::SizeHintRole
QSize \omit \row
\l Qt::StatusTipRole
\endomit \row
\l Qt::TextAlignmentRole
Qt::Alignment \row
\l Qt::ForegroundRole
QBrush (
Since
4.2) \omit \row
\l Qt::ToolTipRole \row
\l Qt::WhatsThisRole \endomit \endtable

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 \l{Qt::}{EditRole} that is edited. See the QItemEditorFactory class for a more high-level introduction to item editor factories. The \l{Color Editor Factory Example}{Color Editor Factory} example shows how to create custom editors with a factory.

Definition at line 56 of file qstyleditemdelegate.h.

Constructor & Destructor Documentation

◆ QStyledItemDelegate()

QStyledItemDelegate::QStyledItemDelegate ( QObject * parent = nullptr )

explicit

Constructs an item delegate with the given parent.

Definition at line 251 of file qstyleditemdelegate.cpp.

◆ ~QStyledItemDelegate()

QStyledItemDelegate::~QStyledItemDelegate ( )

Destroys the item delegate.

Definition at line 259 of file qstyleditemdelegate.cpp.

Member Function Documentation

◆ createEditor()

QWidget * QStyledItemDelegate::createEditor	(	QWidget *	parent,
		const QStyleOptionViewItem &	option,
		const QModelIndex &	index
	)		const

overridevirtual

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

Reimplemented from QAbstractItemDelegate.

Reimplemented in ItemDelegate, EditorItemDelegate, and DialogItemDelegate.

Definition at line 440 of file qstyleditemdelegate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ displayText()

QString QStyledItemDelegate::displayText	(	const QVariant &	value,
		const QLocale &	locale
	)		const

virtual

This function returns the string that the delegate will use to display the Qt::DisplayRole of the model in locale. value is the value of the Qt::DisplayRole provided by the model.

The default implementation uses the QLocale::toString to convert value into a QString.

This function is not called for empty model indices, i.e., indices for which the model returns an invalid QVariant.

See also: QAbstractItemModel::data()

Definition at line 276 of file qstyleditemdelegate.cpp.

Here is the caller graph for this function:

◆ editorEvent()

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

overrideprotectedvirtual

\reimp

Reimplemented from QAbstractItemDelegate.

Definition at line 603 of file qstyleditemdelegate.cpp.

Here is the call graph for this function:

◆ eventFilter()

bool QStyledItemDelegate::eventFilter	(	QObject *	editor,
		QEvent *	event
	)

overrideprotectedvirtual

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:

\list

\uicontrol Tab
\uicontrol Backtab
\uicontrol Enter
\uicontrol Return
\uicontrol Esc \endlist

If the editor's type is QTextEdit or QPlainTextEdit then \uicontrol Enter and \uicontrol Return keys are not handled.

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

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

See also: commitData(), closeEditor()

Reimplemented from QObject.

Definition at line 594 of file qstyleditemdelegate.cpp.

◆ initStyleOption()

void QStyledItemDelegate::initStyleOption	(	QStyleOptionViewItem *	option,
		const QModelIndex &	index
	)		const

protectedvirtual

Initialize option with the values using the index index. This method is useful for subclasses when they need a QStyleOptionViewItem, but don't want to fill in all the information themselves.

See also: QStyleOption::initFrom()

Reimplemented in QSideBarDelegate.

Definition at line 288 of file qstyleditemdelegate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ itemEditorFactory()

QItemEditorFactory * QStyledItemDelegate::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()

Definition at line 544 of file qstyleditemdelegate.cpp.

◆ paint()

void QStyledItemDelegate::paint	(	QPainter *	painter,
		const QStyleOptionViewItem &	option,
		const QModelIndex &	index
	)		const

overridevirtual

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

This function paints the item using the view's QStyle.

When reimplementing paint in a subclass. Use the initStyleOption() to set up the option in the same way as the QStyledItemDelegate.

Whenever possible, use the option while painting. Especially its \l{QStyleOption::}{rect} variable to decide where to draw and its \l{QStyleOption::}{state} to determine if it is enabled or selected.

After painting, you should ensure that the painter is returned to 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: QItemDelegate::paint(), QStyle::drawControl(), QStyle::CE_ItemViewItem

Implements QAbstractItemDelegate.

Reimplemented in Delegate12308, QComboBoxDelegate, HoverItemDelegate, and QCompleterItemDelegate.

Definition at line 396 of file qstyleditemdelegate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setEditorData()

void QStyledItemDelegate::setEditorData	(	QWidget *	editor,
		const QModelIndex &	index
	)		const

overridevirtual

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 \l {Qt's Property System} {user property}.

See also: QMetaProperty::isUser()

Reimplemented from QAbstractItemDelegate.

Reimplemented in StateChangeDelegate.

Definition at line 460 of file qstyleditemdelegate.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setItemEditorFactory()

void QStyledItemDelegate::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.