API reference - Class QImageIOPlugin

Notation used in Ruby API documentation

Description: Binding of QImageIOPlugin

Class hierarchy: QImageIOPlugin » QObject

Sub-classes: Capability

Public constructors

new QImageIOPluginnew(QObject ptr parent = 0)Constructor QImageIOPlugin::QImageIOPlugin(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.
[virtual,const]QImageIOPlugin_QFlags_Capabilitycapabilities(QIODevice ptr device,
string format)
Virtual method QFlags<QImageIOPlugin::Capability> QImageIOPlugin::capabilities(QIODevice *device, const QByteArray &format)
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QImageIOPlugin::destroyed(QObject *)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QImageIOPlugin::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QImageIOPlugin::eventFilter(QObject *, QEvent *)
[virtual,const]string[]keysVirtual method QStringList QImageIOPlugin::keys()
[virtual,const]QImageIOHandler ptrqt_create(QIODevice ptr device,
string format)
Virtual method QImageIOHandler *QImageIOPlugin::create(QIODevice *device, const QByteArray &format)

Public static methods and constants

[static,const]new QImageIOPlugin_Capability ptrCanReadEnum constant QImageIOPlugin::CanRead
[static,const]new QImageIOPlugin_Capability ptrCanReadIncrementalEnum constant QImageIOPlugin::CanReadIncremental
[static,const]new QImageIOPlugin_Capability ptrCanWriteEnum constant QImageIOPlugin::CanWrite
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QImageIOPlugin::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QImageIOPlugin::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QImageIOPlugin::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QImageIOPlugin::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QImageIOPlugin::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QImageIOPlugin::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QImageIOPlugin::disconnectNotify(const char *signal)
[const]intreceivers(string signal)Method int QImageIOPlugin::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QImageIOPlugin::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QImageIOPlugin::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 QImageIOPlugin_Capability ptr CanRead

Description: Enum constant QImageIOPlugin::CanRead

[static,const] new QImageIOPlugin_Capability ptr CanReadIncremental

Description: Enum constant QImageIOPlugin::CanReadIncremental

[static,const] new QImageIOPlugin_Capability ptr CanWrite

Description: Enum constant QImageIOPlugin::CanWrite

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,const] QImageIOPlugin_QFlags_Capability capabilities(QIODevice ptr device,string format)

Description: Virtual method QFlags<QImageIOPlugin::Capability> QImageIOPlugin::capabilities(QIODevice *device, const QByteArray &format)

This method can be reimplemented in a derived class.

[virtual] void childEvent(QChildEvent ptr arg1)

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

[virtual] void customEvent(QEvent ptr arg1)

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

[virtual] void disconnectNotify(string signal)

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

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

This method can be reimplemented in a derived class.

[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

[virtual,const] string[] keys

Description: Virtual method QStringList QImageIOPlugin::keys()

This method can be reimplemented in a derived class.

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

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

This method creates an object of class QImageIOPlugin.

Python specific notes:

This method is the default initializer of the object

[virtual,const] QImageIOHandler ptr qt_create(QIODevice ptr device,string format)

Description: Virtual method QImageIOHandler *QImageIOPlugin::create(QIODevice *device, const QByteArray &format)

This method can be reimplemented in a derived class.

[const] int receivers(string signal)

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

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

[const] QObject ptr sender

Description: Method QObject *QImageIOPlugin::sender()

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

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

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