KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QWidgetAction

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QWidgetAction

Class hierarchy: QWidgetAction » QAction » QObject

Public constructors

new QWidgetActionnew(QObject ptr parent)Constructor QWidgetAction::QWidgetAction(QObject *parent)

Public methods

[const]QWidgetAction 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]voidchangedSignal declaration for QWidgetAction::changed()
[const]QWidget ptrdefaultWidgetMethod QWidget *QWidgetAction::defaultWidget()
voiddefaultWidget=(QWidget ptr w)Method void QWidgetAction::setDefaultWidget(QWidget *w)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QWidgetAction::destroyed(QObject *)
voidemit_changedEmitter for signal void QWidgetAction::changed()
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QWidgetAction::destroyed(QObject *)
voidemit_hoveredEmitter for signal void QWidgetAction::hovered()
voidemit_objectNameChanged(string objectName)Emitter for signal void QWidgetAction::objectNameChanged(const QString &objectName)
voidemit_toggled(bool arg1)Emitter for signal void QWidgetAction::toggled(bool)
voidemit_triggered(bool checked = false)Emitter for signal void QWidgetAction::triggered(bool checked)
[signal]voidhoveredSignal declaration for QWidgetAction::hovered()
[signal]voidobjectNameChanged(string objectName)Signal declaration for QWidgetAction::objectNameChanged(const QString &objectName)
voidreleaseWidget(QWidget ptr widget)Method void QWidgetAction::releaseWidget(QWidget *widget)
QWidget ptrrequestWidget(QWidget ptr parent)Method QWidget *QWidgetAction::requestWidget(QWidget *parent)
voidsetDefaultWidget(QWidget ptr w)Method void QWidgetAction::setDefaultWidget(QWidget *w)
[signal]voidtoggled(bool arg1)Signal declaration for QWidgetAction::toggled(bool)
[signal]voidtriggered(bool checked)Signal declaration for QWidgetAction::triggered(bool checked)

Public static methods and constants

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

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QWidgetAction::childEvent(QChildEvent *event)
QWidget ptrcreateWidget(QWidget ptr parent)Virtual method QWidget *QWidgetAction::createWidget(QWidget *parent)
[const]QWidget ptr[]createdWidgetsMethod QList<QWidget *> QWidgetAction::createdWidgets()
voidcustomEvent(QEvent ptr event)Virtual method void QWidgetAction::customEvent(QEvent *event)
voiddeleteWidget(QWidget ptr widget)Virtual method void QWidgetAction::deleteWidget(QWidget *widget)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QWidgetAction::disconnectNotify(const QMetaMethod &signal)
boolevent(QEvent ptr arg1)Virtual method bool QWidgetAction::event(QEvent *)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QWidgetAction::eventFilter(QObject *, QEvent *)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QWidgetAction::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QWidgetAction::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QWidgetAction::sender()
[const]intsenderSignalIndexMethod int QWidgetAction::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QWidgetAction::timerEvent(QTimerEvent *event)

Detailed description

_const_cast

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

changed

Signature: [signal] void changed

Description: Signal declaration for QWidgetAction::changed()

You can bind a procedure to this signal.

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

createWidget

Signature: QWidget ptr createWidget (QWidget ptr parent)

Description: Virtual method QWidget *QWidgetAction::createWidget(QWidget *parent)

This method can be reimplemented in a derived class.

createdWidgets

Signature: [const] QWidget ptr[] createdWidgets

Description: Method QList<QWidget *> QWidgetAction::createdWidgets()

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

defaultWidget

Signature: [const] QWidget ptr defaultWidget

Description: Method QWidget *QWidgetAction::defaultWidget()

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

defaultWidget=

Signature: void defaultWidget= (QWidget ptr w)

Description: Method void QWidgetAction::setDefaultWidget(QWidget *w)

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

deleteWidget

Signature: void deleteWidget (QWidget ptr widget)

Description: Virtual method void QWidgetAction::deleteWidget(QWidget *widget)

This method can be reimplemented in a derived class.

destroyed

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

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

This method can be reimplemented in a derived class.

emit_changed

Signature: void emit_changed

Description: Emitter for signal void QWidgetAction::changed()

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_hovered

Signature: void emit_hovered

Description: Emitter for signal void QWidgetAction::hovered()

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_toggled

Signature: void emit_toggled (bool arg1)

Description: Emitter for signal void QWidgetAction::toggled(bool)

Call this method to emit this signal.

emit_triggered

Signature: void emit_triggered (bool checked = false)

Description: Emitter for signal void QWidgetAction::triggered(bool checked)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QWidgetAction::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

hovered

Signature: [signal] void hovered

Description: Signal declaration for QWidgetAction::hovered()

You can bind a procedure to this signal.

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

isSignalConnected

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

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

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

new

Signature: [static] new QWidgetAction new (QObject ptr parent)

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

This method creates an object of class QWidgetAction.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

receivers

Signature: [const] int receivers (string signal)

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

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

releaseWidget

Signature: void releaseWidget (QWidget ptr widget)

Description: Method void QWidgetAction::releaseWidget(QWidget *widget)

requestWidget

Signature: QWidget ptr requestWidget (QWidget ptr parent)

Description: Method QWidget *QWidgetAction::requestWidget(QWidget *parent)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QWidgetAction::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QWidgetAction::senderSignalIndex()

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

setDefaultWidget

Signature: void setDefaultWidget (QWidget ptr w)

Description: Method void QWidgetAction::setDefaultWidget(QWidget *w)

Python specific notes:
The object exposes a writable attribute 'defaultWidget'. 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 QWidgetAction::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

toggled

Signature: [signal] void toggled (bool arg1)

Description: Signal declaration for QWidgetAction::toggled(bool)

You can bind a procedure to this signal.

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

tr

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

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

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

triggered

Signature: [signal] void triggered (bool checked)

Description: Signal declaration for QWidgetAction::triggered(bool checked)

You can bind a procedure to this signal.

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