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

API reference - Class QDataWidgetMapper

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QDataWidgetMapper

Class hierarchy: QDataWidgetMapper » QObject

Sub-classes: SubmitPolicy, QFlags_SubmitPolicy

Public constructors

new QDataWidgetMappernew(QObject ptr parent = nullptr)Constructor QDataWidgetMapper::QDataWidgetMapper(QObject *parent)

Public methods

[const]QDataWidgetMapper 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.
voidaddMapping(QWidget ptr widget,
int section)
Method void QDataWidgetMapper::addMapping(QWidget *widget, int section)
voidaddMapping(QWidget ptr widget,
int section,
bytes propertyName)
Method void QDataWidgetMapper::addMapping(QWidget *widget, int section, const QByteArray &propertyName)
voidclearMappingMethod void QDataWidgetMapper::clearMapping()
[const]intcurrentIndexMethod int QDataWidgetMapper::currentIndex()
voidcurrentIndex=(int index)Method void QDataWidgetMapper::setCurrentIndex(int index)
[signal]voidcurrentIndexChanged(int index)Signal declaration for QDataWidgetMapper::currentIndexChanged(int index)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QDataWidgetMapper::destroyed(QObject *)
voidemit_currentIndexChanged(int index)Emitter for signal void QDataWidgetMapper::currentIndexChanged(int index)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QDataWidgetMapper::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QDataWidgetMapper::objectNameChanged(const QString &objectName)
boolevent(QEvent ptr event)Virtual method bool QDataWidgetMapper::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QDataWidgetMapper::eventFilter(QObject *watched, QEvent *event)
[const]QAbstractItemDelegate ptritemDelegateMethod QAbstractItemDelegate *QDataWidgetMapper::itemDelegate()
voiditemDelegate=(QAbstractItemDelegate ptr delegate)Method void QDataWidgetMapper::setItemDelegate(QAbstractItemDelegate *delegate)
[const]bytesmappedPropertyName(QWidget ptr widget)Method QByteArray QDataWidgetMapper::mappedPropertyName(QWidget *widget)
[const]intmappedSection(QWidget ptr widget)Method int QDataWidgetMapper::mappedSection(QWidget *widget)
[const]QWidget ptrmappedWidgetAt(int section)Method QWidget *QDataWidgetMapper::mappedWidgetAt(int section)
[const]QAbstractItemModel ptrmodelMethod QAbstractItemModel *QDataWidgetMapper::model()
voidmodel=(QAbstractItemModel ptr model)Method void QDataWidgetMapper::setModel(QAbstractItemModel *model)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QDataWidgetMapper::objectNameChanged(const QString &objectName)
[const]Qt_OrientationorientationMethod Qt::Orientation QDataWidgetMapper::orientation()
voidorientation=(const Qt_Orientation aOrientation)Method void QDataWidgetMapper::setOrientation(Qt::Orientation aOrientation)
voidremoveMapping(QWidget ptr widget)Method void QDataWidgetMapper::removeMapping(QWidget *widget)
voidrevertMethod void QDataWidgetMapper::revert()
[const]QModelIndexrootIndexMethod QModelIndex QDataWidgetMapper::rootIndex()
voidrootIndex=(const QModelIndex index)Method void QDataWidgetMapper::setRootIndex(const QModelIndex &index)
voidsetCurrentIndex(int index)Virtual method void QDataWidgetMapper::setCurrentIndex(int index)
voidsetCurrentModelIndex(const QModelIndex index)Method void QDataWidgetMapper::setCurrentModelIndex(const QModelIndex &index)
voidsetItemDelegate(QAbstractItemDelegate ptr delegate)Method void QDataWidgetMapper::setItemDelegate(QAbstractItemDelegate *delegate)
voidsetModel(QAbstractItemModel ptr model)Method void QDataWidgetMapper::setModel(QAbstractItemModel *model)
voidsetOrientation(const Qt_Orientation aOrientation)Method void QDataWidgetMapper::setOrientation(Qt::Orientation aOrientation)
voidsetRootIndex(const QModelIndex index)Method void QDataWidgetMapper::setRootIndex(const QModelIndex &index)
voidsetSubmitPolicy(const QDataWidgetMapper_SubmitPolicy policy)Method void QDataWidgetMapper::setSubmitPolicy(QDataWidgetMapper::SubmitPolicy policy)
boolsubmitMethod bool QDataWidgetMapper::submit()
[const]QDataWidgetMapper_SubmitPolicysubmitPolicyMethod QDataWidgetMapper::SubmitPolicy QDataWidgetMapper::submitPolicy()
voidsubmitPolicy=(const QDataWidgetMapper_SubmitPolicy policy)Method void QDataWidgetMapper::setSubmitPolicy(QDataWidgetMapper::SubmitPolicy policy)
voidtoFirstMethod void QDataWidgetMapper::toFirst()
voidtoLastMethod void QDataWidgetMapper::toLast()
voidtoNextMethod void QDataWidgetMapper::toNext()
voidtoPreviousMethod void QDataWidgetMapper::toPrevious()

Public static methods and constants

[static,const]QDataWidgetMapper_SubmitPolicyAutoSubmitEnum constant QDataWidgetMapper::AutoSubmit
[static,const]QDataWidgetMapper_SubmitPolicyManualSubmitEnum constant QDataWidgetMapper::ManualSubmit
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QDataWidgetMapper::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QDataWidgetMapper::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Detailed description

AutoSubmit

Signature: [static,const] QDataWidgetMapper_SubmitPolicy AutoSubmit

Description: Enum constant QDataWidgetMapper::AutoSubmit

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

ManualSubmit

Signature: [static,const] QDataWidgetMapper_SubmitPolicy ManualSubmit

Description: Enum constant QDataWidgetMapper::ManualSubmit

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

_const_cast

Signature: [const] QDataWidgetMapper 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.

addMapping

(1) Signature: void addMapping (QWidget ptr widget, int section)

Description: Method void QDataWidgetMapper::addMapping(QWidget *widget, int section)

(2) Signature: void addMapping (QWidget ptr widget, int section, bytes propertyName)

Description: Method void QDataWidgetMapper::addMapping(QWidget *widget, int section, const QByteArray &propertyName)

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

clearMapping

Signature: void clearMapping

Description: Method void QDataWidgetMapper::clearMapping()

currentIndex

Signature: [const] int currentIndex

Description: Method int QDataWidgetMapper::currentIndex()

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

currentIndex=

Signature: void currentIndex= (int index)

Description: Method void QDataWidgetMapper::setCurrentIndex(int index)

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

currentIndexChanged

Signature: [signal] void currentIndexChanged (int index)

Description: Signal declaration for QDataWidgetMapper::currentIndexChanged(int index)

You can bind a procedure to this signal.

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QDataWidgetMapper::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 QDataWidgetMapper::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_currentIndexChanged

Signature: void emit_currentIndexChanged (int index)

Description: Emitter for signal void QDataWidgetMapper::currentIndexChanged(int index)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QDataWidgetMapper::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 QDataWidgetMapper::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

isSignalConnected

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

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

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

itemDelegate

Signature: [const] QAbstractItemDelegate ptr itemDelegate

Description: Method QAbstractItemDelegate *QDataWidgetMapper::itemDelegate()

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

itemDelegate=

Signature: void itemDelegate= (QAbstractItemDelegate ptr delegate)

Description: Method void QDataWidgetMapper::setItemDelegate(QAbstractItemDelegate *delegate)

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

mappedPropertyName

Signature: [const] bytes mappedPropertyName (QWidget ptr widget)

Description: Method QByteArray QDataWidgetMapper::mappedPropertyName(QWidget *widget)

mappedSection

Signature: [const] int mappedSection (QWidget ptr widget)

Description: Method int QDataWidgetMapper::mappedSection(QWidget *widget)

mappedWidgetAt

Signature: [const] QWidget ptr mappedWidgetAt (int section)

Description: Method QWidget *QDataWidgetMapper::mappedWidgetAt(int section)

model

Signature: [const] QAbstractItemModel ptr model

Description: Method QAbstractItemModel *QDataWidgetMapper::model()

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

model=

Signature: void model= (QAbstractItemModel ptr model)

Description: Method void QDataWidgetMapper::setModel(QAbstractItemModel *model)

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

new

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

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

This method creates an object of class QDataWidgetMapper.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QDataWidgetMapper::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.

orientation

Signature: [const] Qt_Orientation orientation

Description: Method Qt::Orientation QDataWidgetMapper::orientation()

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

orientation=

Signature: void orientation= (const Qt_Orientation aOrientation)

Description: Method void QDataWidgetMapper::setOrientation(Qt::Orientation aOrientation)

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

receivers

Signature: [const] int receivers (string signal)

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

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

removeMapping

Signature: void removeMapping (QWidget ptr widget)

Description: Method void QDataWidgetMapper::removeMapping(QWidget *widget)

revert

Signature: void revert

Description: Method void QDataWidgetMapper::revert()

rootIndex

Signature: [const] QModelIndex rootIndex

Description: Method QModelIndex QDataWidgetMapper::rootIndex()

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

rootIndex=

Signature: void rootIndex= (const QModelIndex index)

Description: Method void QDataWidgetMapper::setRootIndex(const QModelIndex &index)

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QDataWidgetMapper::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QDataWidgetMapper::senderSignalIndex()

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

setCurrentIndex

Signature: void setCurrentIndex (int index)

Description: Virtual method void QDataWidgetMapper::setCurrentIndex(int index)

This method can be reimplemented in a derived class.

setCurrentModelIndex

Signature: void setCurrentModelIndex (const QModelIndex index)

Description: Method void QDataWidgetMapper::setCurrentModelIndex(const QModelIndex &index)

setItemDelegate

Signature: void setItemDelegate (QAbstractItemDelegate ptr delegate)

Description: Method void QDataWidgetMapper::setItemDelegate(QAbstractItemDelegate *delegate)

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

setModel

Signature: void setModel (QAbstractItemModel ptr model)

Description: Method void QDataWidgetMapper::setModel(QAbstractItemModel *model)

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

setOrientation

Signature: void setOrientation (const Qt_Orientation aOrientation)

Description: Method void QDataWidgetMapper::setOrientation(Qt::Orientation aOrientation)

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

setRootIndex

Signature: void setRootIndex (const QModelIndex index)

Description: Method void QDataWidgetMapper::setRootIndex(const QModelIndex &index)

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

setSubmitPolicy

Signature: void setSubmitPolicy (const QDataWidgetMapper_SubmitPolicy policy)

Description: Method void QDataWidgetMapper::setSubmitPolicy(QDataWidgetMapper::SubmitPolicy policy)

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

submit

Signature: bool submit

Description: Method bool QDataWidgetMapper::submit()

submitPolicy

Signature: [const] QDataWidgetMapper_SubmitPolicy submitPolicy

Description: Method QDataWidgetMapper::SubmitPolicy QDataWidgetMapper::submitPolicy()

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

submitPolicy=

Signature: void submitPolicy= (const QDataWidgetMapper_SubmitPolicy policy)

Description: Method void QDataWidgetMapper::setSubmitPolicy(QDataWidgetMapper::SubmitPolicy policy)

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

This method can be reimplemented in a derived class.

toFirst

Signature: void toFirst

Description: Method void QDataWidgetMapper::toFirst()

toLast

Signature: void toLast

Description: Method void QDataWidgetMapper::toLast()

toNext

Signature: void toNext

Description: Method void QDataWidgetMapper::toNext()

toPrevious

Signature: void toPrevious

Description: Method void QDataWidgetMapper::toPrevious()

tr

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

Description: Static method QString QDataWidgetMapper::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 QDataWidgetMapper::trUtf8(const char *s, const char *c, int n)

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