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

API reference - Class QStyledItemDelegate

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QStyledItemDelegate

Class hierarchy: QStyledItemDelegate » QAbstractItemDelegate » QObject

Public constructors

new QStyledItemDelegatenew(QObject ptr parent = nullptr)Constructor QStyledItemDelegate::QStyledItemDelegate(QObject *parent)

Public methods

[const]QStyledItemDelegate 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 QStyledItemDelegate::closeEditor(QWidget *editor, QAbstractItemDelegate::EndEditHint hint)
[signal]voidcommitData(QWidget ptr editor)Signal declaration for QStyledItemDelegate::commitData(QWidget *editor)
[const]QWidget ptrcreateEditor(QWidget ptr parent,
const QStyleOptionViewItem option,
const QModelIndex index)
Virtual method QWidget *QStyledItemDelegate::createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index)
[const]voiddestroyEditor(QWidget ptr editor,
const QModelIndex index)
Virtual method void QStyledItemDelegate::destroyEditor(QWidget *editor, const QModelIndex &index)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QStyledItemDelegate::destroyed(QObject *)
[const]stringdisplayText(variant value,
const QLocale locale)
Virtual method QString QStyledItemDelegate::displayText(const QVariant &value, const QLocale &locale)
voidemit_closeEditor(QWidget ptr editor,
const QAbstractItemDelegate_EndEditHint hint = QAbstractItemDelegate::NoHint)
Emitter for signal void QStyledItemDelegate::closeEditor(QWidget *editor, QAbstractItemDelegate::EndEditHint hint)
voidemit_commitData(QWidget ptr editor)Emitter for signal void QStyledItemDelegate::commitData(QWidget *editor)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QStyledItemDelegate::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QStyledItemDelegate::objectNameChanged(const QString &objectName)
voidemit_sizeHintChanged(const QModelIndex arg1)Emitter for signal void QStyledItemDelegate::sizeHintChanged(const QModelIndex &)
boolevent(QEvent ptr event)Virtual method bool QStyledItemDelegate::event(QEvent *event)
boolhelpEvent(QHelpEvent ptr event,
QAbstractItemView ptr view,
const QStyleOptionViewItem option,
const QModelIndex index)
Virtual method bool QStyledItemDelegate::helpEvent(QHelpEvent *event, QAbstractItemView *view, const QStyleOptionViewItem &option, const QModelIndex &index)
[const]QItemEditorFactory ptritemEditorFactoryMethod QItemEditorFactory *QStyledItemDelegate::itemEditorFactory()
voiditemEditorFactory=(QItemEditorFactory ptr factory)Method void QStyledItemDelegate::setItemEditorFactory(QItemEditorFactory *factory)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QStyledItemDelegate::objectNameChanged(const QString &objectName)
[const]voidpaint(QPainter ptr painter,
const QStyleOptionViewItem option,
const QModelIndex index)
Virtual method void QStyledItemDelegate::paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index)
[const]int[]paintingRolesVirtual method QVector<int> QStyledItemDelegate::paintingRoles()
[const]voidsetEditorData(QWidget ptr editor,
const QModelIndex index)
Virtual method void QStyledItemDelegate::setEditorData(QWidget *editor, const QModelIndex &index)
voidsetItemEditorFactory(QItemEditorFactory ptr factory)Method void QStyledItemDelegate::setItemEditorFactory(QItemEditorFactory *factory)
[const]voidsetModelData(QWidget ptr editor,
QAbstractItemModel ptr model,
const QModelIndex index)
Virtual method void QStyledItemDelegate::setModelData(QWidget *editor, QAbstractItemModel *model, const QModelIndex &index)
[const]QSizesizeHint(const QStyleOptionViewItem option,
const QModelIndex index)
Virtual method QSize QStyledItemDelegate::sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index)
[signal]voidsizeHintChanged(const QModelIndex arg1)Signal declaration for QStyledItemDelegate::sizeHintChanged(const QModelIndex &)
[const]voidupdateEditorGeometry(QWidget ptr editor,
const QStyleOptionViewItem option,
const QModelIndex index)
Virtual method void QStyledItemDelegate::updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QStyledItemDelegate::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QStyledItemDelegate::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QStyledItemDelegate::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QStyledItemDelegate::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QStyledItemDelegate::disconnectNotify(const QMetaMethod &signal)
booleditorEvent(QEvent ptr event,
QAbstractItemModel ptr model,
const QStyleOptionViewItem option,
const QModelIndex index)
Virtual method bool QStyledItemDelegate::editorEvent(QEvent *event, QAbstractItemModel *model, const QStyleOptionViewItem &option, const QModelIndex &index)
booleventFilter(QObject ptr object,
QEvent ptr event)
Virtual method bool QStyledItemDelegate::eventFilter(QObject *object, QEvent *event)
[const]voidinitStyleOption(QStyleOptionViewItem ptr option,
const QModelIndex index)
Virtual method void QStyledItemDelegate::initStyleOption(QStyleOptionViewItem *option, const QModelIndex &index)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QStyledItemDelegate::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QStyledItemDelegate::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QStyledItemDelegate::sender()
[const]intsenderSignalIndexMethod int QStyledItemDelegate::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QStyledItemDelegate::timerEvent(QTimerEvent *event)

Detailed description

_const_cast

Signature: [const] QStyledItemDelegate 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 QStyledItemDelegate::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 QStyledItemDelegate::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 QStyledItemDelegate::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 *QStyledItemDelegate::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 QStyledItemDelegate::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 QStyledItemDelegate::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 QStyledItemDelegate::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 QStyledItemDelegate::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

displayText

Signature: [const] string displayText (variant value, const QLocale locale)

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

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QStyledItemDelegate::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 QStyledItemDelegate::eventFilter(QObject *object, 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 QStyledItemDelegate::helpEvent(QHelpEvent *event, QAbstractItemView *view, const QStyleOptionViewItem &option, const QModelIndex &index)

This method can be reimplemented in a derived class.

initStyleOption

Signature: [const] void initStyleOption (QStyleOptionViewItem ptr option, const QModelIndex index)

Description: Virtual method void QStyledItemDelegate::initStyleOption(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 QStyledItemDelegate::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 *QStyledItemDelegate::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 QStyledItemDelegate::setItemEditorFactory(QItemEditorFactory *factory)

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

new

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

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

This method creates an object of class QStyledItemDelegate.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QStyledItemDelegate::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 *QStyledItemDelegate::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QStyledItemDelegate::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 QStyledItemDelegate::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 QStyledItemDelegate::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 QStyledItemDelegate::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 QStyledItemDelegate::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 QStyledItemDelegate::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 QStyledItemDelegate::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 QStyledItemDelegate::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 QStyledItemDelegate::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 QStyledItemDelegate::updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option, const QModelIndex &index)

This method can be reimplemented in a derived class.