API reference - Class QPropertyAnimation

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QPropertyAnimation

Class hierarchy: QPropertyAnimation » QVariantAnimation » QAbstractAnimation » QObject

Public constructors

new QPropertyAnimationnew(QObject ptr parent = 0)Constructor QPropertyAnimation::QPropertyAnimation(QObject *parent)
new QPropertyAnimationnew(QObject ptr target,
bytes propertyName,
QObject ptr parent = 0)
Constructor QPropertyAnimation::QPropertyAnimation(QObject *target, const QByteArray &propertyName, QObject *parent)

Public methods

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 QPropertyAnimation::currentLoopChanged(int currentLoop)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QPropertyAnimation::destroyed(QObject *)
[signal]voiddirectionChanged(const QAbstractAnimation_Direction arg1)Signal declaration for QPropertyAnimation::directionChanged(QAbstractAnimation::Direction)
[const]intdurationVirtual method int QPropertyAnimation::duration()
voidemit_currentLoopChanged(int currentLoop)Emitter for signal void QPropertyAnimation::currentLoopChanged(int currentLoop)
voidemit_destroyed(QObject ptr arg1 = 0)Emitter for signal void QPropertyAnimation::destroyed(QObject *)
voidemit_directionChanged(const QAbstractAnimation_Direction arg1)Emitter for signal void QPropertyAnimation::directionChanged(QAbstractAnimation::Direction)
voidemit_finishedEmitter for signal void QPropertyAnimation::finished()
voidemit_objectNameChanged(string objectName)Emitter for signal void QPropertyAnimation::objectNameChanged(const QString &objectName)
voidemit_stateChanged(const QAbstractAnimation_State newState,
const QAbstractAnimation_State oldState)
Emitter for signal void QPropertyAnimation::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)
voidemit_valueChanged(variant value)Emitter for signal void QPropertyAnimation::valueChanged(const QVariant &value)
booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QPropertyAnimation::eventFilter(QObject *, QEvent *)
[signal]voidfinishedSignal declaration for QPropertyAnimation::finished()
[signal]voidobjectNameChanged(string objectName)Signal declaration for QPropertyAnimation::objectNameChanged(const QString &objectName)
[const]bytespropertyNameMethod QByteArray QPropertyAnimation::propertyName()
voidpropertyName=(bytes propertyName)Method void QPropertyAnimation::setPropertyName(const QByteArray &propertyName)
voidsetPropertyName(bytes propertyName)Method void QPropertyAnimation::setPropertyName(const QByteArray &propertyName)
voidsetTargetObject(QObject ptr target)Method void QPropertyAnimation::setTargetObject(QObject *target)
[signal]voidstateChanged(const QAbstractAnimation_State newState,
const QAbstractAnimation_State oldState)
Signal declaration for QPropertyAnimation::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)
[const]QObject ptrtargetObjectMethod QObject *QPropertyAnimation::targetObject()
voidtargetObject=(QObject ptr target)Method void QPropertyAnimation::setTargetObject(QObject *target)
[signal]voidvalueChanged(variant value)Signal declaration for QPropertyAnimation::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 QPropertyAnimation::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QPropertyAnimation::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Detailed description

_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 arg1)

Description: Virtual method void QPropertyAnimation::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

currentLoopChanged

Signature: [signal] void currentLoopChanged (int currentLoop)

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

customEvent

Signature: void customEvent (QEvent ptr arg1)

Description: Virtual method void QPropertyAnimation::customEvent(QEvent *)

This method can be reimplemented in a derived class.

destroyed

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

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

This method can be reimplemented in a derived class.

duration

Signature: [const] int duration

Description: Virtual method int QPropertyAnimation::duration()

This method can be reimplemented in a derived class.

emit_currentLoopChanged

Signature: void emit_currentLoopChanged (int currentLoop)

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

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = 0)

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

Call this method to emit this signal.

emit_directionChanged

Signature: void emit_directionChanged (const QAbstractAnimation_Direction arg1)

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

Call this method to emit this signal.

emit_finished

Signature: void emit_finished

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QPropertyAnimation::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 QPropertyAnimation::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 QPropertyAnimation::valueChanged(const QVariant &value)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QPropertyAnimation::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr arg1, QEvent ptr arg2)

Description: Virtual method bool QPropertyAnimation::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

finished

Signature: [signal] void finished

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

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

new

(1) Signature: [static] new QPropertyAnimation new (QObject ptr parent = 0)

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

This method creates an object of class QPropertyAnimation.

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

(2) Signature: [static] new QPropertyAnimation new (QObject ptr target, bytes propertyName, QObject ptr parent = 0)

Description: Constructor QPropertyAnimation::QPropertyAnimation(QObject *target, const QByteArray &propertyName, QObject *parent)

This method creates an object of class QPropertyAnimation.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

propertyName

Signature: [const] bytes propertyName

Description: Method QByteArray QPropertyAnimation::propertyName()

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

propertyName=

Signature: void propertyName= (bytes propertyName)

Description: Method void QPropertyAnimation::setPropertyName(const QByteArray &propertyName)

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

receivers

Signature: [const] int receivers (string signal)

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

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QPropertyAnimation::senderSignalIndex()

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

setPropertyName

Signature: void setPropertyName (bytes propertyName)

Description: Method void QPropertyAnimation::setPropertyName(const QByteArray &propertyName)

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

setTargetObject

Signature: void setTargetObject (QObject ptr target)

Description: Method void QPropertyAnimation::setTargetObject(QObject *target)

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

stateChanged

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

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

targetObject

Signature: [const] QObject ptr targetObject

Description: Method QObject *QPropertyAnimation::targetObject()

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

targetObject=

Signature: void targetObject= (QObject ptr target)

Description: Method void QPropertyAnimation::setTargetObject(QObject *target)

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr arg1)

Description: Virtual method void QPropertyAnimation::timerEvent(QTimerEvent *)

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 QPropertyAnimation::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 QPropertyAnimation::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 QPropertyAnimation::updateCurrentTime(int)

This method can be reimplemented in a derived class.

updateCurrentValue

Signature: void updateCurrentValue (variant value)

Description: Virtual method void QPropertyAnimation::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 QPropertyAnimation::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 QPropertyAnimation::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 QPropertyAnimation::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.