QMimeData#

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

Synopsis#

Functions#

def clear ()
def colorData ()
def data (mimetype)
def hasColor ()
def hasHtml ()
def hasImage ()
def hasText ()
def hasUrls ()
def html ()
def imageData ()
def removeFormat (mimetype)
def setColorData (color)
def setData (mimetype, data)
def setHtml (html)
def setImageData (image)
def setText (text)
def setUrls (urls)
def text ()
def urls ()

Virtual functions#

def formats ()
def hasFormat (mimetype)
def retrieveData (mimetype, preferredType)

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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

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:

def dragEnterEvent(self, event):

    if event.mimeData().hasUrls():
        event.acceptProposedAction()

def dropEvent(self, event):

    if event.mimeData().hasUrls():
        for url in 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:
csvData = ...
mimeData = 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:
def dropEvent(self, event):

    myData =
            MyMimeData(event.mimeData())
    if myData:
        # access myData's data directly (not through QMimeData's API)

Platform-Specific MIME Types#

On Windows, formats() will also return custom formats available in the MIME data, using the x-qt-windows-mime subtype to indicate that they represent data in non-standard formats. The formats will take the following form:

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

The following are examples of custom MIME types:

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

The value declaration of each format describes the way in which the data is encoded.

In some cases (e.g. dropping multiple email attachments), multiple data values are available. They can be accessed by adding an index value:

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.

See also

QClipboard QDragEnterEvent QDragMoveEvent QDropEvent QDrag Drag and Drop

class PySide6.QtCore.QMimeData#

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

PySide6.QtCore.QMimeData.clear()#

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

PySide6.QtCore.QMimeData.colorData()#

Return type:: object

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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():
    color = QColor(event.mimeData().colorData())
    ...

See also

hasColor() setColorData() data()

PySide6.QtCore.QMimeData.data(mimetype)#

Parameters:: mimetype – str
Return type:: PySide6.QtCore.QByteArray

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

See also

setData()

PySide6.QtCore.QMimeData.formats()#

Return type:: list of strings

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() data()

PySide6.QtCore.QMimeData.hasColor()#

Return type:: bool

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

See also

setColorData() colorData() hasFormat()

PySide6.QtCore.QMimeData.hasFormat(mimetype)#

Parameters:: mimetype – str
Return type:: bool

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() data()

PySide6.QtCore.QMimeData.hasHtml()#

Return type:: bool

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

See also

setHtml() html() hasFormat()

PySide6.QtCore.QMimeData.hasImage()#

Return type:: bool

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

See also

setImageData() imageData() hasFormat()

PySide6.QtCore.QMimeData.hasText()#

Return type:: bool

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

See also

setText() text() hasHtml() hasFormat()

PySide6.QtCore.QMimeData.hasUrls()#

Return type:: bool

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() hasFormat()

PySide6.QtCore.QMimeData.html()#

Return type:: str

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() setData()

PySide6.QtCore.QMimeData.imageData()#

Return type:: object

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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():
    image = QImage(event.mimeData().imageData())
    ...