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

API reference - Class QShortcut

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QShortcut

Class hierarchy: QShortcut » QObject

Public constructors

new QShortcutnew(QWidget ptr parent)Constructor QShortcut::QShortcut(QWidget *parent)
new QShortcutnew(const QKeySequence key,
QWidget ptr parent,
string member = nullptr,
string ambiguousMember = nullptr,
const Qt_ShortcutContext context = Qt::WindowShortcut)
Constructor QShortcut::QShortcut(const QKeySequence &key, QWidget *parent, const char *member, const char *ambiguousMember, Qt::ShortcutContext context)

Public methods

[const]QShortcut 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]voidactivatedSignal declaration for QShortcut::activated()
[signal]voidactivatedAmbiguouslySignal declaration for QShortcut::activatedAmbiguously()
[const]boolautoRepeatMethod bool QShortcut::autoRepeat()
voidautoRepeat=(bool on)Method void QShortcut::setAutoRepeat(bool on)
[const]Qt_ShortcutContextcontextMethod Qt::ShortcutContext QShortcut::context()
voidcontext=(const Qt_ShortcutContext context)Method void QShortcut::setContext(Qt::ShortcutContext context)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QShortcut::destroyed(QObject *)
voidemit_activatedEmitter for signal void QShortcut::activated()
voidemit_activatedAmbiguouslyEmitter for signal void QShortcut::activatedAmbiguously()
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QShortcut::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QShortcut::objectNameChanged(const QString &objectName)
[const]boolenabledMethod bool QShortcut::isEnabled()
voidenabled=(bool enable)Method void QShortcut::setEnabled(bool enable)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QShortcut::eventFilter(QObject *watched, QEvent *event)
[const]intidMethod int QShortcut::id()
[const]boolisEnabled?Method bool QShortcut::isEnabled()
[const]QKeySequencekeyMethod QKeySequence QShortcut::key()
voidkey=(const QKeySequence key)Method void QShortcut::setKey(const QKeySequence &key)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QShortcut::objectNameChanged(const QString &objectName)
[const]QWidget ptrparentWidgetMethod QWidget *QShortcut::parentWidget()
voidsetAutoRepeat(bool on)Method void QShortcut::setAutoRepeat(bool on)
voidsetContext(const Qt_ShortcutContext context)Method void QShortcut::setContext(Qt::ShortcutContext context)
voidsetEnabled(bool enable)Method void QShortcut::setEnabled(bool enable)
voidsetKey(const QKeySequence key)Method void QShortcut::setKey(const QKeySequence &key)
voidsetWhatsThis(string text)Method void QShortcut::setWhatsThis(const QString &text)
[const]stringwhatsThisMethod QString QShortcut::whatsThis()
voidwhatsThis=(string text)Method void QShortcut::setWhatsThis(const QString &text)

Public static methods and constants

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

Protected methods (static, non-static and constructors)

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

Detailed description

_const_cast

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

activated

Signature: [signal] void activated

Description: Signal declaration for QShortcut::activated()

You can bind a procedure to this signal.

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

activatedAmbiguously

Signature: [signal] void activatedAmbiguously

Description: Signal declaration for QShortcut::activatedAmbiguously()

You can bind a procedure to this signal.

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

autoRepeat

Signature: [const] bool autoRepeat

Description: Method bool QShortcut::autoRepeat()

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

autoRepeat=

Signature: void autoRepeat= (bool on)

Description: Method void QShortcut::setAutoRepeat(bool on)

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

context

Signature: [const] Qt_ShortcutContext context

Description: Method Qt::ShortcutContext QShortcut::context()

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

context=

Signature: void context= (const Qt_ShortcutContext context)

Description: Method void QShortcut::setContext(Qt::ShortcutContext context)

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

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

This method can be reimplemented in a derived class.

emit_activated

Signature: void emit_activated

Description: Emitter for signal void QShortcut::activated()

Call this method to emit this signal.

emit_activatedAmbiguously

Signature: void emit_activatedAmbiguously

Description: Emitter for signal void QShortcut::activatedAmbiguously()

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

enabled

Signature: [const] bool enabled

Description: Method bool QShortcut::isEnabled()

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

enabled=

Signature: void enabled= (bool enable)

Description: Method void QShortcut::setEnabled(bool enable)

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

event

Signature: bool event (QEvent ptr e)

Description: Virtual method bool QShortcut::event(QEvent *e)

This method can be reimplemented in a derived class.

eventFilter

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

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

This method can be reimplemented in a derived class.

id

Signature: [const] int id

Description: Method int QShortcut::id()

isEnabled?

Signature: [const] bool isEnabled?

Description: Method bool QShortcut::isEnabled()

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

isSignalConnected

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

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

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

key

Signature: [const] QKeySequence key

Description: Method QKeySequence QShortcut::key()

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

key=

Signature: void key= (const QKeySequence key)

Description: Method void QShortcut::setKey(const QKeySequence &key)

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

new

(1) Signature: [static] new QShortcut new (QWidget ptr parent)

Description: Constructor QShortcut::QShortcut(QWidget *parent)

This method creates an object of class QShortcut.

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

(2) Signature: [static] new QShortcut new (const QKeySequence key, QWidget ptr parent, string member = nullptr, string ambiguousMember = nullptr, const Qt_ShortcutContext context = Qt::WindowShortcut)

Description: Constructor QShortcut::QShortcut(const QKeySequence &key, QWidget *parent, const char *member, const char *ambiguousMember, Qt::ShortcutContext context)

This method creates an object of class QShortcut.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

parentWidget

Signature: [const] QWidget ptr parentWidget

Description: Method QWidget *QShortcut::parentWidget()

receivers

Signature: [const] int receivers (string signal)

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

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QShortcut::senderSignalIndex()

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

setAutoRepeat

Signature: void setAutoRepeat (bool on)

Description: Method void QShortcut::setAutoRepeat(bool on)

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

setContext

Signature: void setContext (const Qt_ShortcutContext context)

Description: Method void QShortcut::setContext(Qt::ShortcutContext context)

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

setEnabled

Signature: void setEnabled (bool enable)

Description: Method void QShortcut::setEnabled(bool enable)

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

setKey

Signature: void setKey (const QKeySequence key)

Description: Method void QShortcut::setKey(const QKeySequence &key)

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

setWhatsThis

Signature: void setWhatsThis (string text)

Description: Method void QShortcut::setWhatsThis(const QString &text)

Python specific notes:
The object exposes a writable attribute 'whatsThis'. 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 QShortcut::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 QShortcut::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 QShortcut::trUtf8(const char *s, const char *c, int n)

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

whatsThis

Signature: [const] string whatsThis

Description: Method QString QShortcut::whatsThis()

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

whatsThis=

Signature: void whatsThis= (string text)

Description: Method void QShortcut::setWhatsThis(const QString &text)

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