API reference - Class QMimeData

Notation used in Ruby API documentation

Description: Binding of QMimeData

Class hierarchy: QMimeData » QObject

Public constructors

new QMimeDatanewConstructor QMimeData::QMimeData()

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.
voidclearMethod void QMimeData::clear()
[const]QVariantcolorDataMethod QVariant QMimeData::colorData()
voidcolorData=(const QVariant color)Method void QMimeData::setColorData(const QVariant &color)
[const]stringdata(string mimetype)Method QByteArray QMimeData::data(const QString &mimetype)
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QMimeData::destroyed(QObject *)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QMimeData::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QMimeData::eventFilter(QObject *, QEvent *)
[virtual,const]string[]formatsVirtual method QStringList QMimeData::formats()
[const]boolhasColorMethod bool QMimeData::hasColor()
[virtual,const]boolhasFormat(string mimetype)Virtual method bool QMimeData::hasFormat(const QString &mimetype)
[const]boolhasHtmlMethod bool QMimeData::hasHtml()
[const]boolhasImageMethod bool QMimeData::hasImage()
[const]boolhasTextMethod bool QMimeData::hasText()
[const]boolhasUrlsMethod bool QMimeData::hasUrls()
[const]stringhtmlMethod QString QMimeData::html()
[const]QVariantimageDataMethod QVariant QMimeData::imageData()
voidimageData=(const QVariant image)Method void QMimeData::setImageData(const QVariant &image)
voidremoveFormat(string mimetype)Method void QMimeData::removeFormat(const QString &mimetype)
voidsetColorData(const QVariant color)Method void QMimeData::setColorData(const QVariant &color)
voidsetData(string mimetype,
string data)
Method void QMimeData::setData(const QString &mimetype, const QByteArray &data)
voidsetHtml(string html)Method void QMimeData::setHtml(const QString &html)
voidsetImageData(const QVariant image)Method void QMimeData::setImageData(const QVariant &image)
voidsetText(string text)Method void QMimeData::setText(const QString &text)
voidsetUrls(QUrl[] urls)Method void QMimeData::setUrls(const QList<QUrl> &urls)
[const]stringtextMethod QString QMimeData::text()
[const]QUrl[]urlsMethod QList<QUrl> QMimeData::urls()

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = 0)
Static method QString QMimeData::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QMimeData::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QMimeData::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QMimeData::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QMimeData::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QMimeData::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QMimeData::disconnectNotify(const char *signal)
[const]intreceivers(string signal)Method int QMimeData::receivers(const char *signal)
[virtual,const]QVariantretrieveData(string mimetype,
const QVariant_Type preferredType)
Virtual method QVariant QMimeData::retrieveData(const QString &mimetype, QVariant::Type preferredType)
[const]QObject ptrsenderMethod QObject *QMimeData::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QMimeData::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

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 QMimeData::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

void clear

Description: Method void QMimeData::clear()

[const] QVariant colorData

Description: Method QVariant QMimeData::colorData()

Python specific notes:

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

void colorData=(const QVariant color)

Description: Method void QMimeData::setColorData(const QVariant &color)

Python specific notes:

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

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 QMimeData::customEvent(QEvent *)

This method can be reimplemented in a derived class.

[const] string data(string mimetype)

Description: Method QByteArray QMimeData::data(const QString &mimetype)

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 QMimeData::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 QMimeData::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

This method can be reimplemented in a derived class.

[virtual,const] string[] formats

Description: Virtual method QStringList QMimeData::formats()

This method can be reimplemented in a derived class.

[const] bool hasColor

Description: Method bool QMimeData::hasColor()

[virtual,const] bool hasFormat(string mimetype)

Description: Virtual method bool QMimeData::hasFormat(const QString &mimetype)

This method can be reimplemented in a derived class.

[const] bool hasHtml

Description: Method bool QMimeData::hasHtml()

[const] bool hasImage

Description: Method bool QMimeData::hasImage()

[const] bool hasText

Description: Method bool QMimeData::hasText()

[const] bool hasUrls

Description: Method bool QMimeData::hasUrls()

[const] string html

Description: Method QString QMimeData::html()

[const] QVariant imageData

Description: Method QVariant QMimeData::imageData()

Python specific notes:

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

void imageData=(const QVariant image)

Description: Method void QMimeData::setImageData(const QVariant &image)

Python specific notes:

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

[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

[static] new QMimeData new

Description: Constructor QMimeData::QMimeData()

This method creates an object of class QMimeData.

Python specific notes:

This method is the default initializer of the object

[const] int receivers(string signal)

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

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

void removeFormat(string mimetype)

Description: Method void QMimeData::removeFormat(const QString &mimetype)

[virtual,const] QVariant retrieveData(string mimetype,const QVariant_Type preferredType)

Description: Virtual method QVariant QMimeData::retrieveData(const QString &mimetype, QVariant::Type preferredType)

This method can be reimplemented in a derived class.

[const] QObject ptr sender

Description: Method QObject *QMimeData::sender()

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

void setColorData(const QVariant color)

Description: Method void QMimeData::setColorData(const QVariant &color)

Python specific notes:

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

void setData(string mimetype,string data)

Description: Method void QMimeData::setData(const QString &mimetype, const QByteArray &data)

void setHtml(string html)

Description: Method void QMimeData::setHtml(const QString &html)

void setImageData(const QVariant image)

Description: Method void QMimeData::setImageData(const QVariant &image)

Python specific notes:

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

void setText(string text)

Description: Method void QMimeData::setText(const QString &text)

void setUrls(QUrl[] urls)

Description: Method void QMimeData::setUrls(const QList<QUrl> &urls)

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[const] string text

Description: Method QString QMimeData::text()

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

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

[const] QUrl[] urls

Description: Method QList<QUrl> QMimeData::urls()