Title Editor: Model & program flow tweaks

- New model design uses only a single column, all data for each
  template is stored on the same QStandardItem under different roles
- TitleRoles.PathRole references the file path (former column 2)
- Dialog now preserves user-supplied filename across launches of the
  external Advanced Editor process
- TitlesModel is now a QObject, parented to MainWindow

Author: ferdnyc

src/windows/main_window.py

@@ -416,14 +416,9 @@ def actionTitle_trigger(self):
         from windows.title_editor import TitleEditor
         win = TitleEditor()
         # Run the dialog event loop - blocking interaction on this window during that time
-        result = win.exec_()
-        if result == QDialog.Accepted:
-            log.info('title editor add confirmed')
-        else:
-            log.info('title editor add cancelled')
+        win.exec_()
 
     def actionEditTitle_trigger(self):
-
         # Loop through selected files (set 1 selected file if more than 1)
         for f in self.selected_files():
             if f.data.get("path").endswith(".svg"):
@@ -436,7 +431,7 @@ def actionEditTitle_trigger(self):
 
         # show dialog for editing title
         from windows.title_editor import TitleEditor
-        win = TitleEditor(file_path)
+        win = TitleEditor(edit_file_path=file_path)
         # Run the dialog event loop - blocking interaction on this window during that time
         win.exec_()
 
@@ -470,7 +465,7 @@ def actionDuplicateTitle_trigger(self):
 
         # show dialog for editing title
         from windows.title_editor import TitleEditor
-        win = TitleEditor(file_path, duplicate=True)
+        win = TitleEditor(edit_file_path=file_path, duplicate=True)
         # Run the dialog event loop - blocking interaction on this window during that time
         return win.exec_()
 

src/windows/models/titles_model.py

@@ -28,8 +28,8 @@
 import os
 import fnmatch
 
-from PyQt5.QtCore import QMimeData, Qt, QSize
-from PyQt5.QtGui import QStandardItemModel, QStandardItem, QIcon, QPixmap
+from PyQt5.QtCore import Qt, QObject, QMimeData
+from PyQt5.QtGui import QStandardItemModel, QStandardItem, QIcon
 from PyQt5.QtWidgets import QMessageBox
 import openshot  # Python module for libopenshot (required video editing module installed separately)
 
@@ -41,52 +41,56 @@
 
 
 class TitleStandardItemModel(QStandardItemModel):
-    def __init__(self, parent=None):
-        QStandardItemModel.__init__(self)
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.setObjectName("titles.model")
 
     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, 2).text())
+        files = [
+            self.itemFromIndex(i).data(TitleRoles.PathRole)
+            for i in indexes
+        ]
         data.setText(json.dumps(files))
         data.setHtml("title")
 
         # Return Mimedata
         return data
 
 
-class TitlesModel():
-    def update_model(self, clear=True):
-        log.info("updating title model.")
-        app = get_app()
+class TitleRoles:
+    PathRole = Qt.UserRole + 11
+
 
-        _ = app._tr
+class TitlesModel(QObject):
+    def update_model(self, clear=True):
+        log.debug("Updating title model")
+        # Get window to check filters
+        _ = self.app._tr
 
         # Clear all items
         if clear:
             self.model_paths = {}
             self.model.clear()
 
         # Add Headers
-        self.model.setHorizontalHeaderLabels([_("Thumb"), _("Name")])
+        self.model.setHorizontalHeaderLabels([_("Name")])
 
-        # get a list of files in the OpenShot /transitions directory
+        # get a list of files in the OpenShot package directory
         titles_dir = os.path.join(info.PATH, "titles")
-
-        # Add build-in templates
-        titles_list = []
-        for filename in sorted(os.listdir(titles_dir)):
-            titles_list.append(os.path.join(titles_dir, filename))
-
+        titles_list = [
+            os.path.join(titles_dir, filename)
+            for filename in sorted(os.listdir(titles_dir))
+            ]
         # Add user-defined titles (if any)
-        for filename in sorted(os.listdir(info.USER_TITLES_PATH)):
-            if fnmatch.fnmatch(filename, '*.svg'):
-                titles_list.append(os.path.join(info.USER_TITLES_PATH, filename))
+        titles_list.extend([
+            os.path.join(info.USER_TITLES_PATH, filename)
+            for filename in sorted(os.listdir(info.USER_TITLES_PATH))
+            if fnmatch.fnmatch(filename, '*.svg')
+            ])
 
         for path in sorted(titles_list):
             filename = os.path.basename(path)
@@ -116,78 +120,62 @@ def update_model(self, clear=True):
 
             # Check for thumbnail path (in build-in cache)
             thumb_path = os.path.join(info.IMAGES_PATH, "cache", "{}.png".format(fileBaseName))
-
-            # Check built-in cache (if not found)
             if not os.path.exists(thumb_path):
-                # Check user folder cache
+                # Check user folder cache (if not found)
                 thumb_path = os.path.join(info.CACHE_PATH, "{}.png".format(fileBaseName))
-
-            # Generate thumbnail (if needed)
             if not os.path.exists(thumb_path):
-
+                # Generate thumbnail (if needed)
                 try:
                     # Reload this reader
                     clip = openshot.Clip(path)
                     reader = clip.Reader()
-
-                    # Open reader
                     reader.Open()
 
-                    # Save thumbnail
+                    # Save thumbnail to disk
                     reader.GetFrame(0).Thumbnail(
                         thumb_path, 98, 64,
                         os.path.join(info.IMAGES_PATH, "mask.png"),
                         "", "#000", True, "png", 85
                     )
                     reader.Close()
                     clip.Close()
-
                 except Exception as ex:
-                    # Handle exception
                     log.info('Failed to open {} as title: {}'.format(filename, ex))
                     msg = QMessageBox()
                     msg.setText(_("%s is not a valid image file." % filename))
                     msg.exec_()
                     continue
-
-            row = []
-
-            # Append thumbnail
-            col = QStandardItem()
-            icon_pixmap = QPixmap(thumb_path)
-            scaled_pixmap = icon_pixmap.scaled(QSize(93, 62), Qt.IgnoreAspectRatio, Qt.SmoothTransformation)
-            col.setIcon(QIcon(scaled_pixmap))
-            col.setText(title_name)
-            col.setToolTip(title_name)
-            col.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled | Qt.ItemIsUserCheckable | Qt.ItemIsDragEnabled)
-            row.append(col)
-
-            # Append Filename
-            col = QStandardItem("Name")
-            col.setData(title_name, Qt.DisplayRole)
-            col.setText(title_name)
-            col.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled | Qt.ItemIsUserCheckable | Qt.ItemIsDragEnabled)
-            row.append(col)
-
-            # Append Path
-            col = QStandardItem("Path")
-            col.setData(path, Qt.DisplayRole)
-            col.setText(path)
-            col.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled | Qt.ItemIsUserCheckable | Qt.ItemIsDragEnabled)
-            row.append(col)
-
-            # Append ROW to MODEL (if does not already exist in model)
+            # Create item entry for model
+            flags = Qt.ItemIsSelectable | Qt.ItemIsEnabled | Qt.ItemIsUserCheckable | Qt.ItemIsDragEnabled
+            item = QStandardItem(QIcon(thumb_path), title_name)
+            item.setData(path, TitleRoles.PathRole)
+            item.setToolTip(title_name)
+            item.setFlags(flags)
+            # Append to MODEL (if does not already exist)
             if path not in self.model_paths:
-                self.model.appendRow(row)
+                self.model.appendRow([item])
                 self.model_paths[path] = path
 
             # Process events in QT (to keep the interface responsive)
-            app.processEvents()
-
-    def __init__(self, *args):
+            self.app.processEvents()
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.setObjectName("TitlesModel")
         # Create standard model
         self.app = get_app()
-        self.model = TitleStandardItemModel()
-        self.model.setColumnCount(3)
+        self.model = TitleStandardItemModel(self.parent())
+        self.model.setColumnCount(1)
         self.model_paths = {}
+
+        # Attempt to load model testing interface, if requested
+        # (will only succeed with Qt 5.11+)
+        if info.MODEL_TEST:
+            try:
+                # Create model tester objects
+                from PyQt5.QtTest import QAbstractItemModelTester
+                QAbstractItemModelTester(
+                    self.model, QAbstractItemModelTester.FailureReportingMode.Warning)
+                log.info("Enabled model tests for title editor data")
+            except ImportError:
+                pass