Source code for openlp.core.ui.lib.treewidgetwithdnd

# -*- coding: utf-8 -*-
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4

###############################################################################
# OpenLP - Open Source Lyrics Projection                                      #
# --------------------------------------------------------------------------- #
# Copyright (c) 2008-2017 OpenLP Developers                                   #
# --------------------------------------------------------------------------- #
# This program is free software; you can redistribute it and/or modify it     #
# under the terms of the GNU General Public License as published by the Free  #
# Software Foundation; version 2 of the License.                              #
#                                                                             #
# This program is distributed in the hope that it will be useful, but WITHOUT #
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
# more details.                                                               #
#                                                                             #
# You should have received a copy of the GNU General Public License along     #
# with this program; if not, write to the Free Software Foundation, Inc., 59  #
# Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
###############################################################################
"""
Extend QTreeWidget to handle drag and drop functionality
"""
import os

from PyQt5 import QtCore, QtGui, QtWidgets

from openlp.core.common import Registry, is_win


[docs]class TreeWidgetWithDnD(QtWidgets.QTreeWidget): """ Provide a tree widget to store objects and handle drag and drop events """ def __init__(self, parent=None, name=''): """ Initialise the tree widget """ super(TreeWidgetWithDnD, self).__init__(parent) self.mime_data_text = name self.allow_internal_dnd = False self.header().close() self.default_indentation = self.indentation() self.setIndentation(0) self.setAnimated(True)
[docs] def activateDnD(self): """ Activate DnD of widget """ self.setAcceptDrops(True) self.setDragDropMode(QtWidgets.QAbstractItemView.DragDrop) Registry().register_function(('%s_dnd' % self.mime_data_text), self.parent().load_file) Registry().register_function(('%s_dnd_internal' % self.mime_data_text), self.parent().dnd_move_internal)
[docs] def mouseMoveEvent(self, event): """ Drag and drop event does not care what data is selected as the recipient will use events to request the data move just tell it what plugin to call :param event: The event that occurred """ if event.buttons() != QtCore.Qt.LeftButton: event.ignore() return if not self.selectedItems(): event.ignore() return drag = QtGui.QDrag(self) mime_data = QtCore.QMimeData() drag.setMimeData(mime_data) mime_data.setText(self.mime_data_text) drag.exec(QtCore.Qt.CopyAction)
[docs] def dragEnterEvent(self, event): """ Receive drag enter event, check if it is a file or internal object and allow it if it is. :param event: The event that occurred """ if event.mimeData().hasUrls(): event.accept() elif self.allow_internal_dnd: event.accept() else: event.ignore()
[docs] def dragMoveEvent(self, event): """ Receive drag move event, check if it is a file or internal object and allow it if it is. :param event: The event that occurred """ QtWidgets.QTreeWidget.dragMoveEvent(self, event) if event.mimeData().hasUrls(): event.setDropAction(QtCore.Qt.CopyAction) event.accept() elif self.allow_internal_dnd: event.setDropAction(QtCore.Qt.CopyAction) event.accept() else: event.ignore()
[docs] def dropEvent(self, event): """ Receive drop event, check if it is a file or internal object and process it if it is. :param event: Handle of the event pint passed """ # If we are on Windows, OpenLP window will not be set on top. For example, user can drag images to Library and # the folder stays on top of the group creation box. This piece of code fixes this issue. if is_win(): self.setWindowState(self.windowState() & ~QtCore.Qt.WindowMinimized | QtCore.Qt.WindowActive) self.setWindowState(QtCore.Qt.WindowNoState) if event.mimeData().hasUrls(): event.setDropAction(QtCore.Qt.CopyAction) event.accept() files = [] for url in event.mimeData().urls(): local_file = url.toLocalFile() if os.path.isfile(local_file): files.append(local_file) elif os.path.isdir(local_file): listing = os.listdir(local_file) for file_name in listing: files.append(os.path.join(local_file, file_name)) Registry().execute('%s_dnd' % self.mime_data_text, {'files': files, 'target': self.itemAt(event.pos())}) elif self.allow_internal_dnd: event.setDropAction(QtCore.Qt.CopyAction) event.accept() Registry().execute('%s_dnd_internal' % self.mime_data_text, self.itemAt(event.pos())) else: event.ignore()
# Convenience methods for emulating a QListWidget. This helps keeping MediaManagerItem simple.
[docs] def addItem(self, item): self.addTopLevelItem(item)
[docs] def count(self): return self.topLevelItemCount()
[docs] def item(self, index): return self.topLevelItem(index)