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

API reference - Class QAbstractAnimation

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QAbstractAnimation

Class hierarchy: QAbstractAnimation » QObject

Sub-classes: DeletionPolicy, QFlags_DeletionPolicy, Direction, QFlags_Direction, State, QFlags_State

Public constructors

new QAbstractAnimationnew(QObject ptr parent = nullptr)Constructor QAbstractAnimation::QAbstractAnimation(QObject *parent)

Public methods

[const]QAbstractAnimation 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]intcurrentLoopMethod int QAbstractAnimation::currentLoop()
[signal]voidcurrentLoopChanged(int currentLoop)Signal declaration for QAbstractAnimation::currentLoopChanged(int currentLoop)
[const]intcurrentLoopTimeMethod int QAbstractAnimation::currentLoopTime()
[const]intcurrentTimeMethod int QAbstractAnimation::currentTime()
voidcurrentTime=(int msecs)Method void QAbstractAnimation::setCurrentTime(int msecs)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QAbstractAnimation::destroyed(QObject *)
[const]QAbstractAnimation_DirectiondirectionMethod QAbstractAnimation::Direction QAbstractAnimation::direction()
voiddirection=(const QAbstractAnimation_Direction direction)Method void QAbstractAnimation::setDirection(QAbstractAnimation::Direction direction)
[signal]voiddirectionChanged(const QAbstractAnimation_Direction arg1)Signal declaration for QAbstractAnimation::directionChanged(QAbstractAnimation::Direction)
[const]intdurationVirtual method int QAbstractAnimation::duration()
voidemit_currentLoopChanged(int currentLoop)Emitter for signal void QAbstractAnimation::currentLoopChanged(int currentLoop)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QAbstractAnimation::destroyed(QObject *)
voidemit_directionChanged(const QAbstractAnimation_Direction arg1)Emitter for signal void QAbstractAnimation::directionChanged(QAbstractAnimation::Direction)
voidemit_finishedEmitter for signal void QAbstractAnimation::finished()
voidemit_objectNameChanged(string objectName)Emitter for signal void QAbstractAnimation::objectNameChanged(const QString &objectName)
voidemit_stateChanged(const QAbstractAnimation_State newState,
const QAbstractAnimation_State oldState)
Emitter for signal void QAbstractAnimation::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QAbstractAnimation::eventFilter(QObject *watched, QEvent *event)
[signal]voidfinishedSignal declaration for QAbstractAnimation::finished()
[const]QAnimationGroup ptrgroupMethod QAnimationGroup *QAbstractAnimation::group()
[const]intloopCountMethod int QAbstractAnimation::loopCount()
voidloopCount=(int loopCount)Method void QAbstractAnimation::setLoopCount(int loopCount)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QAbstractAnimation::objectNameChanged(const QString &objectName)
voidpauseMethod void QAbstractAnimation::pause()
voidresumeMethod void QAbstractAnimation::resume()
voidsetCurrentTime(int msecs)Method void QAbstractAnimation::setCurrentTime(int msecs)
voidsetDirection(const QAbstractAnimation_Direction direction)Method void QAbstractAnimation::setDirection(QAbstractAnimation::Direction direction)
voidsetLoopCount(int loopCount)Method void QAbstractAnimation::setLoopCount(int loopCount)
voidsetPaused(bool arg1)Method void QAbstractAnimation::setPaused(bool)
voidstart(const QAbstractAnimation_DeletionPolicy policy = QAbstractAnimation::KeepWhenStopped)Method void QAbstractAnimation::start(QAbstractAnimation::DeletionPolicy policy)
[const]QAbstractAnimation_StatestateMethod QAbstractAnimation::State QAbstractAnimation::state()
[signal]voidstateChanged(const QAbstractAnimation_State newState,
const QAbstractAnimation_State oldState)
Signal declaration for QAbstractAnimation::stateChanged(QAbstractAnimation::State newState, QAbstractAnimation::State oldState)
voidstopMethod void QAbstractAnimation::stop()
[const]inttotalDurationMethod int QAbstractAnimation::totalDuration()

Public static methods and constants

[static,const]QAbstractAnimation_DirectionBackwardEnum constant QAbstractAnimation::Backward
[static,const]QAbstractAnimation_DeletionPolicyDeleteWhenStoppedEnum constant QAbstractAnimation::DeleteWhenStopped
[static,const]QAbstractAnimation_DirectionForwardEnum constant QAbstractAnimation::Forward
[static,const]QAbstractAnimation_DeletionPolicyKeepWhenStoppedEnum constant QAbstractAnimation::KeepWhenStopped
[static,const]QAbstractAnimation_StatePausedEnum constant QAbstractAnimation::Paused
[static,const]QAbstractAnimation_StateRunningEnum constant QAbstractAnimation::Running
[static,const]QAbstractAnimation_StateStoppedEnum constant QAbstractAnimation::Stopped
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QAbstractAnimation::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QAbstractAnimation::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

Backward

Signature: [static,const] QAbstractAnimation_Direction Backward

Description: Enum constant QAbstractAnimation::Backward

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

DeleteWhenStopped

Signature: [static,const] QAbstractAnimation_DeletionPolicy DeleteWhenStopped

Description: Enum constant QAbstractAnimation::DeleteWhenStopped

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

Forward

Signature: [static,const] QAbstractAnimation_Direction Forward

Description: Enum constant QAbstractAnimation::Forward

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

KeepWhenStopped

Signature: [static,const] QAbstractAnimation_DeletionPolicy KeepWhenStopped

Description: Enum constant QAbstractAnimation::KeepWhenStopped

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

Paused

Signature: [static,const] QAbstractAnimation_State Paused

Description: Enum constant QAbstractAnimation::Paused

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

Running

Signature: [static,const] QAbstractAnimation_State Running

Description: Enum constant QAbstractAnimation::Running

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

Stopped

Signature: [static,const] QAbstractAnimation_State Stopped

Description: Enum constant QAbstractAnimation::Stopped

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

_const_cast

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

This method can be reimplemented in a derived class.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

currentLoop

Signature: [const] int currentLoop

Description: Method int QAbstractAnimation::currentLoop()

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

currentLoopChanged

Signature: [signal] void currentLoopChanged (int currentLoop)

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

currentLoopTime

Signature: [const] int currentLoopTime

Description: Method int QAbstractAnimation::currentLoopTime()

currentTime

Signature: [const] int currentTime

Description: Method int QAbstractAnimation::currentTime()

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

currentTime=

Signature: void currentTime= (int msecs)

Description: Method void QAbstractAnimation::setCurrentTime(int msecs)

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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: [signal] void destroyed (QObject ptr arg1)

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

direction

Signature: [const] QAbstractAnimation_Direction direction

Description: Method QAbstractAnimation::Direction QAbstractAnimation::direction()

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

direction=

Signature: void direction= (const QAbstractAnimation_Direction direction)

Description: Method void QAbstractAnimation::setDirection(QAbstractAnimation::Direction direction)

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

directionChanged

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

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

This method can be reimplemented in a derived class.

duration

Signature: [const] int duration

Description: Virtual method int QAbstractAnimation::duration()

This method can be reimplemented in a derived class.

emit_currentLoopChanged

Signature: void emit_currentLoopChanged (int currentLoop)

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

Call this method to emit this signal.

emit_directionChanged

Signature: void emit_directionChanged (const QAbstractAnimation_Direction arg1)

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

Call this method to emit this signal.

emit_finished

Signature: void emit_finished

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QAbstractAnimation::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 QAbstractAnimation::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 QAbstractAnimation::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 QAbstractAnimation::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

finished

Signature: [signal] void finished

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

group

Signature: [const] QAnimationGroup ptr group

Description: Method QAnimationGroup *QAbstractAnimation::group()

isSignalConnected

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

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

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

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

loopCount

Signature: [const] int loopCount

Description: Method int QAbstractAnimation::loopCount()

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

loopCount=

Signature: void loopCount= (int loopCount)

Description: Method void QAbstractAnimation::setLoopCount(int loopCount)

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

new

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

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

This method creates an object of class QAbstractAnimation.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

pause

Signature: void pause

Description: Method void QAbstractAnimation::pause()

receivers

Signature: [const] int receivers (string signal)

Description: Method int QAbstractAnimation::receivers(const char *signal)

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

resume

Signature: void resume

Description: Method void QAbstractAnimation::resume()

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QAbstractAnimation::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QAbstractAnimation::senderSignalIndex()

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

setCurrentTime

Signature: void setCurrentTime (int msecs)

Description: Method void QAbstractAnimation::setCurrentTime(int msecs)

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

setDirection

Signature: void setDirection (const QAbstractAnimation_Direction direction)

Description: Method void QAbstractAnimation::setDirection(QAbstractAnimation::Direction direction)

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

setLoopCount

Signature: void setLoopCount (int loopCount)

Description: Method void QAbstractAnimation::setLoopCount(int loopCount)

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

setPaused

Signature: void setPaused (bool arg1)

Description: Method void QAbstractAnimation::setPaused(bool)

start

Signature: void start (const QAbstractAnimation_DeletionPolicy policy = QAbstractAnimation::KeepWhenStopped)

Description: Method void QAbstractAnimation::start(QAbstractAnimation::DeletionPolicy policy)

state

Signature: [const] QAbstractAnimation_State state

Description: Method QAbstractAnimation::State QAbstractAnimation::state()

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

stateChanged

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

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

stop

Signature: void stop

Description: Method void QAbstractAnimation::stop()

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QAbstractAnimation::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

totalDuration

Signature: [const] int totalDuration

Description: Method int QAbstractAnimation::totalDuration()

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QAbstractAnimation::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 QAbstractAnimation::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 QAbstractAnimation::updateCurrentTime(int currentTime)

This method can be reimplemented in a derived class.

updateDirection

Signature: void updateDirection (const QAbstractAnimation_Direction direction)

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

This method can be reimplemented in a derived class.