[−][src]Struct qt_core::QMimeData

#[repr(C)]pub struct QMimeData { /* fields omitted */ }

The QMimeData class provides a container for data that records information about its MIME type.

C++ class: QMimeData.

C++ documentation:

The QMimeData class provides a container for data that records information about its MIME type.

QMimeData is used to describe information that can be stored in the clipboard, and transferred via the drag and drop mechanism. QMimeData objects associate the data that they hold with the corresponding MIME types to ensure that information can be safely transferred between applications, and copied around within the same application.

QMimeData objects are usually created using new and supplied to QDrag or QClipboard objects. This is to enable Qt to manage the memory that they use.

A single QMimeData object can store the same data using several different formats at the same time. The formats() function returns a list of the available formats in order of preference. The data() function returns the raw data associated with a MIME type, and setData() allows you to set the data for a MIME type.

For the most common MIME types, QMimeData provides convenience functions to access the data:

Tester	Getter	Setter	MIME Types
hasText()	text()	setText()	`text/plain`
hasHtml()	html()	setHtml()	`text/html`
hasUrls()	urls()	setUrls()	`text/uri-list`
hasImage()	imageData()	setImageData()	`image/` *
hasColor()	colorData()	setColorData()	`application/x-color`

For example, if your write a widget that accepts URL drags, you would end up writing code like this:

void MyWidget::dragEnterEvent(QDragEnterEvent *event)
{
      if (event->mimeData()->hasUrls())
          event->acceptProposedAction();
}
void MyWidget::dropEvent(QDropEvent *event)
{
      if (event->mimeData()->hasUrls()) {
          foreach (QUrl url, event->mimeData()->urls()) {
              ...
          }
      }
}

There are three approaches for storing custom data in a QMimeData object:

Custom data can be stored directly in a QMimeData object as a QByteArray using setData(). For example:

QByteArray csvData = ...;
QMimeData *mimeData = new QMimeData;
mimeData->setData("text/csv", csvData);

We can subclass QMimeData and reimplement hasFormat(), formats(), and retrieveData().

If the drag and drop operation occurs within a single application, we can subclass QMimeData and add extra data in it, and use a qobject_cast() in the receiver's drop event handler. For example:

void MyWidget::dropEvent(QDropEvent event)
{
      const MyMimeData myData =
              qobject_cast<const MyMimeData *>(event->mimeData());
      if (myData) {
          // access myData's data directly (not through QMimeData's API)
      }
}

Methods

`impl QMimeData`[src]

`pub unsafe fn clear(&self)`[src]

Removes all the MIME type and data entries in the object.

Calls C++ function: void QMimeData::clear().

C++ documentation:

Removes all the MIME type and data entries in the object.

`pub unsafe fn color_data(&self) -> CppBox<QVariant>`[src]

Returns a color if the data stored in the object represents a color (MIME type application/x-color); otherwise returns a null variant.

Calls C++ function: QVariant QMimeData::colorData() const.

C++ documentation:

Returns a color if the data stored in the object represents a color (MIME type application/x-color); otherwise returns a null variant.

A QVariant is used because QMimeData belongs to the Qt Core module, whereas QColor belongs to Qt GUI. To convert the QVariant to a QColor, simply use qvariant_cast(). For example:

if (event->mimeData()->hasColor()) {
      QColor color = qvariant_cast<QColor>(event->mimeData()->colorData());
      ...
}

See also hasColor(), setColorData(), and data().

`pub unsafe fn data( &self, mimetype: impl CastInto<Ref<QString>> ) -> CppBox<QByteArray>`[src]

Returns the data stored in the object in the format described by the MIME type specified by mimeType.

Calls C++ function: QByteArray QMimeData::data(const QString& mimetype) const.

C++ documentation:

Returns the data stored in the object in the format described by the MIME type specified by mimeType.

See also setData().

`pub unsafe fn formats(&self) -> CppBox<QStringList>`[src]

Returns a list of formats supported by the object. This is a list of MIME types for which the object can return suitable data. The formats in the list are in a priority order.

Calls C++ function: virtual QStringList QMimeData::formats() const.

C++ documentation:

Returns a list of formats supported by the object. This is a list of MIME types for which the object can return suitable data. The formats in the list are in a priority order.

For the most common types of data, you can call the higher-level functions hasText(), hasHtml(), hasUrls(), hasImage(), and hasColor() instead.

See also hasFormat(), setData(), and data().

`pub unsafe fn has_color(&self) -> bool`[src]

Returns true if the object can return a color (MIME type application/x-color); otherwise returns false.

Calls C++ function: bool QMimeData::hasColor() const.

C++ documentation:

Returns true if the object can return a color (MIME type application/x-color); otherwise returns false.

See also setColorData(), colorData(), and hasFormat().

`pub unsafe fn has_format(&self, mimetype: impl CastInto<Ref<QString>>) -> bool`[src]

Returns true if the object can return data for the MIME type specified by mimeType; otherwise returns false.

Calls C++ function: virtual bool QMimeData::hasFormat(const QString& mimetype) const.

C++ documentation:

Returns true if the object can return data for the MIME type specified by mimeType; otherwise returns false.

For the most common types of data, you can call the higher-level functions hasText(), hasHtml(), hasUrls(), hasImage(), and hasColor() instead.

See also formats(), setData(), and data().

`pub unsafe fn has_html(&self) -> bool`[src]

Returns true if the object can return HTML (MIME type text/html); otherwise returns false.

Calls C++ function: bool QMimeData::hasHtml() const.

C++ documentation:

Returns true if the object can return HTML (MIME type text/html); otherwise returns false.

See also setHtml(), html(), and hasFormat().

`pub unsafe fn has_image(&self) -> bool`[src]

Returns true if the object can return an image; otherwise returns false.

Calls C++ function: bool QMimeData::hasImage() const.

C++ documentation:

Returns true if the object can return an image; otherwise returns false.

See also setImageData(), imageData(), and hasFormat().

`pub unsafe fn has_text(&self) -> bool`[src]

Returns true if the object can return plain text (MIME type text/plain); otherwise returns false.

Calls C++ function: bool QMimeData::hasText() const.

C++ documentation:

Returns true if the object can return plain text (MIME type text/plain); otherwise returns false.

See also setText(), text(), hasHtml(), and hasFormat().

`pub unsafe fn has_urls(&self) -> bool`[src]

Returns true if the object can return a list of urls; otherwise returns false.

Calls C++ function: bool QMimeData::hasUrls() const.

C++ documentation:

Returns true if the object can return a list of urls; otherwise returns false.

URLs correspond to the MIME type text/uri-list.

See also setUrls(), urls(), and hasFormat().

`pub unsafe fn html(&self) -> CppBox<QString>`[src]

Returns a string if the data stored in the object is HTML (MIME type text/html); otherwise returns an empty string.

Calls C++ function: QString QMimeData::html() const.

C++ documentation:

Returns a string if the data stored in the object is HTML (MIME type text/html); otherwise returns an empty string.

See also setHtml(), hasHtml(), and setData().

`pub unsafe fn image_data(&self) -> CppBox<QVariant>`[src]

Returns a QVariant storing a QImage if the object can return an image; otherwise returns a null variant.

Calls C++ function: QVariant QMimeData::imageData() const.

C++ documentation:

Returns a QVariant storing a QImage if the object can return an image; otherwise returns a null variant.

A QVariant is used because QMimeData belongs to the Qt Core module, whereas QImage belongs to Qt GUI. To convert the QVariant to a QImage, simply use qvariant_cast(). For example:

if (event->mimeData()->hasImage()) {
      QImage image = qvariant_cast<QImage>(event->mimeData()->imageData());
      ...
}

See also setImageData() and hasImage().

`pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>`[src]

Calls C++ function: virtual const QMetaObject* QMimeData::metaObject() const.

`pub unsafe fn new() -> QBox<QMimeData>`[src]

Constructs a new MIME data object with no data in it.

Calls C++ function: [constructor] void QMimeData::QMimeData().

C++ documentation:

Constructs a new MIME data object with no data in it.

`pub unsafe fn qt_metacall( &self, arg1: Call, arg2: c_int, arg3: mut mut c_void ) -> c_int`[src]

Calls C++ function: virtual int QMimeData::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

`pub unsafe fn qt_metacast(&self, arg1: const c_char) -> mut c_void`[src]

Calls C++ function: virtual void* QMimeData::qt_metacast(const char* arg1).

`pub unsafe fn remove_format(&self, mimetype: impl CastInto<Ref<QString>>)`[src]

Removes the data entry for mimeType in the object.

Calls C++ function: void QMimeData::removeFormat(const QString& mimetype).

C++ documentation:

Removes the data entry for mimeType in the object.

This function was introduced in Qt 4.4.

`pub unsafe fn set_color_data(&self, color: impl CastInto<Ref<QVariant>>)`[src]

Sets the color data in the object to the given color.

Calls C++ function: void QMimeData::setColorData(const QVariant& color).

C++ documentation:

Sets the color data in the object to the given color.

Colors correspond to the MIME type application/x-color.

See also colorData(), hasColor(), and setData().

`pub unsafe fn set_data( &self, mimetype: impl CastInto<Ref<QString>>, data: impl CastInto<Ref<QByteArray>> )`[src]

Sets the data associated with the MIME type given by mimeType to the specified data.

Calls C++ function: void QMimeData::setData(const QString& mimetype, const QByteArray& data).

C++ documentation:

Sets the data associated with the MIME type given by mimeType to the specified data.

For the most common types of data, you can call the higher-level functions setText(), setHtml(), setUrls(), setImageData(), and setColorData() instead.

Note that if you want to use a custom data type in an item view drag and drop operation, you must register it as a Qt meta type, using the Q_DECLARE_METATYPE() macro, and implement stream operators for it. The stream operators must then be registered with the qRegisterMetaTypeStreamOperators() function.

See also data(), hasFormat(), QMetaType, and qRegisterMetaTypeStreamOperators().

`pub unsafe fn set_html(&self, html: impl CastInto<Ref<QString>>)`[src]

Sets html as the HTML (MIME type text/html) used to represent the data.

Calls C++ function: void QMimeData::setHtml(const QString& html).

C++ documentation:

Sets html as the HTML (MIME type text/html) used to represent the data.

See also html(), hasHtml(), setText(), and setData().

`pub unsafe fn set_image_data(&self, image: impl CastInto<Ref<QVariant>>)`[src]

Sets the data in the object to the given image.

Calls C++ function: void QMimeData::setImageData(const QVariant& image).

C++ documentation:

Sets the data in the object to the given image.

A QVariant is used because QMimeData belongs to the Qt Core module, whereas QImage belongs to Qt GUI. The conversion from QImage to QVariant is implicit. For example:

mimeData->setImageData(QImage("beautifulfjord.png"));

See also imageData(), hasImage(), and setData().

`pub unsafe fn set_text(&self, text: impl CastInto<Ref<QString>>)`[src]

Sets text as the plain text (MIME type text/plain) used to represent the data.

Calls C++ function: void QMimeData::setText(const QString& text).

C++ documentation:

Sets text as the plain text (MIME type text/plain) used to represent the data.

See also text(), hasText(), setHtml(), and setData().

`pub unsafe fn set_urls(&self, urls: impl CastInto<Ref<QListOfQUrl>>)`[src]

Sets the URLs stored in the MIME data object to those specified by urls.

Calls C++ function: void QMimeData::setUrls(const QList<QUrl>& urls).

C++ documentation:

Sets the URLs stored in the MIME data object to those specified by urls.

URLs correspond to the MIME type text/uri-list.

Since Qt 5.0, setUrls also exports the urls as plain text, if setText was not called before, to make it possible to drop them into any lineedit and text editor.

See also urls(), hasUrls(), and setData().

`pub unsafe fn static_meta_object() -> Ref<QMetaObject>`[src]

Returns a reference to the staticMetaObject field.

`pub unsafe fn text(&self) -> CppBox<QString>`[src]

Returns a plain text (MIME type text/plain) representation of the data.

Calls C++ function: QString QMimeData::text() const.

C++ documentation:

Returns a plain text (MIME type text/plain) representation of the data.

See also setText(), hasText(), html(), and data().

`pub unsafe fn tr( s: const c_char, c: const c_char, n: c_int ) -> CppBox<QString>`[src]

Calls C++ function: static QString QMimeData::tr(const char* s, const char* c, int n).

`pub unsafe fn tr_utf8( s: const c_char, c: const c_char, n: c_int ) -> CppBox<QString>`[src]

Calls C++ function: static QString QMimeData::trUtf8(const char* s, const char* c, int n).

`pub unsafe fn urls(&self) -> CppBox<QListOfQUrl>`[src]

Returns a list of URLs contained within the MIME data object.

Calls C++ function: QList<QUrl> QMimeData::urls() const.

C++ documentation:

Returns a list of URLs contained within the MIME data object.

URLs correspond to the MIME type text/uri-list.

See also setUrls(), hasUrls(), and data().

Methods from Deref<Target = QObject>

`pub unsafe fn find_child<T>( &self, name: &str ) -> Result<QPtr<T>, FindChildError> where QObject: DynamicCast<T>, T: StaticUpcast<QObject>,` [src]

Finds a child of self with the specified object name and casts it to type T.

The search is performed recursively. If there is more than one child matching the search, the most direct ancestor is returned. If there are several direct ancestors, it is undefined which one will be returned.

Returns an error if there is no child object with object name name or the found object cannot be cast to T.

`pub fn destroyed(&self) -> Signal<(*mut QObject,)>`[src]

This signal is emitted immediately before the object obj is destroyed, and can not be blocked.

Returns a built-in Qt signal QObject::destroyed that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted immediately before the object obj is destroyed, and can not be blocked.

All the objects's children are destroyed immediately after this signal is emitted.

See also deleteLater() and QPointer.

`pub fn object_name_changed(&self) -> Signal<(*const QString,)>`[src]

This signal is emitted after the object's name has been changed. The new object name is passed as objectName.

Returns a built-in Qt signal QObject::objectNameChanged that can be passed to qt_core::Signal::connect.

C++ documentation:

This signal is emitted after the object's name has been changed. The new object name is passed as objectName.

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

Note: Notifier signal for property objectName.

See also QObject::objectName.

`pub fn slot_delete_later(&self) -> Receiver<()>`[src]

Schedules this object for deletion.

Returns a built-in Qt slot QObject::deleteLater that can be passed to qt_core::Signal::connect.

C++ documentation:

Schedules this object for deletion.

The object will be deleted when control returns to the event loop. If the event loop is not running when this function is called (e.g. deleteLater() is called on an object before QCoreApplication::exec()), the object will be deleted once the event loop is started. If deleteLater() is called after the main event loop has stopped, the object will not be deleted. Since Qt 4.8, if deleteLater() is called on an object that lives in a thread with no running event loop, the object will be destroyed when the thread finishes.

Note that entering and leaving a new event loop (e.g., by opening a modal dialog) will not perform the deferred deletion; for the object to be deleted, the control must return to the event loop from which deleteLater() was called.

Note: It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue.

See also destroyed() and QPointer.

`pub unsafe fn block_signals(&self, b: bool) -> bool`[src]

If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). If block is false, no such blocking will occur.

Calls C++ function: bool QObject::blockSignals(bool b).

C++ documentation:

If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). If block is false, no such blocking will occur.

The return value is the previous value of signalsBlocked().

Note that the destroyed() signal will be emitted even if the signals for this object have been blocked.

Signals emitted while being blocked are not buffered.

See also signalsBlocked() and QSignalBlocker.

`pub unsafe fn children(&self) -> Ref<QListOfQObject>`[src]

Returns a list of child objects. The QObjectList class is defined in the <QObject> header file as the following:

Calls C++ function: const QList<QObject*>& QObject::children() const.

C++ documentation:

Returns a list of child objects. The QObjectList class is defined in the <QObject> header file as the following:


  typedef QList<QObject*> QObjectList;

The first child added is the first object in the list and the last child added is the last object in the list, i.e. new children are appended at the end.

Note that the list order changes when QWidget children are raised or lowered. A widget that is raised becomes the last object in the list, and a widget that is lowered becomes the first object in the list.

See also findChild(), findChildren(), parent(), and setParent().

`pub unsafe fn delete_later(&self)`[src]

Schedules this object for deletion.

Calls C++ function: [slot] void QObject::deleteLater().

C++ documentation:

Schedules this object for deletion.

The object will be deleted when control returns to the event loop. If the event loop is not running when this function is called (e.g. deleteLater() is called on an object before QCoreApplication::exec()), the object will be deleted once the event loop is started. If deleteLater() is called after the main event loop has stopped, the object will not be deleted. Since Qt 4.8, if deleteLater() is called on an object that lives in a thread with no running event loop, the object will be destroyed when the thread finishes.

Note that entering and leaving a new event loop (e.g., by opening a modal dialog) will not perform the deferred deletion; for the object to be deleted, the control must return to the event loop from which deleteLater() was called.

Note: It is safe to call this function more than once; when the first deferred deletion event is delivered, any pending events for the object are removed from the event queue.

See also destroyed() and QPointer.