KWidgetItemDelegate Class Reference

#include <KWidgetItemDelegate>

Inheritance diagram for KWidgetItemDelegate:

Public Member Functions
	KWidgetItemDelegate (QAbstractItemView *itemView, QObject *parent=nullptr)
	~KWidgetItemDelegate () override
QPersistentModelIndex	focusedIndex () const
QAbstractItemView *	itemView () const
void	resetModel ()
Public Member Functions inherited from QAbstractItemDelegate
	QAbstractItemDelegate (QObject *parent)
void	closeEditor (QWidget *editor, QAbstractItemDelegate::EndEditHint hint)
void	commitData (QWidget *editor)
virtual QWidget *	createEditor (QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const const
virtual void	destroyEditor (QWidget *editor, const QModelIndex &index) const const
virtual bool	editorEvent (QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index)
virtual bool	helpEvent (QHelpEvent *event, QAbstractItemView *view, const QStyleOptionViewItem &option, const QModelIndex &index)
virtual void	paint (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const const=0
virtual void	setEditorData (QWidget *editor, const QModelIndex &index) const const
virtual void	setModelData (QWidget *editor, QAbstractItemModel *model, const QModelIndex &index) const const
virtual QSize	sizeHint (const QStyleOptionViewItem &option, const QModelIndex &index) const const=0
void	sizeHintChanged (const QModelIndex &index)
virtual void	updateEditorGeometry (QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index) const const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
QList< QEvent::Type >	blockedEventTypes (QWidget *widget) const
virtual QList< QWidget * >	createItemWidgets (const QModelIndex &index) const =0
void	paintWidgets (QPainter *painter, const QStyleOptionViewItem &option, const QPersistentModelIndex &index) const
void	setBlockedEventTypes (QWidget *widget, QList< QEvent::Type > types) const
virtual void	updateItemWidgets (const QList< QWidget * > widgets, const QStyleOptionViewItem &option, const QPersistentModelIndex &index) const =0
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from QAbstractItemDelegate
enum	EndEditHint
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QAbstractItemDelegate
QString	elidedText (const QFontMetrics &fontMetrics, int width, Qt::TextElideMode mode, const QString &text)
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QAbstractItemDelegate
	EditNextItem
	EditPreviousItem
	NoHint
	RevertModelCache
	SubmitModelCache
Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

This class allows to create item delegates embedding simple widgets to interact with items. For instance you can add push buttons, line edits, etc. to your delegate and use them to modify the state of your model.

Since

4.1

Definition at line 39 of file kwidgetitemdelegate.h.

Constructor & Destructor Documentation

KWidgetItemDelegate()

KWidgetItemDelegate::KWidgetItemDelegate ( QAbstractItemView *  itemView, QObject *  parent = nullptr  )

explicit

Creates a new ItemDelegate to be used with a given itemview.

KWidgetItemDelegatePrivate class that helps to provide binary compatibility between releases.

Parameters

itemView	the item view the new delegate will monitor
parent	the parent of this delegate

Definition at line 158 of file kwidgetitemdelegate.cpp.

~KWidgetItemDelegate()

KWidgetItemDelegate::~KWidgetItemDelegate ( )

overridedefault

Destroys an ItemDelegate.

Member Function Documentation

blockedEventTypes()

QList< QEvent::Type > KWidgetItemDelegate::blockedEventTypes ( QWidget *  widget ) const

protected

Retrieves the list of blocked event types for the given widget.

Parameters

widget

the specified widget.

Returns

the list of blocked event types, can be empty if no events are blocked.

Definition at line 282 of file kwidgetitemdelegate.cpp.

createItemWidgets()

virtual QList<QWidget *> KWidgetItemDelegate::createItemWidgets ( const QModelIndex &  index ) const

protectedpure virtual

Creates the list of widgets needed for an item.

Note

No initialization of the widgets is supposed to happen here. The widgets will be initialized based on needs for a given item.

If you want to connect some widget signals to any slot, you should do it here.

Parameters

index

the index to create widgets for

Returns

the list of newly created widgets which will be used to interact with an item.

See also

updateItemWidgets()

focusedIndex()

QPersistentModelIndex KWidgetItemDelegate::focusedIndex

(

)

const

Retrieves the currently focused index.

An invalid index if none is focused.

Returns

the current focused index, or QPersistentModelIndex() if none is focused.

Definition at line 185 of file kwidgetitemdelegate.cpp.

itemView()

QAbstractItemView * KWidgetItemDelegate::itemView

(

)

const

Retrieves the item view this delegate is monitoring.

Returns

the item view this delegate is monitoring

Definition at line 180 of file kwidgetitemdelegate.cpp.

paintWidgets()

void KWidgetItemDelegate::paintWidgets ( QPainter *  painter, const QStyleOptionViewItem &  option, const QPersistentModelIndex &  index  ) const

protected

Paint the widgets of the item.

This method is meant to be used in the paint() method of your item delegate implementation.

Parameters

painter	the painter the widgets will be painted on.
option	the current set of style options for the view.
index	the model index of the item currently painted.

Deprecated:

Since 4.2 this method is not longer needed to be called. All widgets will kept updated without the need of calling paintWidgets() in your paint() event. For the widgets of a certain index to be updated your model has to emit dataChanged() on the indexes that want to be updated.

Definition at line 197 of file kwidgetitemdelegate.cpp.

resetModel()

void KWidgetItemDelegate::resetModel

(

)

trigger a modelReset

Definition at line 287 of file kwidgetitemdelegate.cpp.

setBlockedEventTypes()

void KWidgetItemDelegate::setBlockedEventTypes ( QWidget *  widget, QList< QEvent::Type >  types  ) const

protected

Sets the list of event types that a widget will block.

Blocked events are not passed to the view. This way you can prevent an item from being selected when a button is clicked for instance.

Parameters

widget	the widget which must block events
types	the list of event types the widget must block

Definition at line 277 of file kwidgetitemdelegate.cpp.

updateItemWidgets()

virtual void KWidgetItemDelegate::updateItemWidgets ( const QList< QWidget * >  widgets, const QStyleOptionViewItem &  option, const QPersistentModelIndex &  index  ) const

protectedpure virtual

Updates a list of widgets for its use inside of the delegate (painting or event handling).

Note

All the positioning and sizing should be done in item coordinates.

Warning

Do not make widget connections in here, since this method will be called very regularly.

Parameters

widgets	the widgets to update
option	the current set of style options for the view.
index	the model index of the item currently manipulated.

---

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

• kwidgetitemdelegate.h
• kwidgetitemdelegate.cpp