API reference - Class QMimeData

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QMimeData

Class hierarchy: QMimeData » QObject

Public constructors

new QMimeDatanewConstructor QMimeData::QMimeData()

Public methods

[const]QMimeData ptr_const_castReturns a non-const reference to self.
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]variantcolorDataMethod QVariant QMimeData::colorData()
voidcolorData=(variant color)Method void QMimeData::setColorData(const QVariant &color)
[const]bytesdata(string mimetype)Method QByteArray QMimeData::data(const QString &mimetype)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QMimeData::destroyed(QObject *)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QMimeData::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QMimeData::objectNameChanged(const QString &objectName)
boolevent(QEvent ptr event)Virtual method bool QMimeData::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QMimeData::eventFilter(QObject *watched, QEvent *event)
[const]string[]formatsVirtual method QStringList QMimeData::formats()
[const]boolhasColorMethod bool QMimeData::hasColor()
[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]variantimageDataMethod QVariant QMimeData::imageData()
voidimageData=(variant image)Method void QMimeData::setImageData(const QVariant &image)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QMimeData::objectNameChanged(const QString &objectName)
voidremoveFormat(string mimetype)Method void QMimeData::removeFormat(const QString &mimetype)
voidsetColorData(variant color)Method void QMimeData::setColorData(const QVariant &color)
voidsetData(string mimetype,
bytes data)
Method void QMimeData::setData(const QString &mimetype, const QByteArray &data)
voidsetHtml(string html)Method void QMimeData::setHtml(const QString &html)
voidsetImageData(variant 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 = nullptr,
int n = -1)
Static method QString QMimeData::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QMimeData::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QMimeData::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QMimeData::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QMimeData::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QMimeData::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QMimeData::receivers(const char *signal)
[const]variantretrieveData(string mimetype,
const QVariant_Type preferredType)
Virtual method QVariant QMimeData::retrieveData(const QString &mimetype, QVariant::Type preferredType)
[const]QObject ptrsenderMethod QObject *QMimeData::sender()
[const]intsenderSignalIndexMethod int QMimeData::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QMimeData::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]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

_const_cast

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

clear

Signature: void clear

Description: Method void QMimeData::clear()

colorData

Signature: [const] variant colorData

Description: Method QVariant QMimeData::colorData()

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

colorData=

Signature: void colorData= (variant color)

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

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

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

data

Signature: [const] bytes data (string mimetype)

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

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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: [signal] void destroyed (QObject ptr arg1)

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QMimeData::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 QMimeData::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

formats

Signature: [const] string[] formats

Description: Virtual method QStringList QMimeData::formats()

This method can be reimplemented in a derived class.

hasColor

Signature: [const] bool hasColor

Description: Method bool QMimeData::hasColor()

hasFormat

Signature: [const] bool hasFormat (string mimetype)

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

This method can be reimplemented in a derived class.

hasHtml

Signature: [const] bool hasHtml

Description: Method bool QMimeData::hasHtml()

hasImage

Signature: [const] bool hasImage

Description: Method bool QMimeData::hasImage()

hasText

Signature: [const] bool hasText

Description: Method bool QMimeData::hasText()

hasUrls

Signature: [const] bool hasUrls

Description: Method bool QMimeData::hasUrls()

html

Signature: [const] string html

Description: Method QString QMimeData::html()

imageData

Signature: [const] variant imageData

Description: Method QVariant QMimeData::imageData()

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

imageData=

Signature: void imageData= (variant image)

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

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

isSignalConnected

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

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

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

is_const_object?

Signature: [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

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

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

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

removeFormat

Signature: void removeFormat (string mimetype)

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

retrieveData

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QMimeData::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QMimeData::senderSignalIndex()

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

setColorData

Signature: void setColorData (variant color)

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

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

setData

Signature: void setData (string mimetype, bytes data)

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

setHtml

Signature: void setHtml (string html)

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

setImageData

Signature: void setImageData (variant image)

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

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

setText

Signature: void setText (string text)

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

setUrls

Signature: void setUrls (QUrl[] urls)

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

text

Signature: [const] string text

Description: Method QString QMimeData::text()

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

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

urls

Signature: [const] QUrl[] urls

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