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

API reference - Class QActionGroup

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QActionGroup

Class hierarchy: QActionGroup » QObject

Public constructors

new QActionGroupnew(QObject ptr parent)Constructor QActionGroup::QActionGroup(QObject *parent)

Public methods

[const]QActionGroup 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.
[const]QAction ptr[]actionsMethod QList<QAction*> QActionGroup::actions()
QAction ptraddAction(QAction ptr a)Method QAction *QActionGroup::addAction(QAction *a)
QAction ptraddAction(string text)Method QAction *QActionGroup::addAction(const QString &text)
QAction ptraddAction(const QIcon icon,
string text)
Method QAction *QActionGroup::addAction(const QIcon &icon, const QString &text)
[const]QAction ptrcheckedActionMethod QAction *QActionGroup::checkedAction()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QActionGroup::destroyed(QObject *)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QActionGroup::destroyed(QObject *)
voidemit_hovered(QAction ptr arg1)Emitter for signal void QActionGroup::hovered(QAction *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QActionGroup::objectNameChanged(const QString &objectName)
voidemit_triggered(QAction ptr arg1)Emitter for signal void QActionGroup::triggered(QAction *)
[const]boolenabledMethod bool QActionGroup::isEnabled()
voidenabled=(bool arg1)Method void QActionGroup::setEnabled(bool)
boolevent(QEvent ptr event)Virtual method bool QActionGroup::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QActionGroup::eventFilter(QObject *watched, QEvent *event)
[const]boolexclusiveMethod bool QActionGroup::isExclusive()
voidexclusive=(bool arg1)Method void QActionGroup::setExclusive(bool)
[signal]voidhovered(QAction ptr arg1)Signal declaration for QActionGroup::hovered(QAction *)
[const]boolisEnabled?Method bool QActionGroup::isEnabled()
[const]boolisExclusive?Method bool QActionGroup::isExclusive()
[const]boolisVisible?Method bool QActionGroup::isVisible()
[signal]voidobjectNameChanged(string objectName)Signal declaration for QActionGroup::objectNameChanged(const QString &objectName)
voidremoveAction(QAction ptr a)Method void QActionGroup::removeAction(QAction *a)
voidsetDisabled(bool b)Method void QActionGroup::setDisabled(bool b)
voidsetEnabled(bool arg1)Method void QActionGroup::setEnabled(bool)
voidsetExclusive(bool arg1)Method void QActionGroup::setExclusive(bool)
voidsetVisible(bool arg1)Method void QActionGroup::setVisible(bool)
[signal]voidtriggered(QAction ptr arg1)Signal declaration for QActionGroup::triggered(QAction *)
[const]boolvisibleMethod bool QActionGroup::isVisible()
voidvisible=(bool arg1)Method void QActionGroup::setVisible(bool)

Public static methods and constants

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

Protected methods (static, non-static and constructors)

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

Detailed description

_const_cast

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

actions

Signature: [const] QAction ptr[] actions

Description: Method QList<QAction*> QActionGroup::actions()

addAction

(1) Signature: QAction ptr addAction (QAction ptr a)

Description: Method QAction *QActionGroup::addAction(QAction *a)

(2) Signature: QAction ptr addAction (string text)

Description: Method QAction *QActionGroup::addAction(const QString &text)

(3) Signature: QAction ptr addAction (const QIcon icon, string text)

Description: Method QAction *QActionGroup::addAction(const QIcon &icon, const QString &text)

checkedAction

Signature: [const] QAction ptr checkedAction

Description: Method QAction *QActionGroup::checkedAction()

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

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

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_hovered

Signature: void emit_hovered (QAction ptr arg1)

Description: Emitter for signal void QActionGroup::hovered(QAction *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_triggered

Signature: void emit_triggered (QAction ptr arg1)

Description: Emitter for signal void QActionGroup::triggered(QAction *)

Call this method to emit this signal.

enabled

Signature: [const] bool enabled

Description: Method bool QActionGroup::isEnabled()

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

enabled=

Signature: void enabled= (bool arg1)

Description: Method void QActionGroup::setEnabled(bool)

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

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

exclusive

Signature: [const] bool exclusive

Description: Method bool QActionGroup::isExclusive()

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

exclusive=

Signature: void exclusive= (bool arg1)

Description: Method void QActionGroup::setExclusive(bool)

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

hovered

Signature: [signal] void hovered (QAction ptr arg1)

Description: Signal declaration for QActionGroup::hovered(QAction *)

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.

isEnabled?

Signature: [const] bool isEnabled?

Description: Method bool QActionGroup::isEnabled()

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

isExclusive?

Signature: [const] bool isExclusive?

Description: Method bool QActionGroup::isExclusive()

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

isSignalConnected

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

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

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

isVisible?

Signature: [const] bool isVisible?

Description: Method bool QActionGroup::isVisible()

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

new

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

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

This method creates an object of class QActionGroup.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QActionGroup::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 QActionGroup::receivers(const char *signal)

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

removeAction

Signature: void removeAction (QAction ptr a)

Description: Method void QActionGroup::removeAction(QAction *a)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QActionGroup::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QActionGroup::senderSignalIndex()

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

setDisabled

Signature: void setDisabled (bool b)

Description: Method void QActionGroup::setDisabled(bool b)

setEnabled

Signature: void setEnabled (bool arg1)

Description: Method void QActionGroup::setEnabled(bool)

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

setExclusive

Signature: void setExclusive (bool arg1)

Description: Method void QActionGroup::setExclusive(bool)

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

setVisible

Signature: void setVisible (bool arg1)

Description: Method void QActionGroup::setVisible(bool)

Python specific notes:
The object exposes a writable attribute 'visible'. 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 QActionGroup::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 QActionGroup::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 QActionGroup::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 (QAction ptr arg1)

Description: Signal declaration for QActionGroup::triggered(QAction *)

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.

visible

Signature: [const] bool visible

Description: Method bool QActionGroup::isVisible()

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

visible=

Signature: void visible= (bool arg1)

Description: Method void QActionGroup::setVisible(bool)

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