Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QItemDelegate Class Reference

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

#include <qitemdelegate.h>

Inheritance diagram for QItemDelegate:
Collaboration diagram for QItemDelegate:

Public Member Functions

 QItemDelegate (QObject *parent=nullptr)
 Constructs an item delegate with the given parent.
 ~QItemDelegate ()
 Destroys the item delegate.
bool hasClipping () const
void setClipping (bool clip)
void paint (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Renders the delegate using the given painter and style option for the item specified by index.
QSize sizeHint (const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Returns the size needed by the delegate to display the item specified by index, taking into account the style information provided by option.
QWidgetcreateEditor (QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Returns the widget used to edit the item specified by index for editing.
void setEditorData (QWidget *editor, const QModelIndex &index) const override
 Sets the data to be displayed and edited by the editor from the data model item specified by the model index.
void setModelData (QWidget *editor, QAbstractItemModel *model, const QModelIndex &index) const override
 Gets data from the editor widget and stores it in the specified model at the item index.
void updateEditorGeometry (QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const override
 Updates the editor for the item specified by index according to the style option given.
QItemEditorFactoryitemEditorFactory () const
 Returns the editor factory used by the item delegate.
void setItemEditorFactory (QItemEditorFactory *factory)
 Sets the editor factory to be used by the item delegate to be the factory specified.
Public Member Functions inherited from QAbstractItemDelegate
 QAbstractItemDelegate (QObject *parent=nullptr)
 Creates a new abstract item delegate with the given parent.
virtual ~QAbstractItemDelegate ()
 Destroys the abstract item delegate.
virtual void destroyEditor (QWidget *editor, const QModelIndex &index) const
 Called when the editor is no longer needed for editing the data item with the given index and should be destroyed.
bool handleEditorEvent (QObject *object, QEvent *event)
 Implements standard handling of events on behalf of the currently active editor.
virtual bool helpEvent (QHelpEvent *event, QAbstractItemView *view, const QStyleOptionViewItem &option, const QModelIndex &index)
 Whenever a help event occurs, this function is called with the event view option and the index that corresponds to the item where the event occurs.
virtual QList< int > paintingRoles () const
Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
QString objectName () const
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QStringbindableObjectName ()
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
bool isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThreadthread () const
 Returns the thread in which the object lives.
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void killTimer (int id)
 Kills the timer with timer identifier, id.
void killTimer (Qt::TimerId id)
template<typename T>
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectListchildren () const
 Returns a list of child objects.
void setParent (QObject *parent)
 Makes the object a child of parent.
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
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
 Dumps a tree of children to the debug output.
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
bool setProperty (const char *name, QVariant &&value)
QVariant property (const char *name) const
 Returns the value of the object's name property.
QList< QByteArraydynamicPropertyNames () const
QBindingStoragebindingStorage ()
const QBindingStoragebindingStorage () const
QObjectparent () const
 Returns a pointer to the parent object.
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

Protected Member Functions

virtual void 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 void 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 void 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 void 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.
void 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.
void doLayout (const QStyleOptionViewItem &option, QRect *checkRect, QRect *iconRect, QRect *textRect, bool hint) const
QRect rect (const QStyleOptionViewItem &option, const QModelIndex &index, int role) const
bool eventFilter (QObject *object, QEvent *event) override
 \reimp
bool editorEvent (QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index) override
 \reimp
QStyleOptionViewItem setOptions (const QModelIndex &index, const QStyleOptionViewItem &option) const
QPixmap decoration (const QStyleOptionViewItem &option, const QVariant &variant) const
QRect doCheck (const QStyleOptionViewItem &option, const QRect &bounding, const QVariant &variant) const
QRect textRectangle (QPainter *painter, const QRect &rect, const QFont &font, const QString &text) const
Protected Member Functions inherited from QAbstractItemDelegate
 QAbstractItemDelegate (QObjectPrivate &, QObject *parent=nullptr)
Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int senderSignalIndex () const
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
bool isSignalConnected (const QMetaMethod &signal) const
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
virtual void connectNotify (const QMetaMethod &signal)
virtual void disconnectNotify (const QMetaMethod &signal)
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Static Protected Member Functions

static QPixmap selectedPixmap (const QPixmap &pixmap, const QPalette &palette, bool enabled)

Properties

bool clipping
 if the delegate should clip the paint events
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

Public Types inherited from QAbstractItemDelegate
enum  EndEditHint {
  NoHint , EditNextItem , EditPreviousItem , SubmitModelCache ,
  RevertModelCache
}
 This enum describes the different hints that the delegate can give to the model and view components to make editing data in a model a comfortable experience for the user. More...
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Signals inherited from QAbstractItemDelegate
void commitData (QWidget *editor)
 This signal must be emitted when the editor widget has completed editing the data, and wants to write it back into the model.
void closeEditor (QWidget *editor, QAbstractItemDelegate::EndEditHint hint=NoHint)
 This signal is emitted when the user has finished editing an item using the specified editor.
void sizeHintChanged (const QModelIndex &)
 This signal must be emitted when the sizeHint() of index changed.
Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
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)
 \threadsafe
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::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a 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< QObjectDatad_ptr

Detailed Description

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

\inmodule QtWidgets

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 \l{Model/View Classes} and is part of Qt's \l{Model/View Programming}{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 \l{Qt::ItemDataRole}{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:

\list

  • 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. \endlist

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

Definition at line 21 of file qitemdelegate.h.

Constructor & Destructor Documentation

◆ QItemDelegate()

QItemDelegate::QItemDelegate ( QObject * parent = nullptr)
explicit

Constructs an item delegate with the given parent.

Definition at line 304 of file qitemdelegate.cpp.

◆ ~QItemDelegate()

QItemDelegate::~QItemDelegate ( )

Destroys the item delegate.

Definition at line 314 of file qitemdelegate.cpp.

Member Function Documentation

◆ createEditor()

QWidget * QItemDelegate::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 QtPropertyEditorDelegate, and QtPropertyEditorDelegate.

Definition at line 474 of file qitemdelegate.cpp.

◆ decoration()

QPixmap QItemDelegate::decoration ( const QStyleOptionViewItem & option,
const QVariant & variant ) const
protected

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.

Definition at line 932 of file qitemdelegate.cpp.

◆ doCheck()

QRect QItemDelegate::doCheck ( const QStyleOptionViewItem & option,
const QRect & bounding,
const QVariant & value ) const
protected

Definition at line 1046 of file qitemdelegate.cpp.

◆ doLayout()

void QItemDelegate::doLayout ( const QStyleOptionViewItem & option,
QRect * checkRect,
QRect * pixmapRect,
QRect * textRect,
bool hint ) const
protected

Code duplicated in QCommonStylePrivate::viewItemLayout

Definition at line 794 of file qitemdelegate.cpp.

◆ drawBackground()

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

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

Definition at line 766 of file qitemdelegate.cpp.

◆ drawCheck()

void QItemDelegate::drawCheck ( QPainter * painter,
const QStyleOptionViewItem & option,
const QRect & rect,
Qt::CheckState state ) const
protectedvirtual

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

Definition at line 732 of file qitemdelegate.cpp.

◆ drawDecoration()

void QItemDelegate::drawDecoration ( QPainter * painter,
const QStyleOptionViewItem & option,
const QRect & rect,
const QPixmap & pixmap ) const
protectedvirtual

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

Definition at line 677 of file qitemdelegate.cpp.

◆ drawDisplay()

void QItemDelegate::drawDisplay ( QPainter * painter,
const QStyleOptionViewItem & option,
const QRect & rect,
const QString & text ) const
protectedvirtual

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

Definition at line 591 of file qitemdelegate.cpp.

◆ drawFocus()

void QItemDelegate::drawFocus ( QPainter * painter,
const QStyleOptionViewItem & option,
const QRect & rect ) const
protectedvirtual

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

Reimplemented in qdesigner_internal::ActionGroupDelegate, and qdesigner_internal::ActionGroupDelegate.

Definition at line 705 of file qitemdelegate.cpp.

◆ editorEvent()

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

\reimp

Reimplemented from QAbstractItemDelegate.

Definition at line 1094 of file qitemdelegate.cpp.

◆ eventFilter()

bool QItemDelegate::eventFilter ( QObject * object,
QEvent * event )
overrideprotectedvirtual

\reimp

See details in QAbstractItemDelegate::handleEditorEvent().

Reimplemented from QObject.

Reimplemented in QtPropertyEditorDelegate, and QtPropertyEditorDelegate.

Definition at line 1085 of file qitemdelegate.cpp.

◆ hasClipping()

bool QItemDelegate::hasClipping ( ) const

Definition at line 327 of file qitemdelegate.cpp.

◆ itemEditorFactory()

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

Definition at line 567 of file qitemdelegate.cpp.

◆ paint()

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

When reimplementing this function in a subclass, you should update the area held by the option's \l{QStyleOption::rect}{rect} variable, using the option's \l{QStyleOption::state}{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:

painter->fillRect(option.rect, option.palette.highlight());
@ State_Selected
Definition qstyle.h:83
GLuint GLenum option
QPainter painter(this)
[7]

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

Implements QAbstractItemDelegate.

Reimplemented in QtPropertyEditorDelegate, and QtPropertyEditorDelegate.

Definition at line 368 of file qitemdelegate.cpp.

◆ rect()

QRect QItemDelegate::rect ( const QStyleOptionViewItem & option,
const QModelIndex & index,
int role ) const
protected

Only used (and usable) for Qt::DecorationRole and Qt::CheckStateRole

Definition at line 1005 of file qitemdelegate.cpp.

◆ selectedPixmap()

QPixmap QItemDelegate::selectedPixmap ( const QPixmap & pixmap,
const QPalette & palette,
bool enabled )
staticprotected

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.

Definition at line 975 of file qitemdelegate.cpp.

◆ setClipping()

void QItemDelegate::setClipping ( bool clip)

Definition at line 333 of file qitemdelegate.cpp.

◆ setEditorData()

void QItemDelegate::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 QtPropertyEditorDelegate, and QtPropertyEditorDelegate.

Definition at line 500 of file qitemdelegate.cpp.

◆ setItemEditorFactory()

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

Definition at line 580 of file qitemdelegate.cpp.

◆ setModelData()

void QItemDelegate::setModelData ( QWidget * editor,
QAbstractItemModel * model,
const QModelIndex & index ) const
overridevirtual

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

See also
QMetaProperty::isUser()

Reimplemented from QAbstractItemDelegate.

Reimplemented in QtPropertyEditorDelegate, and QtPropertyEditorDelegate.

Definition at line 523 of file qitemdelegate.cpp.

◆ setOptions()

QStyleOptionViewItem QItemDelegate::setOptions ( const QModelIndex & index,
const QStyleOptionViewItem & option ) const
protected

Definition at line 1149 of file qitemdelegate.cpp.

◆ sizeHint()

QSize QItemDelegate::sizeHint ( const QStyleOptionViewItem & option,
const QModelIndex & index ) const
overridevirtual

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.

Implements QAbstractItemDelegate.

Reimplemented in QtPropertyEditorDelegate, and QtPropertyEditorDelegate.

Definition at line 450 of file qitemdelegate.cpp.

◆ textRectangle()

QRect QItemDelegate::textRectangle ( QPainter * painter,
const QRect & rect,
const QFont & font,
const QString & text ) const
protected

Definition at line 1064 of file qitemdelegate.cpp.

◆ updateEditorGeometry()

void QItemDelegate::updateEditorGeometry ( QWidget * editor,
const QStyleOptionViewItem & option,
const QModelIndex & index ) const
overridevirtual

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

Reimplemented from QAbstractItemDelegate.

Reimplemented in QtPropertyEditorDelegate, and QtPropertyEditorDelegate.

Definition at line 543 of file qitemdelegate.cpp.

Property Documentation

◆ clipping

bool QItemDelegate::clipping
readwrite

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.

Definition at line 24 of file qitemdelegate.h.


The documentation for this class was generated from the following files: