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

API reference - Class QTimeLine

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QTimeLine

Class hierarchy: QTimeLine » QObject

Sub-classes: CurveShape, QFlags_CurveShape, Direction, QFlags_Direction, State, QFlags_State

Public constructors

new QTimeLinenew(int duration = 1000,
QObject ptr parent = nullptr)
Constructor QTimeLine::QTimeLine(int duration, QObject *parent)

Public methods

[const]QTimeLine 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]intcurrentFrameMethod int QTimeLine::currentFrame()
[const]intcurrentTimeMethod int QTimeLine::currentTime()
voidcurrentTime=(int msec)Method void QTimeLine::setCurrentTime(int msec)
[const]doublecurrentValueMethod double QTimeLine::currentValue()
[const]QTimeLine_CurveShapecurveShapeMethod QTimeLine::CurveShape QTimeLine::curveShape()
voidcurveShape=(const QTimeLine_CurveShape shape)Method void QTimeLine::setCurveShape(QTimeLine::CurveShape shape)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QTimeLine::destroyed(QObject *)
[const]QTimeLine_DirectiondirectionMethod QTimeLine::Direction QTimeLine::direction()
voiddirection=(const QTimeLine_Direction direction)Method void QTimeLine::setDirection(QTimeLine::Direction direction)
[const]intdurationMethod int QTimeLine::duration()
voidduration=(int duration)Method void QTimeLine::setDuration(int duration)
[const]QEasingCurveeasingCurveMethod QEasingCurve QTimeLine::easingCurve()
voideasingCurve=(const QEasingCurve curve)Method void QTimeLine::setEasingCurve(const QEasingCurve &curve)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QTimeLine::destroyed(QObject *)
voidemit_finishedEmitter for signal void QTimeLine::finished()
voidemit_frameChanged(int arg1)Emitter for signal void QTimeLine::frameChanged(int)
voidemit_objectNameChanged(string objectName)Emitter for signal void QTimeLine::objectNameChanged(const QString &objectName)
voidemit_stateChanged(const QTimeLine_State newState)Emitter for signal void QTimeLine::stateChanged(QTimeLine::State newState)
voidemit_valueChanged(double x)Emitter for signal void QTimeLine::valueChanged(double x)
[const]intendFrameMethod int QTimeLine::endFrame()
voidendFrame=(int frame)Method void QTimeLine::setEndFrame(int frame)
boolevent(QEvent ptr event)Virtual method bool QTimeLine::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QTimeLine::eventFilter(QObject *watched, QEvent *event)
[signal]voidfinishedSignal declaration for QTimeLine::finished()
[signal]voidframeChanged(int arg1)Signal declaration for QTimeLine::frameChanged(int)
[const]intframeForTime(int msec)Method int QTimeLine::frameForTime(int msec)
[const]intloopCountMethod int QTimeLine::loopCount()
voidloopCount=(int count)Method void QTimeLine::setLoopCount(int count)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QTimeLine::objectNameChanged(const QString &objectName)
voidresumeMethod void QTimeLine::resume()
voidsetCurrentTime(int msec)Method void QTimeLine::setCurrentTime(int msec)
voidsetCurveShape(const QTimeLine_CurveShape shape)Method void QTimeLine::setCurveShape(QTimeLine::CurveShape shape)
voidsetDirection(const QTimeLine_Direction direction)Method void QTimeLine::setDirection(QTimeLine::Direction direction)
voidsetDuration(int duration)Method void QTimeLine::setDuration(int duration)
voidsetEasingCurve(const QEasingCurve curve)Method void QTimeLine::setEasingCurve(const QEasingCurve &curve)
voidsetEndFrame(int frame)Method void QTimeLine::setEndFrame(int frame)
voidsetFrameRange(int startFrame,
int endFrame)
Method void QTimeLine::setFrameRange(int startFrame, int endFrame)
voidsetLoopCount(int count)Method void QTimeLine::setLoopCount(int count)
voidsetPaused(bool paused)Method void QTimeLine::setPaused(bool paused)
voidsetStartFrame(int frame)Method void QTimeLine::setStartFrame(int frame)
voidsetUpdateInterval(int interval)Method void QTimeLine::setUpdateInterval(int interval)
voidstartMethod void QTimeLine::start()
[const]intstartFrameMethod int QTimeLine::startFrame()
voidstartFrame=(int frame)Method void QTimeLine::setStartFrame(int frame)
[const]QTimeLine_StatestateMethod QTimeLine::State QTimeLine::state()
[signal]voidstateChanged(const QTimeLine_State newState)Signal declaration for QTimeLine::stateChanged(QTimeLine::State newState)
voidstopMethod void QTimeLine::stop()
voidtoggleDirectionMethod void QTimeLine::toggleDirection()
[const]intupdateIntervalMethod int QTimeLine::updateInterval()
voidupdateInterval=(int interval)Method void QTimeLine::setUpdateInterval(int interval)
[signal]voidvalueChanged(double x)Signal declaration for QTimeLine::valueChanged(double x)
[const]doublevalueForTime(int msec)Virtual method double QTimeLine::valueForTime(int msec)

Public static methods and constants

[static,const]QTimeLine_DirectionBackwardEnum constant QTimeLine::Backward
[static,const]QTimeLine_CurveShapeCosineCurveEnum constant QTimeLine::CosineCurve
[static,const]QTimeLine_CurveShapeEaseInCurveEnum constant QTimeLine::EaseInCurve
[static,const]QTimeLine_CurveShapeEaseInOutCurveEnum constant QTimeLine::EaseInOutCurve
[static,const]QTimeLine_CurveShapeEaseOutCurveEnum constant QTimeLine::EaseOutCurve
[static,const]QTimeLine_DirectionForwardEnum constant QTimeLine::Forward
[static,const]QTimeLine_CurveShapeLinearCurveEnum constant QTimeLine::LinearCurve
[static,const]QTimeLine_StateNotRunningEnum constant QTimeLine::NotRunning
[static,const]QTimeLine_StatePausedEnum constant QTimeLine::Paused
[static,const]QTimeLine_StateRunningEnum constant QTimeLine::Running
[static,const]QTimeLine_CurveShapeSineCurveEnum constant QTimeLine::SineCurve
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QTimeLine::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QTimeLine::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

Detailed description

Backward

Signature: [static,const] QTimeLine_Direction Backward

Description: Enum constant QTimeLine::Backward

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

CosineCurve

Signature: [static,const] QTimeLine_CurveShape CosineCurve

Description: Enum constant QTimeLine::CosineCurve

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

EaseInCurve

Signature: [static,const] QTimeLine_CurveShape EaseInCurve

Description: Enum constant QTimeLine::EaseInCurve

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

EaseInOutCurve

Signature: [static,const] QTimeLine_CurveShape EaseInOutCurve

Description: Enum constant QTimeLine::EaseInOutCurve

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

EaseOutCurve

Signature: [static,const] QTimeLine_CurveShape EaseOutCurve

Description: Enum constant QTimeLine::EaseOutCurve

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

Forward

Signature: [static,const] QTimeLine_Direction Forward

Description: Enum constant QTimeLine::Forward

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

LinearCurve

Signature: [static,const] QTimeLine_CurveShape LinearCurve

Description: Enum constant QTimeLine::LinearCurve

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

NotRunning

Signature: [static,const] QTimeLine_State NotRunning

Description: Enum constant QTimeLine::NotRunning

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

Paused

Signature: [static,const] QTimeLine_State Paused

Description: Enum constant QTimeLine::Paused

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

Running

Signature: [static,const] QTimeLine_State Running

Description: Enum constant QTimeLine::Running

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

SineCurve

Signature: [static,const] QTimeLine_CurveShape SineCurve

Description: Enum constant QTimeLine::SineCurve

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

_const_cast

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

This method can be reimplemented in a derived class.

currentFrame

Signature: [const] int currentFrame

Description: Method int QTimeLine::currentFrame()

currentTime

Signature: [const] int currentTime

Description: Method int QTimeLine::currentTime()

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

currentTime=

Signature: void currentTime= (int msec)

Description: Method void QTimeLine::setCurrentTime(int msec)

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

currentValue

Signature: [const] double currentValue

Description: Method double QTimeLine::currentValue()

curveShape

Signature: [const] QTimeLine_CurveShape curveShape

Description: Method QTimeLine::CurveShape QTimeLine::curveShape()

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

curveShape=

Signature: void curveShape= (const QTimeLine_CurveShape shape)

Description: Method void QTimeLine::setCurveShape(QTimeLine::CurveShape shape)

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QTimeLine::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] QTimeLine_Direction direction

Description: Method QTimeLine::Direction QTimeLine::direction()

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

direction=

Signature: void direction= (const QTimeLine_Direction direction)

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

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

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

This method can be reimplemented in a derived class.

duration

Signature: [const] int duration

Description: Method int QTimeLine::duration()

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

duration=

Signature: void duration= (int duration)

Description: Method void QTimeLine::setDuration(int duration)

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

easingCurve

Signature: [const] QEasingCurve easingCurve

Description: Method QEasingCurve QTimeLine::easingCurve()

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

easingCurve=

Signature: void easingCurve= (const QEasingCurve curve)

Description: Method void QTimeLine::setEasingCurve(const QEasingCurve &curve)

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

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_finished

Signature: void emit_finished

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

Call this method to emit this signal.

emit_frameChanged

Signature: void emit_frameChanged (int arg1)

Description: Emitter for signal void QTimeLine::frameChanged(int)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_stateChanged

Signature: void emit_stateChanged (const QTimeLine_State newState)

Description: Emitter for signal void QTimeLine::stateChanged(QTimeLine::State newState)

Call this method to emit this signal.

emit_valueChanged

Signature: void emit_valueChanged (double x)

Description: Emitter for signal void QTimeLine::valueChanged(double x)

Call this method to emit this signal.

endFrame

Signature: [const] int endFrame

Description: Method int QTimeLine::endFrame()

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

endFrame=

Signature: void endFrame= (int frame)

Description: Method void QTimeLine::setEndFrame(int frame)

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

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

finished

Signature: [signal] void finished

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

frameChanged

Signature: [signal] void frameChanged (int arg1)

Description: Signal declaration for QTimeLine::frameChanged(int)

You can bind a procedure to this signal.

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

frameForTime

Signature: [const] int frameForTime (int msec)

Description: Method int QTimeLine::frameForTime(int msec)

isSignalConnected

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

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

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

loopCount

Signature: [const] int loopCount

Description: Method int QTimeLine::loopCount()

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

loopCount=

Signature: void loopCount= (int count)

Description: Method void QTimeLine::setLoopCount(int count)

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

new

Signature: [static] new QTimeLine new (int duration = 1000, QObject ptr parent = nullptr)

Description: Constructor QTimeLine::QTimeLine(int duration, QObject *parent)

This method creates an object of class QTimeLine.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QTimeLine::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 QTimeLine::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 QTimeLine::resume()

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QTimeLine::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QTimeLine::senderSignalIndex()

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

setCurrentTime

Signature: void setCurrentTime (int msec)

Description: Method void QTimeLine::setCurrentTime(int msec)

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

setCurveShape

Signature: void setCurveShape (const QTimeLine_CurveShape shape)

Description: Method void QTimeLine::setCurveShape(QTimeLine::CurveShape shape)

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

setDirection

Signature: void setDirection (const QTimeLine_Direction direction)

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

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

setDuration

Signature: void setDuration (int duration)

Description: Method void QTimeLine::setDuration(int duration)

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

setEasingCurve

Signature: void setEasingCurve (const QEasingCurve curve)

Description: Method void QTimeLine::setEasingCurve(const QEasingCurve &curve)

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

setEndFrame

Signature: void setEndFrame (int frame)

Description: Method void QTimeLine::setEndFrame(int frame)

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

setFrameRange

Signature: void setFrameRange (int startFrame, int endFrame)

Description: Method void QTimeLine::setFrameRange(int startFrame, int endFrame)

setLoopCount

Signature: void setLoopCount (int count)

Description: Method void QTimeLine::setLoopCount(int count)

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

setPaused

Signature: void setPaused (bool paused)

Description: Method void QTimeLine::setPaused(bool paused)

setStartFrame

Signature: void setStartFrame (int frame)

Description: Method void QTimeLine::setStartFrame(int frame)

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

setUpdateInterval

Signature: void setUpdateInterval (int interval)

Description: Method void QTimeLine::setUpdateInterval(int interval)

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

start

Signature: void start

Description: Method void QTimeLine::start()

startFrame

Signature: [const] int startFrame

Description: Method int QTimeLine::startFrame()

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

startFrame=

Signature: void startFrame= (int frame)

Description: Method void QTimeLine::setStartFrame(int frame)

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

state

Signature: [const] QTimeLine_State state

Description: Method QTimeLine::State QTimeLine::state()

stateChanged

Signature: [signal] void stateChanged (const QTimeLine_State newState)

Description: Signal declaration for QTimeLine::stateChanged(QTimeLine::State newState)

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 QTimeLine::stop()

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

This method can be reimplemented in a derived class.

toggleDirection

Signature: void toggleDirection

Description: Method void QTimeLine::toggleDirection()

tr

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

Description: Static method QString QTimeLine::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 QTimeLine::trUtf8(const char *s, const char *c, int n)

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

updateInterval

Signature: [const] int updateInterval

Description: Method int QTimeLine::updateInterval()

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

updateInterval=

Signature: void updateInterval= (int interval)

Description: Method void QTimeLine::setUpdateInterval(int interval)

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

valueChanged

Signature: [signal] void valueChanged (double x)

Description: Signal declaration for QTimeLine::valueChanged(double x)

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.

valueForTime

Signature: [const] double valueForTime (int msec)

Description: Virtual method double QTimeLine::valueForTime(int msec)

This method can be reimplemented in a derived class.