Draggable Icons Example#

The Draggable Icons example shows how to drag and drop image data between widgets in the same application, and between different applications.

../_images/draggableicons-example.png

In many situations where drag and drop is used, the user starts dragging from a particular widget and drops the payload onto another widget. In this example, we subclass QLabel to create labels that we use as drag sources, and place them inside QWidget s that serve as both containers and drop sites.

In addition, when a drag and drop operation occurs, we want to send more than just an image. We also want to send information about where the user clicked in the image so that the user can place it precisely on the drop target. This level of detail means that we must create a custom MIME type for our data.

DragWidget Class Definition#

The icon widgets that we use to display icons are subclassed from QLabel :

class DragWidget(QFrame):

# public
    DragWidget = explicit(QWidget parent = None)
protected:
    def dragEnterEvent(event):
    def dragMoveEvent(event):
    def dropEvent(event):
    def mousePressEvent(event):

Since the QLabel class provides most of what we require for the icon, we only need to reimplement the mousePressEvent() to provide drag and drop facilities.

DragWidget Class Implementation#

The DragWidget constructor sets an attribute on the widget that ensures that it will be deleted when it is closed:

def __init__(self, parent):
    QFrame.__init__(self, parent)

    setMinimumSize(200, 200)
    setFrameStyle(QFrame.Sunken | QFrame.StyledPanel)
    setAcceptDrops(True)
    boatIcon = QLabel(self)
    boatIcon.setPixmap(QPixmap(":/images/boat.png"))
    boatIcon.move(10, 10)
    boatIcon.show()
    boatIcon.setAttribute(Qt.WA_DeleteOnClose)
    carIcon = QLabel(self)
    carIcon.setPixmap(QPixmap(":/images/car.png"))
    carIcon.move(100, 10)
    carIcon.show()
    carIcon.setAttribute(Qt.WA_DeleteOnClose)
    houseIcon = QLabel(self)
    houseIcon.setPixmap(QPixmap(":/images/house.png"))
    houseIcon.move(10, 80)
    houseIcon.show()
    houseIcon.setAttribute(Qt.WA_DeleteOnClose)

To enable dragging from the icon, we need to act on a mouse press event. We do this by reimplementing mousePressEvent() and setting up a QDrag object.

def mousePressEvent(self, event):

    child = QLabel(childAt(event.position().toPoint()))
    if (not child)
        return
    pixmap = child.pixmap(Qt.ReturnByValue)
    itemData = QByteArray()
    dataStream = QDataStream(itemData, QIODevice.WriteOnly)
    dataStream << pixmap << QPoint(event.position().toPoint() - child.pos())

Since we will be sending pixmap data for the icon and information about the user’s click in the icon widget, we construct a QByteArray and package up the details using a QDataStream .

For interoperability, drag and drop operations describe the data they contain using MIME types. In Qt, we describe this data using a QMimeData object:

mimeData = QMimeData()
mimeData.setData("application/x-dnditemdata", itemData)

We choose an unofficial MIME type for this purpose, and supply the QByteArray to the MIME data object.

The drag and drop operation itself is handled by a QDrag object:

drag = QDrag(self)
drag.setMimeData(mimeData)
drag.setPixmap(pixmap)
drag.setHotSpot(event.position().toPoint() - child.pos())

Here, we pass the data to the drag object, set a pixmap that will be shown alongside the cursor during the operation, and define the position of a hot spot that places the position of this pixmap under the cursor.

Example project @ code.qt.io