API reference - Class QMovie

CacheAll

Signature: [static,const] QMovie_CacheMode CacheAll

Description: Enum constant QMovie::CacheAll

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

CacheNone

Signature: [static,const] QMovie_CacheMode CacheNone

Description: Enum constant QMovie::CacheNone

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

NotRunning

Signature: [static,const] QMovie_MovieState NotRunning

Description: Enum constant QMovie::NotRunning

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

Paused

Signature: [static,const] QMovie_MovieState Paused

Description: Enum constant QMovie::Paused

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

Running

Signature: [static,const] QMovie_MovieState Running

Description: Enum constant QMovie::Running

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

_const_cast

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

backgroundColor

Signature: [const] QColor backgroundColor

Description: Method QColor QMovie::backgroundColor()

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

backgroundColor=

Signature: void backgroundColor= (const QColor color)

Description: Method void QMovie::setBackgroundColor(const QColor &color)

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

cacheMode

Signature: [const] QMovie_CacheMode cacheMode

Description: Method QMovie::CacheMode QMovie::cacheMode()

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

cacheMode=

Signature: void cacheMode= (const QMovie_CacheMode mode)

Description: Method void QMovie::setCacheMode(QMovie::CacheMode mode)

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

currentFrameNumber

Signature: [const] int currentFrameNumber

Description: Method int QMovie::currentFrameNumber()

currentImage

Signature: [const] QImage currentImage

Description: Method QImage QMovie::currentImage()

currentPixmap

Signature: [const] QPixmap currentPixmap

Description: Method QPixmap QMovie::currentPixmap()

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

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

device

Signature: [const] QIODevice ptr device

Description: Method QIODevice *QMovie::device()

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

device=

Signature: void device= (QIODevice ptr device)

Description: Method void QMovie::setDevice(QIODevice *device)

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

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

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_error

Signature: void emit_error (const QImageReader_ImageReaderError error)

Description: Emitter for signal void QMovie::error(QImageReader::ImageReaderError error)

Call this method to emit this signal.

emit_finished

Signature: void emit_finished

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

Call this method to emit this signal.

emit_frameChanged

Signature: void emit_frameChanged (int frameNumber)

Description: Emitter for signal void QMovie::frameChanged(int frameNumber)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_resized

Signature: void emit_resized (const QSize size)

Description: Emitter for signal void QMovie::resized(const QSize &size)

Call this method to emit this signal.

emit_started

Signature: void emit_started

Description: Emitter for signal void QMovie::started()

Call this method to emit this signal.

emit_stateChanged

Signature: void emit_stateChanged (const QMovie_MovieState state)

Description: Emitter for signal void QMovie::stateChanged(QMovie::MovieState state)

Call this method to emit this signal.

emit_updated

Signature: void emit_updated (const QRect rect)

Description: Emitter for signal void QMovie::updated(const QRect &rect)

Call this method to emit this signal.

error

Signature: [signal] void error (const QImageReader_ImageReaderError error)

Description: Signal declaration for QMovie::error(QImageReader::ImageReaderError error)

You can bind a procedure to this signal.

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

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

fileName

Signature: [const] string fileName

Description: Method QString QMovie::fileName()

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

fileName=

Signature: void fileName= (string fileName)

Description: Method void QMovie::setFileName(const QString &fileName)

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

finished

Signature: [signal] void finished

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

format

Signature: [const] bytes format

Description: Method QByteArray QMovie::format()

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

format=

Signature: void format= (bytes format)

Description: Method void QMovie::setFormat(const QByteArray &format)

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

frameChanged

Signature: [signal] void frameChanged (int frameNumber)

Description: Signal declaration for QMovie::frameChanged(int frameNumber)

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.

frameCount

Signature: [const] int frameCount

Description: Method int QMovie::frameCount()

frameRect

Signature: [const] QRect frameRect

Description: Method QRect QMovie::frameRect()

isSignalConnected

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

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

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

isValid?

Signature: [const] bool isValid?

Description: Method bool QMovie::isValid()

jumpToFrame

Signature: bool jumpToFrame (int frameNumber)

Description: Method bool QMovie::jumpToFrame(int frameNumber)

jumpToNextFrame

Signature: bool jumpToNextFrame

Description: Method bool QMovie::jumpToNextFrame()

lastError

Signature: [const] QImageReader_ImageReaderError lastError

Description: Method QImageReader::ImageReaderError QMovie::lastError()

lastErrorString

Signature: [const] string lastErrorString

Description: Method QString QMovie::lastErrorString()

loopCount

Signature: [const] int loopCount

Description: Method int QMovie::loopCount()

new

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

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

This method creates an object of class QMovie.

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

(2) Signature: [static] new QMovie new (QIODevice ptr device, bytes format = QByteArray(), QObject ptr parent = nullptr)

Description: Constructor QMovie::QMovie(QIODevice *device, const QByteArray &format, QObject *parent)

This method creates an object of class QMovie.

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

(3) Signature: [static] new QMovie new (string fileName, bytes format = QByteArray(), QObject ptr parent = nullptr)

Description: Constructor QMovie::QMovie(const QString &fileName, const QByteArray &format, QObject *parent)

This method creates an object of class QMovie.

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

nextFrameDelay

Signature: [const] int nextFrameDelay

Description: Method int QMovie::nextFrameDelay()

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

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

resized

Signature: [signal] void resized (const QSize size)

Description: Signal declaration for QMovie::resized(const QSize &size)

You can bind a procedure to this signal.

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

scaledSize

Signature: QSize scaledSize

Description: Method QSize QMovie::scaledSize()

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

scaledSize=

Signature: void scaledSize= (const QSize size)

Description: Method void QMovie::setScaledSize(const QSize &size)

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QMovie::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QMovie::senderSignalIndex()

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

setBackgroundColor

Signature: void setBackgroundColor (const QColor color)

Description: Method void QMovie::setBackgroundColor(const QColor &color)

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

setCacheMode

Signature: void setCacheMode (const QMovie_CacheMode mode)

Description: Method void QMovie::setCacheMode(QMovie::CacheMode mode)

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

setDevice

Signature: void setDevice (QIODevice ptr device)

Description: Method void QMovie::setDevice(QIODevice *device)

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

setFileName

Signature: void setFileName (string fileName)

Description: Method void QMovie::setFileName(const QString &fileName)

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

setFormat

Signature: void setFormat (bytes format)

Description: Method void QMovie::setFormat(const QByteArray &format)

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

setPaused

Signature: void setPaused (bool paused)

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

setScaledSize

Signature: void setScaledSize (const QSize size)

Description: Method void QMovie::setScaledSize(const QSize &size)

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

setSpeed

Signature: void setSpeed (int percentSpeed)

Description: Method void QMovie::setSpeed(int percentSpeed)

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

speed

Signature: [const] int speed

Description: Method int QMovie::speed()

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

speed=

Signature: void speed= (int percentSpeed)

Description: Method void QMovie::setSpeed(int percentSpeed)

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

start

Signature: void start

Description: Method void QMovie::start()

started

Signature: [signal] void started

Description: Signal declaration for QMovie::started()

You can bind a procedure to this signal.

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

state

Signature: [const] QMovie_MovieState state

Description: Method QMovie::MovieState QMovie::state()

stateChanged

Signature: [signal] void stateChanged (const QMovie_MovieState state)

Description: Signal declaration for QMovie::stateChanged(QMovie::MovieState state)

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

supportedFormats

Signature: [static] bytes[] supportedFormats

Description: Static method QList<QByteArray> QMovie::supportedFormats()

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QMovie::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 QMovie::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 QMovie::trUtf8(const char *s, const char *c, int n)

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

updated

Signature: [signal] void updated (const QRect rect)

Description: Signal declaration for QMovie::updated(const QRect &rect)

You can bind a procedure to this signal.

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