Models: Persistence enhancements

- Move ModelRefreshed signal to outer class (now a QObject subclass)
- Move mimeData() to proxy model, where it needs to be for views
- (This allowed dropping the inner Files and Transitions model classes
  entirely, replaced with a stock `QStandardItemModel`. All of the
  special logic is in the custom proxy model class.
- Add a persistent QItemSelectionModel to all three models, shared by
  both views. Selection is no longer lost when switching view.
- Track the currently visible view for 'foo' (either fooListView or
  fooTreeView) in main_window, access as `get_app().window.fooView`

Author: ferdnyc

src/classes/app.py

@@ -243,7 +243,7 @@ def __init__(self, *args, mode=None):
             else:
                 # Apply the default settings and Auto import media file
                 self.project.load("")
-                self.window.filesTreeView.add_file(path)
+                self.window.filesView.add_file(path)
         else:
             # Recover backup file (this can't happen until after the Main Window has completely loaded)
             self.window.RecoverBackup.emit()

src/windows/main_window.py

@@ -1926,22 +1926,22 @@ def actionDetailsView_trigger(self, event):
         if app.context_menu_object == "files":
             s.set("file_view", "details")
             self.filesListView.hide()
-            self.filesTreeView.show()
-            self.filesTreeView.clearSelection()
+            self.filesView = self.filesTreeView
+            self.filesView.show()
 
         # Transitions
         elif app.context_menu_object == "transitions":
             s.set("transitions_view", "details")
             self.transitionsListView.hide()
-            self.transitionsTreeView.show()
-            self.transitionsTreeView.clearSelection()
+            self.transitionsView = self.transitionsTreeView
+            self.transitionsView.show()
 
         # Effects
         elif app.context_menu_object == "effects":
             s.set("effects_view", "details")
             self.effectsListView.hide()
-            self.effectsTreeView.show()
-            self.effectsTreeView.clearSelection()
+            self.effectsView = self.effectsTreeView
+            self.effectsView.show()
 
     def actionThumbnailView_trigger(self, event):
         log.info("Switch to Thumbnail View")
@@ -1954,25 +1954,25 @@ def actionThumbnailView_trigger(self, event):
         if app.context_menu_object == "files":
             s.set("file_view", "thumbnail")
             self.filesTreeView.hide()
-            self.filesListView.show()
-            self.filesListView.clearSelection()
+            self.filesView = self.filesListView
+            self.filesView.show()
 
         # Transitions
         elif app.context_menu_object == "transitions":
             s.set("transitions_view", "thumbnail")
             self.transitionsTreeView.hide()
-            self.transitionsListView.show()
-            self.transitionsListView.clearSelection()
+            self.transitionsView = self.transitionsListView
+            self.transitionsView.show()
 
         # Effects
         elif app.context_menu_object == "effects":
             s.set("effects_view", "thumbnail")
             self.effectsTreeView.hide()
-            self.effectsListView.show()
-            self.effectsListView.clearSelection()
+            self.effectsView = self.effectsListView
+            self.effectsView.show()
 
     def resize_contents(self):
-        if self.filesTreeView:
+        if self.filesView == self.filesTreeView:
             self.filesTreeView.resize_contents()
 
     def getDocks(self):
@@ -2625,28 +2625,30 @@ def __init__(self, mode=None):
         self.tabFiles.layout().insertWidget(-1, self.filesTreeView)
         self.tabFiles.layout().insertWidget(-1, self.filesListView)
         if s.get("file_view") == "details":
+            self.filesView = self.filesTreeView
             self.filesListView.hide()
-            self.filesTreeView.show()
-            self.filesTreeView.setFocus()
         else:
+            self.filesView = self.filesListView
             self.filesTreeView.hide()
-            self.filesListView.show()
-            self.filesListView.setFocus()
+        # Show our currently-enabled project files view
+        self.filesView.show()
+        self.filesView.setFocus()
 
-        # Setup transitions tree
+        # Setup transitions tree and list views
         self.transition_model = TransitionsModel()
         self.transitionsTreeView = TransitionsTreeView(self.transition_model)
         self.transitionsListView = TransitionsListView(self.transition_model)
         self.tabTransitions.layout().insertWidget(-1, self.transitionsTreeView)
         self.tabTransitions.layout().insertWidget(-1, self.transitionsListView)
         if s.get("transitions_view") == "details":
+            self.transitionsView = self.transitionsTreeView
             self.transitionsListView.hide()
-            self.transitionsTreeView.show()
-            self.transitionsTreeView.setFocus()
         else:
+            self.transitionsView = self.transitionsListView
             self.transitionsTreeView.hide()
-            self.transitionsListView.show()
-            self.transitionsListView.setFocus()
+        # Show our currently-enabled transitions view
+        self.transitionsView.show()
+        self.transitionsView.setFocus()
 
         # Setup effects tree
         self.effects_model = EffectsModel()
@@ -2655,13 +2657,14 @@ def __init__(self, mode=None):
         self.tabEffects.layout().insertWidget(-1, self.effectsTreeView)
         self.tabEffects.layout().insertWidget(-1, self.effectsListView)
         if s.get("effects_view") == "details":
+            self.effectsView = self.effectsTreeView
             self.effectsListView.hide()
-            self.effectsTreeView.show()
-            self.effectsTreeView.setFocus()
         else:
+            self.effectsView = self.effectsListView
             self.effectsTreeView.hide()
-            self.effectsListView.show()
-            self.effectsListView.setFocus()
+        # Show our currently-enabled effects view
+        self.effectsView.show()
+        self.effectsView.setFocus()
 
         # Setup emojis view
         self.emoji_model = EmojisModel()

src/windows/models/effects_model.py

@@ -27,8 +27,14 @@
 
 import os
 
-from PyQt5.QtCore import QMimeData, Qt, QSize, pyqtSignal, QSortFilterProxyModel
-from PyQt5.QtGui import *
+from PyQt5.QtCore import (
+    QObject, QMimeData, Qt, QSize, pyqtSignal,
+    QSortFilterProxyModel, QPersistentModelIndex, QItemSelectionModel,
+)
+from PyQt5.QtGui import (
+    QIcon, QPixmap,
+    QStandardItemModel, QStandardItem,
+)
 from PyQt5.QtWidgets import QMessageBox
 import openshot  # Python module for libopenshot (required video editing module installed separately)
 
@@ -38,11 +44,10 @@
 
 import json
 
-class EffectsStandardItemModel(QStandardItemModel):
-    ModelRefreshed = pyqtSignal()
 
+class EffectsProxyModel(QSortFilterProxyModel):
     def __init__(self, parent=None):
-        QStandardItemModel.__init__(self)
+        super().__init__(parent=parent)
 
     def mimeData(self, indexes):
         # Create MimeData for drag operation
@@ -60,7 +65,9 @@ def mimeData(self, indexes):
         return data
 
 
-class EffectsModel():
+class EffectsModel(QObject):
+    ModelRefreshed = pyqtSignal()
+
     def update_model(self, clear=True):
         log.info("updating effects model.")
         app = get_app()
@@ -188,20 +195,25 @@ def update_model(self, clear=True):
                 self.model_names[effect_name] = effect_name
 
         # Emit signal when model is updated
-        self.model.ModelRefreshed.emit()
+        self.ModelRefreshed.emit()
 
     def __init__(self, *args):
+        # Init QObject superclass
+        super().__init__(*args)
 
         # Create standard model
         self.app = get_app()
-        self.model = EffectsStandardItemModel()
+        self.model = QStandardItemModel()
         self.model.setColumnCount(5)
         self.model_names = {}
 
         # Create proxy model (for sorting and filtering)
-        self.proxy_model = QSortFilterProxyModel()
+        self.proxy_model = EffectsProxyModel()
         self.proxy_model.setDynamicSortFilter(False)
         self.proxy_model.setFilterCaseSensitivity(Qt.CaseInsensitive)
         self.proxy_model.setSortCaseSensitivity(Qt.CaseSensitive)
         self.proxy_model.setSourceModel(self.model)
         self.proxy_model.setSortLocaleAware(True)
+
+        # Create selection model to share between views
+        self.selection_model = QItemSelectionModel(self.proxy_model)

src/windows/models/files_model.py

@@ -27,41 +27,26 @@
  """
 
 import os
-
-from PyQt5.QtCore import QMimeData, Qt, pyqtSignal, QSortFilterProxyModel, QEventLoop
-from PyQt5.QtGui import *
-from PyQt5.QtWidgets import QMessageBox
-import openshot  # Python module for libopenshot (required video editing module installed separately)
-
+import json
+import re
+import glob
+
+from PyQt5.QtCore import (
+    QMimeData, Qt, pyqtSignal, QEventLoop, QObject,
+    QSortFilterProxyModel, QItemSelectionModel, QPersistentModelIndex,
+)
+from PyQt5.QtGui import (
+    QIcon, QStandardItem, QStandardItemModel
+)
 from classes import updates
 from classes import info
+from classes.image_types import is_image
 from classes.query import File
 from classes.logger import log
 from classes.app import get_app
 from requests import get
 
-import json
-
-class FileStandardItemModel(QStandardItemModel):
-    ModelRefreshed = pyqtSignal()
-
-    def __init__(self, parent=None):
-        QStandardItemModel.__init__(self)
-
-    def mimeData(self, indexes):
-        # Create MimeData for drag operation
-        data = QMimeData()
-
-        # Get list of all selected file ids
-        files = []
-        for item in indexes:
-            selected_row = self.itemFromIndex(item).row()
-            files.append(self.item(selected_row, 5).text())
-        data.setText(json.dumps(files))
-        data.setHtml("clip")
-
-        # Return Mimedata
-        return data
+import openshot
 
 
 class FileFilterProxyModel(QSortFilterProxyModel):
@@ -98,10 +83,32 @@ def filterAcceptsRow(self, sourceRow, sourceParent):
             return self.filterRegExp().indexIn(file_name) >= 0 or self.filterRegExp().indexIn(tags) >= 0
 
         # Continue running built-in parent filter logic
-        return super(FileFilterProxyModel, self).filterAcceptsRow(sourceRow, sourceParent)
+        return super().filterAcceptsRow(sourceRow, sourceParent)
 
+    def mimeData(self, indexes):
+        # Create MimeData for drag operation
+        data = QMimeData()
+
+        # Get list of all selected file ids
+        ids = self.parent.selected_file_ids()
+        data.setText(json.dumps(ids))
+        data.setHtml("clip")
+
+        # Return Mimedata
+        return data
+
+    def __init__(self, **kwargs):
+        if "parent" in kwargs:
+            self.parent = kwargs["parent"]
+            kwargs.pop("parent")
+
+        # Call base class implementation
+        super().__init__(**kwargs)
+
+
+class FilesModel(QObject, updates.UpdateInterface):
+    ModelRefreshed = pyqtSignal()
 
-class FilesModel(updates.UpdateInterface):
     # This method is invoked by the UpdateManager each time a change happens (i.e UpdateInterface)
     def changed(self, action):
 
@@ -246,7 +253,7 @@ def update_model(self, clear=True, delete_file_id=None):
         self.ignore_updates = False
 
         # Emit signal when model is updated
-        self.model.ModelRefreshed.emit()
+        self.ModelRefreshed.emit()
 
     def get_thumb_path(self, file_id, thumbnail_frame, clear_cache=False):
         """Get thumbnail path by invoking HTTP thumbnail request"""
@@ -287,31 +294,39 @@ def update_file_thumbnail(self, file_id):
                     item = self.model.itemFromIndex(thumb_index)
                     item.setIcon(QIcon(thumb_path))
                     item.setText(name)
+            # Emit signal when model is updated
+            self.ModelRefreshed.emit()
 
-                    # Emit signal when model is updated
-                    self.model.ModelRefreshed.emit()
-                    break
         self.ignore_updates = False
 
     def __init__(self, *args):
 
-        # Add self as listener to project data updates (undo/redo, as well as normal actions handled within this class all update the tree model)
+        # Add self as listener to project data updates
+        # (undo/redo, as well as normal actions handled within this class all update the model)
         app = get_app()
         app.updates.add_listener(self)
 
         # Create standard model
-        self.model = FileStandardItemModel()
+        self.model = QStandardItemModel()
         self.model.setColumnCount(6)
         self.model_ids = {}
         self.ignore_updates = False
 
+        self.ignore_image_sequence_paths = []
+
         # Create proxy model (for sorting and filtering)
-        self.proxy_model = FileFilterProxyModel()
+        self.proxy_model = FileFilterProxyModel(parent=self)
         self.proxy_model.setDynamicSortFilter(True)
         self.proxy_model.setFilterCaseSensitivity(Qt.CaseInsensitive)
         self.proxy_model.setSortCaseSensitivity(Qt.CaseSensitive)
         self.proxy_model.setSourceModel(self.model)
         self.proxy_model.setSortLocaleAware(True)
 
+        # Create selection model to share between views
+        self.selection_model = QItemSelectionModel(self.proxy_model)
+
         # Connect signal
         app.window.FileUpdated.connect(self.update_file_thumbnail)
+
+        # Call init for superclass QObject
+        super(QObject, FilesModel).__init__(self, *args)