API reference - Class QMovie

Notation used in Ruby API documentation

Description: Binding of QMovie

Class hierarchy: QMovie » QObject

Sub-classes: CacheMode, MovieState

Public constructors

new QMovienew(QObject ptr parent = 0)Constructor QMovie::QMovie(QObject *parent)
new QMovienew(QIODevice ptr device,
string format = QByteArray(),
QObject ptr parent = 0)
Constructor QMovie::QMovie(QIODevice *device, const QByteArray &format, QObject *parent)
new QMovienew(string fileName,
string format = QByteArray(),
QObject ptr parent = 0)
Constructor QMovie::QMovie(const QString &fileName, const QByteArray &format, 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]QColorbackgroundColorMethod QColor QMovie::backgroundColor()
voidbackgroundColor=(const QColor color)Method void QMovie::setBackgroundColor(const QColor &color)
[const]QMovie_CacheModecacheModeMethod QMovie::CacheMode QMovie::cacheMode()
QMovie_CacheModecacheModeMethod QMovie::CacheMode QMovie::cacheMode()
voidcacheMode=(const QMovie_CacheMode mode)Method void QMovie::setCacheMode(QMovie::CacheMode mode)
[const]intcurrentFrameNumberMethod int QMovie::currentFrameNumber()
[const]QImagecurrentImageMethod QImage QMovie::currentImage()
[const]QPixmapcurrentPixmapMethod QPixmap QMovie::currentPixmap()
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QMovie::destroyed(QObject *)
[const]QIODevice ptrdeviceMethod QIODevice *QMovie::device()
voiddevice=(QIODevice ptr device)Method void QMovie::setDevice(QIODevice *device)
[event]voiderror(const QImageReader_ImageReaderError error)Signal declaration for QMovie::error(QImageReader::ImageReaderError error)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QMovie::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QMovie::eventFilter(QObject *, QEvent *)
[const]stringfileNameMethod QString QMovie::fileName()
voidfileName=(string fileName)Method void QMovie::setFileName(const QString &fileName)
[event]voidfinishedSignal declaration for QMovie::finished()
[const]stringformatMethod QByteArray QMovie::format()
voidformat=(string format)Method void QMovie::setFormat(const QByteArray &format)
[event]voidframeChanged(int frameNumber)Signal declaration for QMovie::frameChanged(int frameNumber)
[const]intframeCountMethod int QMovie::frameCount()
[const]QRectframeRectMethod QRect QMovie::frameRect()
[const]boolisValid?Method bool QMovie::isValid()
booljumpToFrame(int frameNumber)Method bool QMovie::jumpToFrame(int frameNumber)
booljumpToNextFrameMethod bool QMovie::jumpToNextFrame()
[const]intloopCountMethod int QMovie::loopCount()
[const]intnextFrameDelayMethod int QMovie::nextFrameDelay()
[event]voidresized(const QSize size)Signal declaration for QMovie::resized(const QSize &size)
QSizescaledSizeMethod QSize QMovie::scaledSize()
voidscaledSize=(const QSize size)Method void QMovie::setScaledSize(const QSize &size)
voidsetBackgroundColor(const QColor color)Method void QMovie::setBackgroundColor(const QColor &color)
voidsetCacheMode(const QMovie_CacheMode mode)Method void QMovie::setCacheMode(QMovie::CacheMode mode)
voidsetDevice(QIODevice ptr device)Method void QMovie::setDevice(QIODevice *device)
voidsetFileName(string fileName)Method void QMovie::setFileName(const QString &fileName)
voidsetFormat(string format)Method void QMovie::setFormat(const QByteArray &format)
voidsetPaused(bool paused)Method void QMovie::setPaused(bool paused)
voidsetScaledSize(const QSize size)Method void QMovie::setScaledSize(const QSize &size)
voidsetSpeed(int percentSpeed)Method void QMovie::setSpeed(int percentSpeed)
[const]intspeedMethod int QMovie::speed()
voidspeed=(int percentSpeed)Method void QMovie::setSpeed(int percentSpeed)
voidstartMethod void QMovie::start()
[event]voidstartedSignal declaration for QMovie::started()
[const]QMovie_MovieStatestateMethod QMovie::MovieState QMovie::state()
[event]voidstateChanged(const QMovie_MovieState state)Signal declaration for QMovie::stateChanged(QMovie::MovieState state)
voidstopMethod void QMovie::stop()
[event]voidupdated(const QRect rect)Signal declaration for QMovie::updated(const QRect &rect)

Public static methods and constants

[static,const]new QMovie_CacheMode ptrCacheAllEnum constant QMovie::CacheAll
[static,const]new QMovie_CacheMode ptrCacheNoneEnum constant QMovie::CacheNone
[static,const]new QMovie_MovieState ptrNotRunningEnum constant QMovie::NotRunning
[static,const]new QMovie_MovieState ptrPausedEnum constant QMovie::Paused
[static,const]new QMovie_MovieState ptrRunningEnum constant QMovie::Running
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
string[]supportedFormatsStatic method QList<QByteArray> QMovie::supportedFormats()
stringtr(string s,
string c = 0)
Static method QString QMovie::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QMovie::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QMovie::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QMovie::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

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

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 QMovie_CacheMode ptr CacheAll

Description: Enum constant QMovie::CacheAll

[static,const] new QMovie_CacheMode ptr CacheNone

Description: Enum constant QMovie::CacheNone

[static,const] new QMovie_MovieState ptr NotRunning

Description: Enum constant QMovie::NotRunning

[static,const] new QMovie_MovieState ptr Paused

Description: Enum constant QMovie::Paused

[static,const] new QMovie_MovieState ptr Running

Description: Enum constant QMovie::Running

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.

[const] QColor backgroundColor

Description: Method QColor QMovie::backgroundColor()

Python specific notes:

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

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.

[const] QMovie_CacheMode cacheMode

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

Python specific notes:

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

QMovie_CacheMode cacheMode

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

Python specific notes:

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

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.

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QMovie::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 currentFrameNumber

Description: Method int QMovie::currentFrameNumber()

[const] QImage currentImage

Description: Method QImage QMovie::currentImage()

[const] QPixmap currentPixmap

Description: Method QPixmap QMovie::currentPixmap()

[virtual] void customEvent(QEvent ptr arg1)

Description: Virtual method void QMovie::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 QMovie::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] QIODevice ptr device

Description: Method QIODevice *QMovie::device()

Python specific notes:

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

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.

[virtual] void disconnectNotify(string signal)

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

This method can be reimplemented in a derived class.

[event] void error(const QImageReader_ImageReaderError error)

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

You can bind a procedure to this signal.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

This method can be reimplemented in a derived class.

[const] string fileName

Description: Method QString QMovie::fileName()

Python specific notes:

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

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.

[event] void finished

Description: Signal declaration for QMovie::finished()

You can bind a procedure to this signal.

[const] string format

Description: Method QByteArray QMovie::format()

Python specific notes:

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

void format=(string format)

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

Python specific notes:

The object exposes a writable attribute 'format'. This is the setter.

[event] void frameChanged(int frameNumber)

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

You can bind a procedure to this signal.

[const] int frameCount

Description: Method int QMovie::frameCount()

[const] QRect frameRect

Description: Method QRect QMovie::frameRect()

[const] bool isValid?

Description: Method bool QMovie::isValid()

[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

bool jumpToFrame(int frameNumber)

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

bool jumpToNextFrame

Description: Method bool QMovie::jumpToNextFrame()

[const] int loopCount

Description: Method int QMovie::loopCount()

[static] new QMovie new(QObject ptr parent = 0)

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

[static] new QMovie new(QIODevice ptr device,string format = QByteArray(),QObject ptr parent = 0)

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

[static] new QMovie new(string fileName,string format = QByteArray(),QObject ptr parent = 0)

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

[const] int nextFrameDelay

Description: Method int QMovie::nextFrameDelay()

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

[event] void resized(const QSize size)

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

You can bind a procedure to this signal.

QSize scaledSize

Description: Method QSize QMovie::scaledSize()

Python specific notes:

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

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.

[const] QObject ptr sender

Description: Method QObject *QMovie::sender()

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

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.

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.

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.

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.

void setFormat(string format)

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

Python specific notes:

The object exposes a writable attribute 'format'. This is the setter.

void setPaused(bool paused)

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

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.

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.

[const] int speed

Description: Method int QMovie::speed()

Python specific notes:

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

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.

void start

Description: Method void QMovie::start()

[event] void started

Description: Signal declaration for QMovie::started()

You can bind a procedure to this signal.

[const] QMovie_MovieState state

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

[event] void stateChanged(const QMovie_MovieState state)

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

You can bind a procedure to this signal.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

void stop

Description: Method void QMovie::stop()

[static] string[] supportedFormats

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

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

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QMovie::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

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

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

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

[event] void updated(const QRect rect)

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

You can bind a procedure to this signal.