API reference - Class QTimeLine

Notation used in Ruby API documentation

Description: Binding of QTimeLine

Class hierarchy: QTimeLine » QObject

Sub-classes: CurveShape, Direction, State

Public constructors

new QTimeLinenew(int duration = 1000,
QObject ptr parent = 0)
Constructor QTimeLine::QTimeLine(int duration, 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.
[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)
[event]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)
[const]intendFrameMethod int QTimeLine::endFrame()
voidendFrame=(int frame)Method void QTimeLine::setEndFrame(int frame)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QTimeLine::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QTimeLine::eventFilter(QObject *, QEvent *)
[event]voidfinishedSignal declaration for QTimeLine::finished()
[event]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)
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()
[event]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)
[event]voidvalueChanged(double x)Signal declaration for QTimeLine::valueChanged(double x)
[virtual,const]doublevalueForTime(int msec)Virtual method double QTimeLine::valueForTime(int msec)

Public static methods and constants

[static,const]new QTimeLine_Direction ptrBackwardEnum constant QTimeLine::Backward
[static,const]new QTimeLine_CurveShape ptrCosineCurveEnum constant QTimeLine::CosineCurve
[static,const]new QTimeLine_CurveShape ptrEaseInCurveEnum constant QTimeLine::EaseInCurve
[static,const]new QTimeLine_CurveShape ptrEaseInOutCurveEnum constant QTimeLine::EaseInOutCurve
[static,const]new QTimeLine_CurveShape ptrEaseOutCurveEnum constant QTimeLine::EaseOutCurve
[static,const]new QTimeLine_Direction ptrForwardEnum constant QTimeLine::Forward
[static,const]new QTimeLine_CurveShape ptrLinearCurveEnum constant QTimeLine::LinearCurve
[static,const]new QTimeLine_State ptrNotRunningEnum constant QTimeLine::NotRunning
[static,const]new QTimeLine_State ptrPausedEnum constant QTimeLine::Paused
[static,const]new QTimeLine_State ptrRunningEnum constant QTimeLine::Running
[static,const]new QTimeLine_CurveShape ptrSineCurveEnum constant QTimeLine::SineCurve
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QTimeLine::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QTimeLine::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QTimeLine::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QTimeLine::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QTimeLine::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QTimeLine::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QTimeLine::disconnectNotify(const char *signal)
[const]intreceivers(string signal)Method int QTimeLine::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QTimeLine::sender()
[virtual]voidtimerEvent(QTimerEvent ptr event)Virtual method void QTimeLine::timerEvent(QTimerEvent *event)

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]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

[static,const] new QTimeLine_Direction ptr Backward

Description: Enum constant QTimeLine::Backward

[static,const] new QTimeLine_CurveShape ptr CosineCurve

Description: Enum constant QTimeLine::CosineCurve

[static,const] new QTimeLine_CurveShape ptr EaseInCurve

Description: Enum constant QTimeLine::EaseInCurve

[static,const] new QTimeLine_CurveShape ptr EaseInOutCurve

Description: Enum constant QTimeLine::EaseInOutCurve

[static,const] new QTimeLine_CurveShape ptr EaseOutCurve

Description: Enum constant QTimeLine::EaseOutCurve

[static,const] new QTimeLine_Direction ptr Forward

Description: Enum constant QTimeLine::Forward

[static,const] new QTimeLine_CurveShape ptr LinearCurve

Description: Enum constant QTimeLine::LinearCurve

[static,const] new QTimeLine_State ptr NotRunning

Description: Enum constant QTimeLine::NotRunning

[static,const] new QTimeLine_State ptr Paused

Description: Enum constant QTimeLine::Paused

[static,const] new QTimeLine_State ptr Running

Description: Enum constant QTimeLine::Running

[static,const] new QTimeLine_CurveShape ptr SineCurve

Description: Enum constant QTimeLine::SineCurve

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.

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.

[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.

[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.

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.

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.

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[const] int currentFrame

Description: Method int QTimeLine::currentFrame()

[const] int currentTime

Description: Method int QTimeLine::currentTime()

Python specific notes:

The object exposes a readable attribute 'currentTime'. This is the getter.

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.

[const] double currentValue

Description: Method double QTimeLine::currentValue()

[const] QTimeLine_CurveShape curveShape

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

Python specific notes:

The object exposes a readable attribute 'curveShape'. This is the getter.

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.

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

Description: Signal declaration for QTimeLine::destroyed(QObject *)

You can bind a procedure to this signal.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] QTimeLine_Direction direction

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

Python specific notes:

The object exposes a readable attribute 'direction'. This is the getter.

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.

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QTimeLine::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[const] int duration

Description: Method int QTimeLine::duration()

Python specific notes:

The object exposes a readable attribute 'duration'. This is the getter.

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.

[const] QEasingCurve easingCurve

Description: Method QEasingCurve QTimeLine::easingCurve()

Python specific notes:

The object exposes a readable attribute 'easingCurve'. This is the getter.

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.

[const] int endFrame

Description: Method int QTimeLine::endFrame()

Python specific notes:

The object exposes a readable attribute 'endFrame'. This is the getter.

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.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

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

This method can be reimplemented in a derived class.

[event] void finished

Description: Signal declaration for QTimeLine::finished()

You can bind a procedure to this signal.

[event] void frameChanged(int arg1)

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

You can bind a procedure to this signal.

[const] int frameForTime(int msec)

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

[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

[const] int loopCount

Description: Method int QTimeLine::loopCount()

Python specific notes:

The object exposes a readable attribute 'loopCount'. This is the getter.

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.

[static] new QTimeLine new(int duration = 1000,QObject ptr parent = 0)

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

[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.

void resume

Description: Method void QTimeLine::resume()

[const] QObject ptr sender

Description: Method QObject *QTimeLine::sender()

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

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.

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.

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.

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.

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.

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.

void setFrameRange(int startFrame,int endFrame)

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

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.

void setPaused(bool paused)

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

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.

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.

void start

Description: Method void QTimeLine::start()

[const] int startFrame

Description: Method int QTimeLine::startFrame()

Python specific notes:

The object exposes a readable attribute 'startFrame'. This is the getter.

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.

[const] QTimeLine_State state

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

[event] void stateChanged(const QTimeLine_State newState)

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

You can bind a procedure to this signal.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

void stop

Description: Method void QTimeLine::stop()

[virtual] void timerEvent(QTimerEvent ptr event)

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

This method can be reimplemented in a derived class.

void toggleDirection

Description: Method void QTimeLine::toggleDirection()

[static] string tr(string s,string c = 0)

Description: Static method QString QTimeLine::tr(const char *s, const char *c)

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

[static] string tr(string s,string c,int n)

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.

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QTimeLine::trUtf8(const char *s, const char *c)

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

[static] string trUtf8(string s,string c,int n)

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.

[const] int updateInterval

Description: Method int QTimeLine::updateInterval()

Python specific notes:

The object exposes a readable attribute 'updateInterval'. This is the getter.

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.

[event] void valueChanged(double x)

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

You can bind a procedure to this signal.

[virtual,const] double valueForTime(int msec)

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

This method can be reimplemented in a derived class.