######################################################################################################################
# Copyright (C) 2017 - 2019 Spine project consortium
# This file is part of Spine Toolbox.
# Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
# Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option)
# any later version. 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 Lesser General
# Public License for more details. You should have received a copy of the GNU Lesser General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
######################################################################################################################
"""
Classes for custom QTreeView.
:author: M. Marin (KTH)
:date: 25.4.2018
"""
import os
from PySide2.QtWidgets import QTreeView, QApplication
from PySide2.QtCore import Signal, Slot, Qt, QMimeData, QUrl
from PySide2.QtGui import QDrag
[docs]class CopyTreeView(QTreeView):
"""Custom QTreeView class with copy support.
"""
def __init__(self, parent):
"""Initialize the view."""
super().__init__(parent=parent)
[docs] def copy(self):
"""Copy current selection to clipboard in excel format."""
selection = self.selectionModel().selection()
if not selection:
return False
indexes = selection.indexes()
values = [index.data(Qt.DisplayRole) for index in indexes]
content = "\n".join(values)
QApplication.clipboard().setText(content)
return True
[docs]class ObjectTreeView(CopyTreeView):
"""Custom QTreeView class for object tree in TreeViewForm.
Attributes:
parent (QWidget): The parent of this view
"""
[docs] edit_key_pressed = Signal("QModelIndex", name="edit_key_pressed")
def __init__(self, parent):
"""Initialize the view."""
super().__init__(parent=parent)
@Slot("QModelIndex", "EditTrigger", "QEvent", name="edit")
[docs] def edit(self, index, trigger, event):
"""Send signal instead of editing item, so
the TreeViewForm can catch this signal and open a custom QDialog
for edition.
"""
if trigger == QTreeView.EditKeyPressed:
self.edit_key_pressed.emit(index)
return False
[docs]class ReferencesTreeView(QTreeView):
"""Custom QTreeView class for 'References' in Data Connection properties.
Attributes:
parent (QWidget): The parent of this view
"""
[docs] files_dropped = Signal("QVariant", name="files_dropped")
[docs] del_key_pressed = Signal(name="del_key_pressed")
def __init__(self, parent):
"""Initialize the view."""
super().__init__(parent=parent)
[docs] def dragEnterEvent(self, event):
"""Accept file drops from the filesystem."""
urls = event.mimeData().urls()
for url in urls:
if not url.isLocalFile():
event.ignore()
return
if not os.path.isfile(url.toLocalFile()):
event.ignore()
return
event.accept()
event.setDropAction(Qt.LinkAction)
[docs] def dragMoveEvent(self, event):
"""Accept event."""
event.accept()
[docs] def dropEvent(self, event):
"""Emit files_dropped signal with a list of files for each dropped url."""
self.files_dropped.emit([url.toLocalFile() for url in event.mimeData().urls()])
[docs] def keyPressEvent(self, event):
"""Overridden method to make the view support deleting items with a delete key."""
super().keyPressEvent(event)
if event.key() == Qt.Key_Delete:
self.del_key_pressed.emit()
[docs]class DataTreeView(QTreeView):
"""Custom QTreeView class for 'Data' in Data Connection properties.
Attributes:
parent (QWidget): The parent of this view
"""
[docs] files_dropped = Signal("QVariant", name="files_dropped")
[docs] del_key_pressed = Signal(name="del_key_pressed")
def __init__(self, parent):
"""Initialize the view."""
super().__init__(parent=parent)
self.drag_start_pos = None
self.drag_indexes = list()
[docs] def dragEnterEvent(self, event):
"""Accept file drops from the filesystem."""
urls = event.mimeData().urls()
for url in urls:
if not url.isLocalFile():
event.ignore()
return
if not os.path.isfile(url.toLocalFile()):
event.ignore()
return
event.accept()
event.setDropAction(Qt.CopyAction)
[docs] def dragMoveEvent(self, event):
"""Accept event."""
event.accept()
[docs] def dropEvent(self, event):
"""Emit files_dropped signal with a list of files for each dropped url."""
self.files_dropped.emit([url.toLocalFile() for url in event.mimeData().urls()])
[docs] def mousePressEvent(self, event):
"""Register drag start position."""
if event.button() == Qt.LeftButton:
self.drag_start_pos = event.pos()
self.drag_indexes = self.selectedIndexes()
super().mousePressEvent(event)
[docs] def mouseMoveEvent(self, event):
"""Start dragging action if needed."""
if not event.buttons() & Qt.LeftButton:
return
if not self.drag_start_pos:
return
if not self.drag_indexes:
return
if (event.pos() - self.drag_start_pos).manhattanLength() < QApplication.startDragDistance():
return
drag = QDrag(self)
mimeData = QMimeData()
urls = list()
for index in self.drag_indexes:
file_path = index.data(Qt.UserRole)
urls.append(QUrl.fromLocalFile(file_path))
mimeData.setUrls(urls)
drag.setMimeData(mimeData)
icon = self.drag_indexes[0].data(Qt.DecorationRole)
if icon:
pixmap = icon.pixmap(32, 32)
drag.setPixmap(pixmap)
drag.setHotSpot(pixmap.rect().center())
drag.exec_()
[docs] def mouseReleaseEvent(self, event):
"""Forget drag start position"""
self.drag_start_pos = None
super().mouseReleaseEvent(event) # Fixes bug in extended selection
[docs] def keyPressEvent(self, event):
"""Overridden method to make the view support deleting items with a delete key."""
super().keyPressEvent(event)
if event.key() == Qt.Key_Delete:
self.del_key_pressed.emit()
[docs]class SourcesTreeView(QTreeView):
"""Custom QTreeView class for 'Sources' in Tool Template form.
Attributes:
parent (QWidget): The parent of this view
"""
[docs] files_dropped = Signal("QVariant", name="files_dropped")
[docs] del_key_pressed = Signal(name="del_key_pressed")
def __init__(self, parent):
"""Initialize the view."""
super().__init__(parent=parent)
[docs] def dragEnterEvent(self, event):
"""Accept file and folder drops from the filesystem."""
urls = event.mimeData().urls()
for url in urls:
if not url.isLocalFile():
event.ignore()
return
if not os.path.isfile(url.toLocalFile()):
event.ignore()
return
event.accept()
event.setDropAction(Qt.LinkAction)
[docs] def dragMoveEvent(self, event):
"""Accept event."""
event.accept()
[docs] def dropEvent(self, event):
"""Emit files_dropped signal with a list of files for each dropped url."""
self.files_dropped.emit([url.toLocalFile() for url in event.mimeData().urls()])
[docs] def keyPressEvent(self, event):
"""Overridden method to make the view support deleting items with a delete key."""
super().keyPressEvent(event)
if event.key() == Qt.Key_Delete:
self.del_key_pressed.emit()
[docs]class CustomTreeView(QTreeView):
"""Custom QTreeView class for Tool template editor form to enable keyPressEvent.
Attributes:
parent (QWidget): The parent of this view
"""
[docs] del_key_pressed = Signal(name="del_key_pressed")
def __init__(self, parent):
"""Initialize the view."""
super().__init__(parent=parent)
[docs] def keyPressEvent(self, event):
"""Overridden method to make the view support deleting items with a delete key."""
super().keyPressEvent(event)
if event.key() == Qt.Key_Delete:
self.del_key_pressed.emit()