API reference - Class QItemDelegate

_const_cast

Signature: [const] QItemDelegate ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QItemDelegate::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

clipping

Signature: [const] bool clipping

Description: Method bool QItemDelegate::hasClipping()

Python specific notes:
The object exposes a readable attribute 'clipping'. This is the getter.

clipping=

Signature: void clipping= (bool clip)

Description: Method void QItemDelegate::setClipping(bool clip)

Python specific notes:
The object exposes a writable attribute 'clipping'. This is the setter.

closeEditor

Signature: [signal] void closeEditor (QWidget ptr editor, const QAbstractItemDelegate_EndEditHint hint)

Description: Signal declaration for QItemDelegate::closeEditor(QWidget *editor, QAbstractItemDelegate::EndEditHint hint)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'closeEditor'. This is the getter.
The object exposes a writable attribute 'closeEditor'. This is the setter.

commitData

Signature: [signal] void commitData (QWidget ptr editor)

Description: Signal declaration for QItemDelegate::commitData(QWidget *editor)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'commitData'. This is the getter.
The object exposes a writable attribute 'commitData'. This is the setter.

createEditor

Signature: [const] QWidget ptr createEditor (QWidget ptr parent, const QStyleOptionViewItem option, const QModelIndex index)

Description: Virtual method QWidget *QItemDelegate::createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QItemDelegate::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

decoration

Signature: [const] QPixmap decoration (const QStyleOptionViewItem option, variant variant)

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

This method is protected and can only be called from inside a derived class.

destroyEditor

Signature: [const] void destroyEditor (QWidget ptr editor, const QModelIndex index)

Description: Virtual method void QItemDelegate::destroyEditor(QWidget *editor, const QModelIndex &index)

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QItemDelegate::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QItemDelegate::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

doCheck

Signature: [const] QRect doCheck (const QStyleOptionViewItem option, const QRect bounding, variant variant)

Description: Method QRect QItemDelegate::doCheck(const QStyleOptionViewItem &option, const QRect &bounding, const QVariant &variant)

This method is protected and can only be called from inside a derived class.

doLayout

Signature: [const] void doLayout (const QStyleOptionViewItem option, QRect ptr checkRect, QRect ptr iconRect, QRect ptr textRect, bool hint)

Description: Method void QItemDelegate::doLayout(const QStyleOptionViewItem &option, QRect *checkRect, QRect *iconRect, QRect *textRect, bool hint)

This method is protected and can only be called from inside a derived class.

drawBackground

Signature: [const] void drawBackground (QPainter ptr painter, const QStyleOptionViewItem option, const QModelIndex index)

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

This method is protected and can only be called from inside a derived class.

drawCheck

Signature: [const] void drawCheck (QPainter ptr painter, const QStyleOptionViewItem option, const QRect rect, const Qt_CheckState state)

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

This method can be reimplemented in a derived class.

drawDecoration

Signature: [const] void drawDecoration (QPainter ptr painter, const QStyleOptionViewItem option, const QRect rect, const QPixmap pixmap)

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

This method can be reimplemented in a derived class.

drawDisplay

Signature: [const] void drawDisplay (QPainter ptr painter, const QStyleOptionViewItem option, const QRect rect, string text)

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

This method can be reimplemented in a derived class.

drawFocus

Signature: [const] void drawFocus (QPainter ptr painter, const QStyleOptionViewItem option, const QRect rect)

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

This method can be reimplemented in a derived class.

editorEvent

Signature: bool editorEvent (QEvent ptr event, QAbstractItemModel ptr model, const QStyleOptionViewItem option, const QModelIndex index)

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

This method can be reimplemented in a derived class.

emit_closeEditor

Signature: void emit_closeEditor (QWidget ptr editor, const QAbstractItemDelegate_EndEditHint hint = QAbstractItemDelegate::NoHint)

Description: Emitter for signal void QItemDelegate::closeEditor(QWidget *editor, QAbstractItemDelegate::EndEditHint hint)

Call this method to emit this signal.

emit_commitData

Signature: void emit_commitData (QWidget ptr editor)

Description: Emitter for signal void QItemDelegate::commitData(QWidget *editor)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QItemDelegate::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QItemDelegate::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_sizeHintChanged

Signature: void emit_sizeHintChanged (const QModelIndex arg1)

Description: Emitter for signal void QItemDelegate::sizeHintChanged(const QModelIndex &)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QItemDelegate::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr object, QEvent ptr event)

Description: Virtual method bool QItemDelegate::eventFilter(QObject *object, QEvent *event)

This method can be reimplemented in a derived class.

hasClipping

Signature: [const] bool hasClipping

Description: Method bool QItemDelegate::hasClipping()

Python specific notes:
The object exposes a readable attribute 'clipping'. This is the getter.

helpEvent

Signature: bool helpEvent (QHelpEvent ptr event, QAbstractItemView ptr view, const QStyleOptionViewItem option, const QModelIndex index)

Description: Virtual method bool QItemDelegate::helpEvent(QHelpEvent *event, QAbstractItemView *view, const QStyleOptionViewItem &option, const QModelIndex &index)

This method can be reimplemented in a derived class.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QItemDelegate::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

itemEditorFactory

Signature: [const] QItemEditorFactory ptr itemEditorFactory

Description: Method QItemEditorFactory *QItemDelegate::itemEditorFactory()

Python specific notes:
The object exposes a readable attribute 'itemEditorFactory'. This is the getter.

itemEditorFactory=

Signature: void itemEditorFactory= (QItemEditorFactory ptr factory)

Description: Method void QItemDelegate::setItemEditorFactory(QItemEditorFactory *factory)

Python specific notes:
The object exposes a writable attribute 'itemEditorFactory'. This is the setter.

new

Signature: [static] new QItemDelegate new (QObject ptr parent = nullptr)

Description: Constructor QItemDelegate::QItemDelegate(QObject *parent)

This method creates an object of class QItemDelegate.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QItemDelegate::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

paint

Signature: [const] void paint (QPainter ptr painter, const QStyleOptionViewItem option, const QModelIndex index)

Description: Virtual method void QItemDelegate::paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index)

This method can be reimplemented in a derived class.

paintingRoles

Signature: [const] int[] paintingRoles

Description: Virtual method QVector<int> QItemDelegate::paintingRoles()

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QItemDelegate::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

rect

Signature: [const] QRect rect (const QStyleOptionViewItem option, const QModelIndex index, int role)

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

This method is protected and can only be called from inside a derived class.

selected

Signature: [const] QPixmap ptr selected (const QPixmap pixmap, const QPalette palette, bool enabled)

Description: Method QPixmap *QItemDelegate::selected(const QPixmap &pixmap, const QPalette &palette, bool enabled)

This method is protected and can only be called from inside a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QItemDelegate::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QItemDelegate::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setClipping

Signature: void setClipping (bool clip)

Description: Method void QItemDelegate::setClipping(bool clip)

Python specific notes:
The object exposes a writable attribute 'clipping'. This is the setter.

setEditorData

Signature: [const] void setEditorData (QWidget ptr editor, const QModelIndex index)

Description: Virtual method void QItemDelegate::setEditorData(QWidget *editor, const QModelIndex &index)

This method can be reimplemented in a derived class.

setItemEditorFactory

Signature: void setItemEditorFactory (QItemEditorFactory ptr factory)

Description: Method void QItemDelegate::setItemEditorFactory(QItemEditorFactory *factory)

Python specific notes:
The object exposes a writable attribute 'itemEditorFactory'. This is the setter.

setModelData

Signature: [const] void setModelData (QWidget ptr editor, QAbstractItemModel ptr model, const QModelIndex index)

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

This method can be reimplemented in a derived class.

setOptions

Signature: [const] QStyleOptionViewItem setOptions (const QModelIndex index, const QStyleOptionViewItem option)

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

This method is protected and can only be called from inside a derived class.

sizeHint

Signature: [const] QSize sizeHint (const QStyleOptionViewItem option, const QModelIndex index)

Description: Virtual method QSize QItemDelegate::sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index)

This method can be reimplemented in a derived class.

sizeHintChanged

Signature: [signal] void sizeHintChanged (const QModelIndex arg1)

Description: Signal declaration for QItemDelegate::sizeHintChanged(const QModelIndex &)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'sizeHintChanged'. This is the getter.
The object exposes a writable attribute 'sizeHintChanged'. This is the setter.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

textRectangle

Signature: [const] QRect textRectangle (QPainter ptr painter, const QRect rect, const QFont font, string text)

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

This method is protected and can only be called from inside a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QItemDelegate::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QItemDelegate::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QItemDelegate::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

updateEditorGeometry

Signature: [const] void updateEditorGeometry (QWidget ptr editor, const QStyleOptionViewItem option, const QModelIndex index)

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

This method can be reimplemented in a derived class.