QMimeData 类

QMimeData 类为记录 MIME (多用途 Internet 邮件扩展) 类型有关信息的数据提供容器。更多...

头：	#include <QMimeData>
CMake:	find_package(Qt6 REQUIRED COMPONENTS Core) target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake:	QT += core
继承：	QObject

所有成员列表，包括继承成员

公共函数

	QMimeData ()
virtual	~QMimeData ()
void	clear ()
QVariant	colorData () const
QByteArray	data (const QString & mimeType ) const
virtual QStringList	formats () const
bool	hasColor () const
virtual bool	hasFormat (const QString & mimeType ) const
bool	hasHtml () const
bool	hasImage () const
bool	hasText () const
bool	hasUrls () const
QString	html () const
QVariant	imageData () const
void	removeFormat (const QString & mimeType )
void	setColorData (const QVariant & color )
void	setData (const QString & mimeType , const QByteArray & data )
void	setHtml (const QString & html )
void	setImageData (const QVariant & image )
void	setText (const QString & text )
void	setUrls (const QList<QUrl> & urls )
QString	text () const
QList<QUrl>	urls () const

保护函数

virtual QVariant

retrieveData (const QString & mimeType , QMetaType type ) const

详细描述

QMimeData 用于描述的信息可以存储在 clipboard ，和转移凭借拖放机制。QMimeData 对象将它们保持的数据与相应 MIME 类型关联，以确保信息可以安全地在应用程序之间转移，和围绕在同一应用程序内的拷贝。

QMimeData 对象的创建通常是使用 new 且供给 QDrag or QClipboard 对象。这使 Qt 能够管理它们所使用的内存。

单个 QMimeData 对象可以同时使用几种不同格式，存储相同数据。 formats () 函数按首选次序排列，返回可用格式列表。 data () 函数返回关联 MIME 类型的原生数据，和 setData () 允许为 MIME 类型设置数据。

对于最常见 MIME 类型，QMimeData 提供了方便函数以访问数据：

Tester	Getter	Setter	MIME (多用途 Internet 邮件扩展) 类型
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`

例如，若编写接受 URL 拖拽的 Widget，最终将写出像这样的代码：

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()) {
            ...
        }
    }
}

在 QMimeData 对象中存储自定义数据有 3 种途径：

可以将自定义数据直接存储在 QMimeData 对象中按 QByteArray 使用 setData ()。例如：

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

可以子类 QMimeData 并重实现 hasFormat (), formats ()，和 retrieveData ().

若拖放操作出现在单个应用程序中，可以子类 QMimeData 并在其中添加额外数据，然后使用 qobject_cast () 在接收者的掉落事件处理程序中。例如：

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)
    }
}

特定平台 MIME 类型

在 Windows， formats () 还会返回可用于 MIME (多用途 Internet 邮件扩展) 数据的自定义格式，使用 x-qt-windows-mime 子类型以指示它们以非标格式表示数据。格式将接受以下形式：

application/x-qt-windows-mime;value="<custom type>"

以下是自定义 MIME (多用途 Internet 邮件扩展) 类型范例：

application/x-qt-windows-mime;value="FileGroupDescriptor"
application/x-qt-windows-mime;value="FileContents"

The value 声明的每种格式描述了数据编码的具体方式。

在某些情况下 (如：掉落多个 Email 附件)，多个数据值是可用的。可以访问它们通过添加 index 值：

application/x-qt-windows-mime;value="FileContents";index=0
application/x-qt-windows-mime;value="FileContents";index=1

On Windows, the MIME format does not always map directly to the clipboard formats. Qt provides QWindowsMimeConverter to map clipboard formats to open-standard MIME formats. Similarly, the QUtiMimeConverter maps MIME to Uniform Type Identifiers on macOS and iOS.

另请参阅 QClipboard , QDragEnterEvent , QDragMoveEvent , QDropEvent , QDrag ，和拖放 .

成员函数文档编制

QMimeData:: QMimeData ()

构造其中没有数据的新 MIME (多用途 Internet 邮件扩展) 数据对象。

`[虚拟]` QMimeData:: ~QMimeData ()

销毁 MIME (多用途 Internet 邮件扩展) 数据对象。

void QMimeData:: clear ()

移除对象中的所有 MIME 类型和数据条目。

QVariant QMimeData:: colorData () const

返回颜色若存储在对象中的数据表示颜色 (MIME 类型 application/x-color )；否则返回 null 变体。

A QVariant 被使用因为 QMimeData 属于 Qt Core 模块，而 QColor 属于 Qt GUI。要转换 QVariant 到 QColor ，只需使用 qvariant_cast ()。例如：

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

另请参阅 hasColor (), setColorData ()，和 data ().

QByteArray QMimeData:: data (const QString & mimeType ) const

返回存储在对象中的数据，按 MIME (多用途 Internet 邮件扩展) 类型描述的格式指定通过 mimeType .

另请参阅 setData ().

`[虚拟]` QStringList QMimeData:: formats () const

返回对象支持的格式列表。这是对象可以返回合适数据的 MIME 类型列表。列表中的格式按优先级次序排列。

对于最常见数据类型，可以调用更高级函数 hasText (), hasHtml (), hasUrls (), hasImage ()，和 hasColor () 代替。

另请参阅 hasFormat (), setData ()，和 data ().

bool QMimeData:: hasColor () const

返回 true 若对象可以返回颜色 (MIME 类型 application/x-color )；否则返回 false .

另请参阅 setColorData (), colorData ()，和 hasFormat ().

`[虚拟]` bool QMimeData:: hasFormat (const QString & mimeType ) const

返回 true 若对象可以返回 MIME (多用途 Internet 邮件扩展) 类型的数据，指定通过 mimeType ；否则返回 false .

对于最常见数据类型，可以调用更高级函数 hasText (), hasHtml (), hasUrls (), hasImage ()，和 hasColor () 代替。

另请参阅 formats (), setData ()，和 data ().

bool QMimeData:: hasHtml () const

返回 true 若对象可以返回 HTML (MIME 类型 text/html )；否则返回 false .

另请参阅 setHtml (), html ()，和 hasFormat ().

bool QMimeData:: hasImage () const

返回 true 若对象可以返回图像；否则返回 false。

另请参阅 setImageData (), imageData ()，和 hasFormat ().

bool QMimeData:: hasText () const

返回 true 若对象可以返回纯文本 (MIME 类型 text/plain )；否则返回 false .

另请参阅 setText (), text (), hasHtml ()，和 hasFormat ().

bool QMimeData:: hasUrls () const

返回 true 若对象可以返回 URL 列表；否则返回 false .

URL 对应于 MIME 类型 text/uri-list .

另请参阅 setUrls (), urls ()，和 hasFormat ().

QString QMimeData:: html () const

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

另请参阅 setHtml (), hasHtml ()，和 setData ().

QVariant QMimeData:: imageData () const

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

A QVariant 被使用因为 QMimeData 属于 Qt Core 模块，而 QImage 属于 Qt GUI。要转换 QVariant 到 QImage ，只需使用 qvariant_cast ()。例如：

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

另请参阅 setImageData () 和 hasImage ().

void QMimeData:: removeFormat (const QString & mimeType )

Removes the data entry for mimeType in the object.

`[virtual protected]` QVariant QMimeData:: retrieveData (const QString & mimeType , QMetaType type ) const

Returns a variant with the given type containing data for the MIME type specified by mimeType . If the object does not support the MIME type or variant type given, a null variant is returned instead.

This function is called by the general data () getter and by the convenience getters ( text (), html (), urls (), imageData ()，和 colorData ()). You can reimplement it if you want to store your data using a custom data structure (instead of a QByteArray , which is what setData () provides). You would then also need to reimplement hasFormat () 和 formats ().

另请参阅 data ().

void QMimeData:: setColorData (const QVariant & color )

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

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

另请参阅 colorData (), hasColor ()，和 setData ().

void QMimeData:: setData (const QString & mimeType , const QByteArray & data )

Sets the data associated with the MIME type given by mimeType 到指定 data .

对于最常见数据类型，可以调用更高级函数 setText (), setHtml (), setUrls (), setImageData ()，和 setColorData () 代替。

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 ，使用 Q_DECLARE_METATYPE () macro, and implement stream operators for it.

另请参阅 data (), hasFormat (), QMetaType ，和 Q_DECLARE_METATYPE ().

void QMimeData:: setHtml (const QString & html )

设置 html 作为 HTML (MIME 类型 text/html ) 用于表示数据。

另请参阅 html (), hasHtml (), setText ()，和 setData ().

void QMimeData:: setImageData (const QVariant & image )

将对象中的数据设为给定 image .

A QVariant 被使用因为 QMimeData 属于 Qt Core 模块，而 QImage belongs to Qt GUI. The conversion from QImage to QVariant is implicit. For example:

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

另请参阅 imageData (), hasImage ()，和 setData ().

void QMimeData:: setText (const QString & text )

设置 text 作为纯文本 (MIME 类型 text/plain ) 用于表示数据。

另请参阅 text (), hasText (), setHtml ()，和 setData ().

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

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

URL 对应于 MIME 类型 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.

另请参阅 urls (), hasUrls ()，和 setData ().

QString QMimeData:: text () const

返回纯文本 (MIME 类型 text/plain ) 表示的数据。

另请参阅 setText (), hasText (), html ()，和 data ().

QList < QUrl > QMimeData:: urls () const

返回 MIME (多用途 Internet 邮件扩展) 数据对象中包含的 URL 列表。

URL 对应于 MIME 类型 text/uri-list .

另请参阅 setUrls (), hasUrls ()，和 data ().

QMimeData 类

公共函数

保护函数

详细描述

特定平台 MIME 类型

成员函数文档编制

QMimeData:: QMimeData ()

[虚拟] QMimeData:: ~QMimeData ()

void QMimeData:: clear ()

QVariant QMimeData:: colorData () const

QByteArray QMimeData:: data (const QString & mimeType ) const

[虚拟] QStringList QMimeData:: formats () const

bool QMimeData:: hasColor () const

[虚拟] bool QMimeData:: hasFormat (const QString & mimeType ) const

bool QMimeData:: hasHtml () const

bool QMimeData:: hasImage () const

bool QMimeData:: hasText () const

bool QMimeData:: hasUrls () const

QString QMimeData:: html () const

QVariant QMimeData:: imageData () const

void QMimeData:: removeFormat (const QString & mimeType )

[virtual protected] QVariant QMimeData:: retrieveData (const QString & mimeType , QMetaType type ) const

void QMimeData:: setColorData (const QVariant & color )

void QMimeData:: setData (const QString & mimeType , const QByteArray & data )

void QMimeData:: setHtml (const QString & html )

void QMimeData:: setImageData (const QVariant & image )

void QMimeData:: setText (const QString & text )

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

QString QMimeData:: text () const

QList < QUrl > QMimeData:: urls () const

内容

`[虚拟]` QMimeData:: ~QMimeData ()

`[虚拟]` QStringList QMimeData:: formats () const

`[虚拟]` bool QMimeData:: hasFormat (const QString & mimeType ) const

`[virtual protected]` QVariant QMimeData:: retrieveData (const QString & mimeType , QMetaType type ) const