在 QHeaderView 和 QListWidget 之间拖放列

Posted 2023-05-08

【中文标题】在 QHeaderView 和 QListWidget 之间拖放列

【英文标题】：Drag and drop columns between QHeaderView and QListWidget

【发布时间】：2018-04-27 18:05:53

【问题描述】：

我在使用QHeaderView 拖放功能时遇到了麻烦。当我将QHeaderView 子类化时，我可以毫无问题地接受丢弃。但是，当我单击 QHeaderView 并尝试从其中一列中拖动时，似乎没有任何反应。

下面我重新实现了几个拖动事件，以便在调用它们时简单地打印。但是，只有dragEnterEvent 是成功的。从未调用过诸如startDrag 之类的其他事件。我的最终目标是拥有一个QTableView，我可以在其中将列从QListWidget 拖放到QListWidget（基本上隐藏了该列），然后用户可以将QListWidget 项目拖回QTableView，如果他们想要该列并且其数据再次可见。但是，在我理解为什么QHeaderView 不允许我拖动之前，我无法继续前进。任何帮助将不胜感激。

class MyHeader(QHeaderView):
    def __init__(self, parent=None):
        super().__init__(Qt.Horizontal, parent)
        self.setDragEnabled(True)
        self.setAcceptDrops(True)

    def startDrag(self, *args, **kwargs):
        print('start drag success')

    def dragEnterEvent(self, event):
        print('drag enter success')

    def dragLeaveEvent(self, event):
        print('drag leave success')

    def dragMoveEvent(self, event):
        print('drag move success')

class Form(QDialog):
    def __init__(self, parent=None):
        super().__init__(parent)

        listWidget = QListWidget()
        listWidget.setDragEnabled(True)
        listWidget.setAcceptDrops(True)
        listWidget.addItem('item #1')
        listWidget.addItem('item #2')

        tableWidget = QTableWidget()
        header = MyHeader()
        tableWidget.setHorizontalHeader(header)
        tableWidget.setRowCount(5)
        tableWidget.setColumnCount(2)
        tableWidget.setHorizontalHeaderLabels(["Column 1", "Column 2"])

        splitter = QSplitter(Qt.Horizontal)
        splitter.addWidget(listWidget)
        splitter.addWidget(tableWidget)
        layout = QHBoxLayout()
        layout.addWidget(splitter)
        self.setLayout(layout)

if __name__=='__main__':
    import sys
    app = QApplication(sys.argv)
    form= Form()
    form.show()
    sys.exit(app.exec_())

【参考方案1】：

QHeaderView 类不使用继承自QAbstractItemView 的拖放方法，因为它永远不需要启动拖放操作。拖放仅用于重新排列列，不需要使用QDrag 机制。

鉴于此，有必要实现自定义拖放处理（使用mousePressEvent、mouseMoveEvent 和dropEvent），并提供Qt 用来传递的mime-data 格式的编码和解码功能视图之间的项目。 table-widget 需要一个事件过滤器，以便在隐藏所有列时仍然可以删除；并且对于 list-widget，也可以阻止其将项目复制到自身。

下面的演示脚本实现了所有这些。可能还需要一些改进，但这应该足以让您入门：

import sys
from PyQt5.QtCore import *
from PyQt5.QtGui import *
from PyQt5.QtWidgets import *

class MyHeader(QHeaderView):
    MimeType = 'application/x-qabstractitemmodeldatalist'
    columnsChanged = pyqtSignal(int)

    def __init__(self, parent=None):
        super().__init__(Qt.Horizontal, parent)
        self.setDragEnabled(True)
        self.setAcceptDrops(True)
        self._dragstartpos = None

    def encodeMimeData(self, items):
        data = QByteArray()
        stream = QDataStream(data, QIODevice.WriteOnly)
        for column, label in items:
            stream.writeInt32(0)
            stream.writeInt32(column)
            stream.writeInt32(2)
            stream.writeInt32(int(Qt.DisplayRole))
            stream.writeQVariant(label)
            stream.writeInt32(int(Qt.UserRole))
            stream.writeQVariant(column)
        mimedata = QMimeData()
        mimedata.setData(MyHeader.MimeType, data)
        return mimedata

    def decodeMimeData(self, mimedata):
        data = []
        stream = QDataStream(mimedata.data(MyHeader.MimeType))
        while not stream.atEnd():
            row = stream.readInt32()
            column = stream.readInt32()
            item = 
            for count in range(stream.readInt32()):
                key = stream.readInt32()
                item[key] = stream.readQVariant()
            data.append([item[Qt.UserRole], item[Qt.DisplayRole]])
        return data

    def mousePressEvent(self, event):
        if event.button() == Qt.LeftButton:
            self._dragstartpos = event.pos()
        super().mousePressEvent(event)

    def mouseMoveEvent(self, event):
        if (event.buttons() & Qt.LeftButton and
            self._dragstartpos is not None and
            (event.pos() - self._dragstartpos).manhattanLength() >=
            QApplication.startDragDistance()):
            column = self.logicalIndexAt(self._dragstartpos)
            data = [column, self.model().headerData(column, Qt.Horizontal)]
            self._dragstartpos = None
            drag = QDrag(self)
            drag.setMimeData(self.encodeMimeData([data]))
            action = drag.exec(Qt.MoveAction)
            if action != Qt.IgnoreAction:
                self.setColumnHidden(column, True)

    def dropEvent(self, event):
        mimedata = event.mimeData()
        if mimedata.hasFormat(MyHeader.MimeType):
            if event.source() is not self:
                for column, label in self.decodeMimeData(mimedata):
                    self.setColumnHidden(column, False)
                event.setDropAction(Qt.MoveAction)
                event.accept()
            else:
                event.ignore()
        else:
            super().dropEvent(event)

    def setColumnHidden(self, column, hide=True):
        count = self.count()
        if 0 <= column < count and hide != self.isSectionHidden(column):
            if hide:
                self.hideSection(column)
            else:
                self.showSection(column)
            self.columnsChanged.emit(count - self.hiddenSectionCount())

class Form(QDialog):
    def __init__(self, parent=None):
        super().__init__(parent)

        self.listWidget = QListWidget()
        self.listWidget.setAcceptDrops(True)
        self.listWidget.setDragEnabled(True)
        self.listWidget.viewport().installEventFilter(self)

        self.tableWidget = QTableWidget()
        header = MyHeader(self)
        self.tableWidget.setHorizontalHeader(header)
        self.tableWidget.setRowCount(5)
        self.tableWidget.setColumnCount(4)

        labels = ["Column 1", "Column 2", "Column 3", "Column 4"]
        self.tableWidget.setHorizontalHeaderLabels(labels)
        for column, label in enumerate(labels):
            if column > 1:
                item = QListWidgetItem(label)
                item.setData(Qt.UserRole, column)
                self.listWidget.addItem(item)
                header.hideSection(column)

        header.columnsChanged.connect(
            lambda count: self.tableWidget.setAcceptDrops(not count))
        self.tableWidget.viewport().installEventFilter(self)

        splitter = QSplitter(Qt.Horizontal)
        splitter.addWidget(self.listWidget)
        splitter.addWidget(self.tableWidget)
        layout = QHBoxLayout()
        layout.addWidget(splitter)
        self.setLayout(layout)

    def eventFilter(self, source, event):
        if event.type() == QEvent.Drop:
            if source is self.tableWidget.viewport():
                self.tableWidget.horizontalHeader().dropEvent(event)
                return True
            else:
                event.setDropAction(Qt.MoveAction)
        return super().eventFilter(source, event)

if __name__=='__main__':

    app = QApplication(sys.argv)
    form = Form()
    form.setGeometry(600, 50, 600, 200)
    form.show()
    sys.exit(app.exec_())

【讨论】：

这太完美了！非常感谢您的详细解释和示例。这让我远远超出了我的预期。一个问题：我看到的唯一问题是用户是否要将一列从 QHeaderView 拖回 QHeaderView（而不是 QListWidget）上，这实际上从视图中隐藏了拖动的列，而无法恢复拖动的列。我试图找到一种方法来忽略这种情况下的阻力。我确信答案很简单，但经过几个小时查看源代码后，我无法找到有效的解决方案。

@ArtVandelay。我已经解决了这个问题（在dropEvent 方法中）。进一步的改进是在标题拖动自身时设置拖动光标 - 但我将把它留给你;-)

太棒了！很长一段时间以来，我一直想将此功能添加到我的应用程序中，而您已经帮助实现了这一目标。此外，您提供的源代码让我对 Qt 的一些低级特性有了更好的理解。再次感谢您的时间和精力。

@ArtVandelay。不客气 - 感谢您的反馈。