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

API reference - Class QPanGesture

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QPanGesture

Class hierarchy: QPanGesture » QGesture » QObject

Public constructors

new QPanGesturenew(QObject ptr parent = nullptr)Constructor QPanGesture::QPanGesture(QObject *parent)

Public methods

[const]QPanGesture 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]doubleaccelerationMethod double QPanGesture::acceleration()
voidacceleration=(double value)Method void QPanGesture::setAcceleration(double value)
[const]QPointFdeltaMethod QPointF QPanGesture::delta()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QPanGesture::destroyed(QObject *)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QPanGesture::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QPanGesture::objectNameChanged(const QString &objectName)
boolevent(QEvent ptr event)Virtual method bool QPanGesture::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QPanGesture::eventFilter(QObject *watched, QEvent *event)
[const]QPointFlastOffsetMethod QPointF QPanGesture::lastOffset()
voidlastOffset=(const QPointF value)Method void QPanGesture::setLastOffset(const QPointF &value)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QPanGesture::objectNameChanged(const QString &objectName)
[const]QPointFoffsetMethod QPointF QPanGesture::offset()
voidoffset=(const QPointF value)Method void QPanGesture::setOffset(const QPointF &value)
voidsetAcceleration(double value)Method void QPanGesture::setAcceleration(double value)
voidsetLastOffset(const QPointF value)Method void QPanGesture::setLastOffset(const QPointF &value)
voidsetOffset(const QPointF value)Method void QPanGesture::setOffset(const QPointF &value)

Public static methods and constants

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

Protected methods (static, non-static and constructors)

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

Detailed description

_const_cast

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

acceleration

Signature: [const] double acceleration

Description: Method double QPanGesture::acceleration()

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

acceleration=

Signature: void acceleration= (double value)

Description: Method void QPanGesture::setAcceleration(double value)

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

delta

Signature: [const] QPointF delta

Description: Method QPointF QPanGesture::delta()

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

destroyed

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

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QPanGesture::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 QPanGesture::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 QPanGesture::isSignalConnected(const QMetaMethod &signal)

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

lastOffset

Signature: [const] QPointF lastOffset

Description: Method QPointF QPanGesture::lastOffset()

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

lastOffset=

Signature: void lastOffset= (const QPointF value)

Description: Method void QPanGesture::setLastOffset(const QPointF &value)

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

new

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

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

This method creates an object of class QPanGesture.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

offset

Signature: [const] QPointF offset

Description: Method QPointF QPanGesture::offset()

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

offset=

Signature: void offset= (const QPointF value)

Description: Method void QPanGesture::setOffset(const QPointF &value)

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

receivers

Signature: [const] int receivers (string signal)

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

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QPanGesture::senderSignalIndex()

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

setAcceleration

Signature: void setAcceleration (double value)

Description: Method void QPanGesture::setAcceleration(double value)

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

setLastOffset

Signature: void setLastOffset (const QPointF value)

Description: Method void QPanGesture::setLastOffset(const QPointF &value)

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

setOffset

Signature: void setOffset (const QPointF value)

Description: Method void QPanGesture::setOffset(const QPointF &value)

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

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