KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QAnimationGroup

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QAnimationGroup

Class hierarchy: QAnimationGroup » QAbstractAnimation » QObject

Public constructors

new QAnimationGroupnew(QObject ptr parent = nullptr)Constructor QAnimationGroup::QAnimationGroup(QObject *parent)

Public methods

[const]QAnimationGroup 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.
voidaddAnimation(QAbstractAnimation ptr animation)Method void QAnimationGroup::addAnimation(QAbstractAnimation *animation)
[const]QAbstractAnimation ptranimationAt(int index)Method QAbstractAnimation *QAnimationGroup::animationAt(int index)
[const]intanimationCountMethod int QAnimationGroup::animationCount()
voidclearMethod void QAnimationGroup::clear()
[signal]voidcurrentLoopChanged(int currentLoop)Signal declaration for QAnimationGroup::currentLoopChanged(int currentLoop)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QAnimationGroup::destroyed(QObject *)
[signal]voiddirectionChanged(const QAbstractAnimation_Direction arg1)Signal declaration for QAnimationGroup::directionChanged(QAbstractAnimation::Direction)
[const]intdurationVirtual method int QAnimationGroup::duration()
voidemit_currentLoopChanged(int currentLoop)Emitter for signal void QAnimationGroup::currentLoopChanged(int currentLoop)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QAnimationGroup::destroyed(QObject *)
voidemit_directionChanged(const QAbstractAnimation_Direction arg1)Emitter for signal void QAnimationGroup::directionChanged(QAbstractAnimation::Direction)
voidemit_finishedEmitter for signal void QAnimationGroup::finished()
voidemit_objectNameChanged(string objectName)Emitter for signal void QAnimationGroup::objectNameChanged(const QString &objectName)
voidemit_stateChanged(const QAbstractAnimation_State newState,
const QAbstractAnimation_State oldState)
Emitter for signal void QAnimationGroup::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QAnimationGroup::eventFilter(QObject *watched, QEvent *event)
[signal]voidfinishedSignal declaration for QAnimationGroup::finished()
[const]intindexOfAnimation(QAbstractAnimation ptr animation)Method int QAnimationGroup::indexOfAnimation(QAbstractAnimation *animation)
voidinsertAnimation(int index,
QAbstractAnimation ptr animation)
Method void QAnimationGroup::insertAnimation(int index, QAbstractAnimation *animation)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QAnimationGroup::objectNameChanged(const QString &objectName)
voidremoveAnimation(QAbstractAnimation ptr animation)Method void QAnimationGroup::removeAnimation(QAbstractAnimation *animation)
[signal]voidstateChanged(const QAbstractAnimation_State newState,
const QAbstractAnimation_State oldState)
Signal declaration for QAnimationGroup::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)
QAbstractAnimation ptrtakeAnimation(int index)Method QAbstractAnimation *QAnimationGroup::takeAnimation(int index)

Public static methods and constants

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

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QAnimationGroup::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QAnimationGroup::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QAnimationGroup::disconnectNotify(const QMetaMethod &signal)
boolevent(QEvent ptr event)Virtual method bool QAnimationGroup::event(QEvent *event)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QAnimationGroup::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QAnimationGroup::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QAnimationGroup::sender()
[const]intsenderSignalIndexMethod int QAnimationGroup::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QAnimationGroup::timerEvent(QTimerEvent *event)
voidupdateCurrentTime(int currentTime)Virtual method void QAnimationGroup::updateCurrentTime(int currentTime)
voidupdateDirection(const QAbstractAnimation_Direction direction)Virtual method void QAnimationGroup::updateDirection(QAbstractAnimation::Direction direction)
voidupdateState(const QAbstractAnimation_State newState,
const QAbstractAnimation_State oldState)
Virtual method void QAnimationGroup::updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

Detailed description

_const_cast

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

addAnimation

Signature: void addAnimation (QAbstractAnimation ptr animation)

Description: Method void QAnimationGroup::addAnimation(QAbstractAnimation *animation)

animationAt

Signature: [const] QAbstractAnimation ptr animationAt (int index)

Description: Method QAbstractAnimation *QAnimationGroup::animationAt(int index)

animationCount

Signature: [const] int animationCount

Description: Method int QAnimationGroup::animationCount()

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

clear

Signature: void clear

Description: Method void QAnimationGroup::clear()

currentLoopChanged

Signature: [signal] void currentLoopChanged (int currentLoop)

Description: Signal declaration for QAnimationGroup::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 event)

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

This method can be reimplemented in a derived class.

destroyed

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

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

This method can be reimplemented in a derived class.

duration

Signature: [const] int duration

Description: Virtual method int QAnimationGroup::duration()

This method can be reimplemented in a derived class.

emit_currentLoopChanged

Signature: void emit_currentLoopChanged (int currentLoop)

Description: Emitter for signal void QAnimationGroup::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 QAnimationGroup::destroyed(QObject *)

Call this method to emit this signal.

emit_directionChanged

Signature: void emit_directionChanged (const QAbstractAnimation_Direction arg1)

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

Call this method to emit this signal.

emit_finished

Signature: void emit_finished

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QAnimationGroup::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 QAnimationGroup::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

finished

Signature: [signal] void finished

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

indexOfAnimation

Signature: [const] int indexOfAnimation (QAbstractAnimation ptr animation)

Description: Method int QAnimationGroup::indexOfAnimation(QAbstractAnimation *animation)

insertAnimation

Signature: void insertAnimation (int index, QAbstractAnimation ptr animation)

Description: Method void QAnimationGroup::insertAnimation(int index, QAbstractAnimation *animation)

isSignalConnected

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

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

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

new

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

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

This method creates an object of class QAnimationGroup.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QAnimationGroup::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 QAnimationGroup::receivers(const char *signal)

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

removeAnimation

Signature: void removeAnimation (QAbstractAnimation ptr animation)

Description: Method void QAnimationGroup::removeAnimation(QAbstractAnimation *animation)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QAnimationGroup::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QAnimationGroup::senderSignalIndex()

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

stateChanged

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

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

takeAnimation

Signature: QAbstractAnimation ptr takeAnimation (int index)

Description: Method QAbstractAnimation *QAnimationGroup::takeAnimation(int index)

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QAnimationGroup::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 QAnimationGroup::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 QAnimationGroup::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 currentTime)

Description: Virtual method void QAnimationGroup::updateCurrentTime(int currentTime)

This method can be reimplemented in a derived class.

updateDirection

Signature: void updateDirection (const QAbstractAnimation_Direction direction)

Description: Virtual method void QAnimationGroup::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 QAnimationGroup::updateState(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)

This method can be reimplemented in a derived class.