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

API reference - Class QVariantAnimation

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QVariantAnimation

Class hierarchy: QVariantAnimation » QAbstractAnimation » QObject

Public constructors

new QVariantAnimationnew(QObject ptr parent = nullptr)Constructor QVariantAnimation::QVariantAnimation(QObject *parent)

Public methods

[const]QVariantAnimation 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]voidcurrentLoopChanged(int currentLoop)Signal declaration for QVariantAnimation::currentLoopChanged(int currentLoop)
[const]variantcurrentValueMethod QVariant QVariantAnimation::currentValue()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QVariantAnimation::destroyed(QObject *)
[signal]voiddirectionChanged(const QAbstractAnimation_Direction arg1)Signal declaration for QVariantAnimation::directionChanged(QAbstractAnimation::Direction)
[const]intdurationVirtual method int QVariantAnimation::duration()
voidduration=(int msecs)Method void QVariantAnimation::setDuration(int msecs)
[const]QEasingCurveeasingCurveMethod QEasingCurve QVariantAnimation::easingCurve()
voideasingCurve=(const QEasingCurve easing)Method void QVariantAnimation::setEasingCurve(const QEasingCurve &easing)
voidemit_currentLoopChanged(int currentLoop)Emitter for signal void QVariantAnimation::currentLoopChanged(int currentLoop)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QVariantAnimation::destroyed(QObject *)
voidemit_directionChanged(const QAbstractAnimation_Direction arg1)Emitter for signal void QVariantAnimation::directionChanged(QAbstractAnimation::Direction)
voidemit_finishedEmitter for signal void QVariantAnimation::finished()
voidemit_objectNameChanged(string objectName)Emitter for signal void QVariantAnimation::objectNameChanged(const QString &objectName)
voidemit_stateChanged(const QAbstractAnimation_State newState,
const QAbstractAnimation_State oldState)
Emitter for signal void QVariantAnimation::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)
voidemit_valueChanged(variant value)Emitter for signal void QVariantAnimation::valueChanged(const QVariant &value)
[const]variantendValueMethod QVariant QVariantAnimation::endValue()
voidendValue=(variant value)Method void QVariantAnimation::setEndValue(const QVariant &value)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QVariantAnimation::eventFilter(QObject *watched, QEvent *event)
[signal]voidfinishedSignal declaration for QVariantAnimation::finished()
[const]variantkeyValueAt(double step)Method QVariant QVariantAnimation::keyValueAt(double step)
[const]QPair_double_QVariant[]keyValuesMethod QVector<QVariantAnimation::KeyValue> QVariantAnimation::keyValues()
voidkeyValues=(QPair_double_QVariant[] values)Method void QVariantAnimation::setKeyValues(const QVector<QVariantAnimation::KeyValue> &values)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QVariantAnimation::objectNameChanged(const QString &objectName)
voidsetDuration(int msecs)Method void QVariantAnimation::setDuration(int msecs)
voidsetEasingCurve(const QEasingCurve easing)Method void QVariantAnimation::setEasingCurve(const QEasingCurve &easing)
voidsetEndValue(variant value)Method void QVariantAnimation::setEndValue(const QVariant &value)
voidsetKeyValueAt(double step,
variant value)
Method void QVariantAnimation::setKeyValueAt(double step, const QVariant &value)
voidsetKeyValues(QPair_double_QVariant[] values)Method void QVariantAnimation::setKeyValues(const QVector<QVariantAnimation::KeyValue> &values)
voidsetStartValue(variant value)Method void QVariantAnimation::setStartValue(const QVariant &value)
[const]variantstartValueMethod QVariant QVariantAnimation::startValue()
voidstartValue=(variant value)Method void QVariantAnimation::setStartValue(const QVariant &value)
[signal]voidstateChanged(const QAbstractAnimation_State newState,
const QAbstractAnimation_State oldState)
Signal declaration for QVariantAnimation::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)
[signal]voidvalueChanged(variant value)Signal declaration for QVariantAnimation::valueChanged(const QVariant &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 QVariantAnimation::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QVariantAnimation::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QVariantAnimation::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QVariantAnimation::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QVariantAnimation::disconnectNotify(const QMetaMethod &signal)
boolevent(QEvent ptr event)Virtual method bool QVariantAnimation::event(QEvent *event)
[const]variantinterpolated(variant from,
variant to,
double progress)
Virtual method QVariant QVariantAnimation::interpolated(const QVariant &from, const QVariant &to, double progress)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QVariantAnimation::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QVariantAnimation::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QVariantAnimation::sender()
[const]intsenderSignalIndexMethod int QVariantAnimation::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QVariantAnimation::timerEvent(QTimerEvent *event)
voidupdateCurrentTime(int arg1)Virtual method void QVariantAnimation::updateCurrentTime(int)
voidupdateCurrentValue(variant value)Virtual method void QVariantAnimation::updateCurrentValue(const QVariant &value)
voidupdateDirection(const QAbstractAnimation_Direction direction)Virtual method void QVariantAnimation::updateDirection(QAbstractAnimation::Direction direction)
voidupdateState(const QAbstractAnimation_State newState,
const QAbstractAnimation_State oldState)
Virtual method void QVariantAnimation::updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

Detailed description

_const_cast

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

This method can be reimplemented in a derived class.

currentLoopChanged

Signature: [signal] void currentLoopChanged (int currentLoop)

Description: Signal declaration for QVariantAnimation::currentLoopChanged(int currentLoop)

You can bind a procedure to this signal.

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

currentValue

Signature: [const] variant currentValue

Description: Method QVariant QVariantAnimation::currentValue()

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

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

directionChanged

Signature: [signal] void directionChanged (const QAbstractAnimation_Direction arg1)

Description: Signal declaration for QVariantAnimation::directionChanged(QAbstractAnimation::Direction)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QVariantAnimation::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

duration

Signature: [const] int duration

Description: Virtual method int QVariantAnimation::duration()

This method can be reimplemented in a derived class.

duration=

Signature: void duration= (int msecs)

Description: Method void QVariantAnimation::setDuration(int msecs)

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

easingCurve

Signature: [const] QEasingCurve easingCurve

Description: Method QEasingCurve QVariantAnimation::easingCurve()

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

easingCurve=

Signature: void easingCurve= (const QEasingCurve easing)

Description: Method void QVariantAnimation::setEasingCurve(const QEasingCurve &easing)

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

emit_currentLoopChanged

Signature: void emit_currentLoopChanged (int currentLoop)

Description: Emitter for signal void QVariantAnimation::currentLoopChanged(int currentLoop)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_directionChanged

Signature: void emit_directionChanged (const QAbstractAnimation_Direction arg1)

Description: Emitter for signal void QVariantAnimation::directionChanged(QAbstractAnimation::Direction)

Call this method to emit this signal.

emit_finished

Signature: void emit_finished

Description: Emitter for signal void QVariantAnimation::finished()

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_stateChanged

Signature: void emit_stateChanged (const QAbstractAnimation_State newState, const QAbstractAnimation_State oldState)

Description: Emitter for signal void QVariantAnimation::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

Call this method to emit this signal.

emit_valueChanged

Signature: void emit_valueChanged (variant value)

Description: Emitter for signal void QVariantAnimation::valueChanged(const QVariant &value)

Call this method to emit this signal.

endValue

Signature: [const] variant endValue

Description: Method QVariant QVariantAnimation::endValue()

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

endValue=

Signature: void endValue= (variant value)

Description: Method void QVariantAnimation::setEndValue(const QVariant &value)

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

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

finished

Signature: [signal] void finished

Description: Signal declaration for QVariantAnimation::finished()

You can bind a procedure to this signal.

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

interpolated

Signature: [const] variant interpolated (variant from, variant to, double progress)

Description: Virtual method QVariant QVariantAnimation::interpolated(const QVariant &from, const QVariant &to, double progress)

This method can be reimplemented in a derived class.

isSignalConnected

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

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

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

keyValueAt

Signature: [const] variant keyValueAt (double step)

Description: Method QVariant QVariantAnimation::keyValueAt(double step)

keyValues

Signature: [const] QPair_double_QVariant[] keyValues

Description: Method QVector<QVariantAnimation::KeyValue> QVariantAnimation::keyValues()

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

keyValues=

Signature: void keyValues= (QPair_double_QVariant[] values)

Description: Method void QVariantAnimation::setKeyValues(const QVector<QVariantAnimation::KeyValue> &values)

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

new

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

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

This method creates an object of class QVariantAnimation.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QVariantAnimation::senderSignalIndex()

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

setDuration

Signature: void setDuration (int msecs)

Description: Method void QVariantAnimation::setDuration(int msecs)

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

setEasingCurve

Signature: void setEasingCurve (const QEasingCurve easing)

Description: Method void QVariantAnimation::setEasingCurve(const QEasingCurve &easing)

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

setEndValue

Signature: void setEndValue (variant value)

Description: Method void QVariantAnimation::setEndValue(const QVariant &value)

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

setKeyValueAt

Signature: void setKeyValueAt (double step, variant value)

Description: Method void QVariantAnimation::setKeyValueAt(double step, const QVariant &value)

setKeyValues

Signature: void setKeyValues (QPair_double_QVariant[] values)

Description: Method void QVariantAnimation::setKeyValues(const QVector<QVariantAnimation::KeyValue> &values)

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

setStartValue

Signature: void setStartValue (variant value)

Description: Method void QVariantAnimation::setStartValue(const QVariant &value)

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

startValue

Signature: [const] variant startValue

Description: Method QVariant QVariantAnimation::startValue()

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

startValue=

Signature: void startValue= (variant value)

Description: Method void QVariantAnimation::setStartValue(const QVariant &value)

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

stateChanged

Signature: [signal] void stateChanged (const QAbstractAnimation_State newState, const QAbstractAnimation_State oldState)

Description: Signal declaration for QVariantAnimation::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'stateChanged'. This is the getter.
The object exposes a writable attribute 'stateChanged'. 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 QVariantAnimation::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 QVariantAnimation::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 QVariantAnimation::trUtf8(const char *s, const char *c, int n)

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

updateCurrentTime

Signature: void updateCurrentTime (int arg1)

Description: Virtual method void QVariantAnimation::updateCurrentTime(int)

This method can be reimplemented in a derived class.

updateCurrentValue

Signature: void updateCurrentValue (variant value)

Description: Virtual method void QVariantAnimation::updateCurrentValue(const QVariant &value)

This method can be reimplemented in a derived class.

updateDirection

Signature: void updateDirection (const QAbstractAnimation_Direction direction)

Description: Virtual method void QVariantAnimation::updateDirection(QAbstractAnimation::Direction direction)

This method can be reimplemented in a derived class.

updateState

Signature: void updateState (const QAbstractAnimation_State newState, const QAbstractAnimation_State oldState)

Description: Virtual method void QVariantAnimation::updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

This method can be reimplemented in a derived class.

valueChanged

Signature: [signal] void valueChanged (variant value)

Description: Signal declaration for QVariantAnimation::valueChanged(const QVariant &value)

You can bind a procedure to this signal.

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