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

API reference - Class QGesture

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QGesture

Class hierarchy: QGesture » QObject

Sub-classes: GestureCancelPolicy, QFlags_GestureCancelPolicy

Public constructors

new QGesturenew(QObject ptr parent = nullptr)Constructor QGesture::QGesture(QObject *parent)

Public methods

[const]QGesture 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]voiddestroyed(QObject ptr arg1)Signal declaration for QGesture::destroyed(QObject *)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QGesture::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QGesture::objectNameChanged(const QString &objectName)
boolevent(QEvent ptr event)Virtual method bool QGesture::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QGesture::eventFilter(QObject *watched, QEvent *event)
[const]QGesture_GestureCancelPolicygestureCancelPolicyMethod QGesture::GestureCancelPolicy QGesture::gestureCancelPolicy()
voidgestureCancelPolicy=(const QGesture_GestureCancelPolicy policy)Method void QGesture::setGestureCancelPolicy(QGesture::GestureCancelPolicy policy)
[const]Qt_GestureTypegestureTypeMethod Qt::GestureType QGesture::gestureType()
[const]boolhasHotSpotMethod bool QGesture::hasHotSpot()
[const]boolhotSpotMethod bool QGesture::hasHotSpot()
[const]QPointFhotSpotMethod QPointF QGesture::hotSpot()
voidhotSpot=(const QPointF value)Method void QGesture::setHotSpot(const QPointF &value)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QGesture::objectNameChanged(const QString &objectName)
voidsetGestureCancelPolicy(const QGesture_GestureCancelPolicy policy)Method void QGesture::setGestureCancelPolicy(QGesture::GestureCancelPolicy policy)
voidsetHotSpot(const QPointF value)Method void QGesture::setHotSpot(const QPointF &value)
[const]Qt_GestureStatestateMethod Qt::GestureState QGesture::state()
voidunsetHotSpotMethod void QGesture::unsetHotSpot()

Public static methods and constants

[static,const]QGesture_GestureCancelPolicyCancelAllInContextEnum constant QGesture::CancelAllInContext
[static,const]QGesture_GestureCancelPolicyCancelNoneEnum constant QGesture::CancelNone
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QGesture::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QGesture::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Detailed description

CancelAllInContext

Signature: [static,const] QGesture_GestureCancelPolicy CancelAllInContext

Description: Enum constant QGesture::CancelAllInContext

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

CancelNone

Signature: [static,const] QGesture_GestureCancelPolicy CancelNone

Description: Enum constant QGesture::CancelNone

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

_const_cast

Signature: [const] QGesture 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 QGesture::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QGesture::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 QGesture::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 QGesture::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

gestureCancelPolicy

Signature: [const] QGesture_GestureCancelPolicy gestureCancelPolicy

Description: Method QGesture::GestureCancelPolicy QGesture::gestureCancelPolicy()

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

gestureCancelPolicy=

Signature: void gestureCancelPolicy= (const QGesture_GestureCancelPolicy policy)

Description: Method void QGesture::setGestureCancelPolicy(QGesture::GestureCancelPolicy policy)

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

gestureType

Signature: [const] Qt_GestureType gestureType

Description: Method Qt::GestureType QGesture::gestureType()

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

hasHotSpot

Signature: [const] bool hasHotSpot

Description: Method bool QGesture::hasHotSpot()

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

hotSpot

(1) Signature: [const] bool hotSpot

Description: Method bool QGesture::hasHotSpot()

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

(2) Signature: [const] QPointF hotSpot

Description: Method QPointF QGesture::hotSpot()

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

hotSpot=

Signature: void hotSpot= (const QPointF value)

Description: Method void QGesture::setHotSpot(const QPointF &value)

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

isSignalConnected

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

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

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

new

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

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

This method creates an object of class QGesture.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QGesture::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 QGesture::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 *QGesture::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QGesture::senderSignalIndex()

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

setGestureCancelPolicy

Signature: void setGestureCancelPolicy (const QGesture_GestureCancelPolicy policy)

Description: Method void QGesture::setGestureCancelPolicy(QGesture::GestureCancelPolicy policy)

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

setHotSpot

Signature: void setHotSpot (const QPointF value)

Description: Method void QGesture::setHotSpot(const QPointF &value)

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

state

Signature: [const] Qt_GestureState state

Description: Method Qt::GestureState QGesture::state()

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QGesture::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 QGesture::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 QGesture::trUtf8(const char *s, const char *c, int n)

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

unsetHotSpot

Signature: void unsetHotSpot

Description: Method void QGesture::unsetHotSpot()