KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QAbstractItemDelegate

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QAbstractItemDelegate

Class hierarchy: QAbstractItemDelegate » QObject

Sub-classes: EndEditHint, QFlags_EndEditHint

Public constructors

new QAbstractItemDelegatenew(QObject ptr parent = nullptr)Constructor QAbstractItemDelegate::QAbstractItemDelegate(QObject *parent)

Public methods

[const]QAbstractItemDelegate ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[signal]voidcloseEditor(QWidget ptr editor,
const QAbstractItemDelegate_EndEditHint hint)
Signal declaration for QAbstractItemDelegate::closeEditor(QWidget *editor, QAbstractItemDelegate::EndEditHint hint)
[signal]voidcommitData(QWidget ptr editor)Signal declaration for QAbstractItemDelegate::commitData(QWidget *editor)
[const]QWidget ptrcreateEditor(QWidget ptr parent,
const QStyleOptionViewItem option,
const QModelIndex index)
Virtual method QWidget *QAbstractItemDelegate::createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index)
[const]voiddestroyEditor(QWidget ptr editor,
const QModelIndex index)
Virtual method void QAbstractItemDelegate::destroyEditor(QWidget *editor, const QModelIndex &index)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QAbstractItemDelegate::destroyed(QObject *)
booleditorEvent(QEvent ptr event,
QAbstractItemModel ptr model,
const QStyleOptionViewItem option,
const QModelIndex index)
Virtual method bool QAbstractItemDelegate::editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index)
voidemit_closeEditor(QWidget ptr editor,
const QAbstractItemDelegate_EndEditHint hint = QAbstractItemDelegate::NoHint)
Emitter for signal void QAbstractItemDelegate::closeEditor(QWidget *editor, QAbstractItemDelegate::EndEditHint hint)
voidemit_commitData(QWidget ptr editor)Emitter for signal void QAbstractItemDelegate::commitData(QWidget *editor)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QAbstractItemDelegate::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QAbstractItemDelegate::objectNameChanged(const QString &objectName)
voidemit_sizeHintChanged(const QModelIndex arg1)Emitter for signal void QAbstractItemDelegate::sizeHintChanged(const QModelIndex &)
boolevent(QEvent ptr event)Virtual method bool QAbstractItemDelegate::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QAbstractItemDelegate::eventFilter(QObject *watched, QEvent *event)
boolhelpEvent(QHelpEvent ptr event,
QAbstractItemView ptr view,
const QStyleOptionViewItem option,
const QModelIndex index)
Virtual method bool QAbstractItemDelegate::helpEvent(QHelpEvent *event, QAbstractItemView *view, const QStyleOptionViewItem &option, const QModelIndex &index)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QAbstractItemDelegate::objectNameChanged(const QString &objectName)
[const]voidpaint(QPainter ptr painter,
const QStyleOptionViewItem option,
const QModelIndex index)
Virtual method void QAbstractItemDelegate::paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index)
[const]int[]paintingRolesVirtual method QVector<int> QAbstractItemDelegate::paintingRoles()
[const]voidsetEditorData(QWidget ptr editor,
const QModelIndex index)
Virtual method void QAbstractItemDelegate::setEditorData(QWidget *editor, const QModelIndex &index)
[const]voidsetModelData(QWidget ptr editor,
QAbstractItemModel ptr model,
const QModelIndex index)
Virtual method void QAbstractItemDelegate::setModelData(QWidget *editor, QAbstractItemModel *model, const QModelIndex &index)
[const]QSizesizeHint(const QStyleOptionViewItem option,
const QModelIndex index)
Virtual method QSize QAbstractItemDelegate::sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index)
[signal]voidsizeHintChanged(const QModelIndex arg1)Signal declaration for QAbstractItemDelegate::sizeHintChanged(const QModelIndex &)
[const]voidupdateEditorGeometry(QWidget ptr editor,
const QStyleOptionViewItem option,
const QModelIndex index)
Virtual method void QAbstractItemDelegate::updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index)

Public static methods and constants

[static,const]QAbstractItemDelegate_EndEditHintEditNextItemEnum constant QAbstractItemDelegate::EditNextItem
[static,const]QAbstractItemDelegate_EndEditHintEditPreviousItemEnum constant QAbstractItemDelegate::EditPreviousItem
[static,const]QAbstractItemDelegate_EndEditHintNoHintEnum constant QAbstractItemDelegate::NoHint
[static,const]QAbstractItemDelegate_EndEditHintRevertModelCacheEnum constant QAbstractItemDelegate::RevertModelCache
[static,const]QAbstractItemDelegate_EndEditHintSubmitModelCacheEnum constant QAbstractItemDelegate::SubmitModelCache
stringelidedText(const QFontMetrics fontMetrics,
int width,
const Qt_TextElideMode mode,
string text)
Static method QString QAbstractItemDelegate::elidedText(const QFontMetrics &fontMetrics, int width, Qt::TextElideMode mode, const QString &text)
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QAbstractItemDelegate::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QAbstractItemDelegate::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QAbstractItemDelegate::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QAbstractItemDelegate::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QAbstractItemDelegate::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QAbstractItemDelegate::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QAbstractItemDelegate::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QAbstractItemDelegate::sender()
[const]intsenderSignalIndexMethod int QAbstractItemDelegate::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QAbstractItemDelegate::timerEvent(QTimerEvent *event)

Detailed description

EditNextItem

Signature: [static,const] QAbstractItemDelegate_EndEditHint EditNextItem

Description: Enum constant QAbstractItemDelegate::EditNextItem

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

EditPreviousItem

Signature: [static,const] QAbstractItemDelegate_EndEditHint EditPreviousItem

Description: Enum constant QAbstractItemDelegate::EditPreviousItem

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

NoHint

Signature: [static,const] QAbstractItemDelegate_EndEditHint NoHint

Description: Enum constant QAbstractItemDelegate::NoHint

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

RevertModelCache

Signature: [static,const] QAbstractItemDelegate_EndEditHint RevertModelCache

Description: Enum constant QAbstractItemDelegate::RevertModelCache

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

SubmitModelCache

Signature: [static,const] QAbstractItemDelegate_EndEditHint SubmitModelCache

Description: Enum constant QAbstractItemDelegate::SubmitModelCache

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

_const_cast

Signature: [const] QAbstractItemDelegate 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 QAbstractItemDelegate::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

closeEditor

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

Description: Signal declaration for QAbstractItemDelegate::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 QAbstractItemDelegate::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 *QAbstractItemDelegate::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 QAbstractItemDelegate::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroyEditor

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

Description: Virtual method void QAbstractItemDelegate::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 QAbstractItemDelegate::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 QAbstractItemDelegate::disconnectNotify(const QMetaMethod &signal)

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 QAbstractItemDelegate::editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index)

This method can be reimplemented in a derived class.

elidedText

Signature: [static] string elidedText (const QFontMetrics fontMetrics, int width, const Qt_TextElideMode mode, string text)

Description: Static method QString QAbstractItemDelegate::elidedText(const QFontMetrics &fontMetrics, int width, Qt::TextElideMode mode, const QString &text)

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

emit_closeEditor

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

Description: Emitter for signal void QAbstractItemDelegate::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 QAbstractItemDelegate::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 QAbstractItemDelegate::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QAbstractItemDelegate::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 QAbstractItemDelegate::sizeHintChanged(const QModelIndex &)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

eventFilter

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

Description: Virtual method bool QAbstractItemDelegate::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

helpEvent

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

Description: Virtual method bool QAbstractItemDelegate::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 QAbstractItemDelegate::isSignalConnected(const QMetaMethod &signal)

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

new

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

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

This method creates an object of class QAbstractItemDelegate.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QAbstractItemDelegate::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 QAbstractItemDelegate::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> QAbstractItemDelegate::paintingRoles()

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

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

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QAbstractItemDelegate::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QAbstractItemDelegate::senderSignalIndex()

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

setEditorData

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

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

This method can be reimplemented in a derived class.

setModelData

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

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

This method can be reimplemented in a derived class.

sizeHint

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

Description: Virtual method QSize QAbstractItemDelegate::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 QAbstractItemDelegate::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.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QAbstractItemDelegate::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 QAbstractItemDelegate::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 QAbstractItemDelegate::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 QAbstractItemDelegate::updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index)

This method can be reimplemented in a derived class.