Convert transitions model to use proxy filter and sort class, with custom sort and filter function (which takes into account the group: common, extra, user) and the filter text. Also, moved the models outside of the widgets for Effects, Transitions, and Emojis.

jonoomph · jonoomph · commit 5690011dd2fa · 2020-03-31T22:19:14.000-05:00
diff --git a/src/windows/main_window.py b/src/windows/main_window.py
@@ -55,9 +55,12 @@
 from images import openshot_rc
 from windows.views.files_treeview import FilesTreeView
 from windows.views.files_listview import FilesListView
+from windows.models.transition_model import TransitionsModel
 from windows.views.transitions_treeview import TransitionsTreeView
 from windows.views.transitions_listview import TransitionsListView
+from windows.models.emoji_model import EmojisModel
 from windows.views.emojis_listview import EmojisListView
+from windows.models.effects_model import EffectsModel
 from windows.views.effects_treeview import EffectsTreeView
 from windows.views.effects_listview import EffectsListView
 from windows.views.properties_tableview import PropertiesTableView, SelectionLabel
@@ -1839,7 +1842,7 @@ def actionDetailsView_trigger(self, event):
             self.tabTransitions.layout().removeWidget(self.transitionsTreeView)
             self.transitionsTreeView.deleteLater()
             self.transitionsTreeView = None
-            self.transitionsTreeView = TransitionsTreeView(self)
+            self.transitionsTreeView = TransitionsTreeView(self.transition_model)
             self.tabTransitions.layout().addWidget(self.transitionsTreeView)
 
         # Effects
@@ -1848,7 +1851,7 @@ def actionDetailsView_trigger(self, event):
             self.tabEffects.layout().removeWidget(self.effectsTreeView)
             self.effectsTreeView.deleteLater()
             self.effectsTreeView = None
-            self.effectsTreeView = EffectsTreeView(self)
+            self.effectsTreeView = EffectsTreeView(self.effects_model)
             self.tabEffects.layout().addWidget(self.effectsTreeView)
 
     def actionThumbnailView_trigger(self, event):
@@ -1877,7 +1880,7 @@ def actionThumbnailView_trigger(self, event):
             self.tabTransitions.layout().removeWidget(self.transitionsTreeView)
             self.transitionsTreeView.deleteLater()
             self.transitionsTreeView = None
-            self.transitionsTreeView = TransitionsListView(self)
+            self.transitionsTreeView = TransitionsListView(self.transition_model)
             self.tabTransitions.layout().addWidget(self.transitionsTreeView)
 
         # Effects
@@ -1886,7 +1889,7 @@ def actionThumbnailView_trigger(self, event):
             self.tabEffects.layout().removeWidget(self.effectsTreeView)
             self.effectsTreeView.deleteLater()
             self.effectsTreeView = None
-            self.effectsTreeView = EffectsListView(self)
+            self.effectsTreeView = EffectsListView(self.effects_model)
             self.tabEffects.layout().addWidget(self.effectsTreeView)
 
     def resize_contents(self):
@@ -2550,21 +2553,24 @@ def __init__(self, mode=None):
         self.filesTreeView.setFocus()
 
         # Setup transitions tree
+        self.transition_model = TransitionsModel()
         if s.get("transitions_view") == "details":
-            self.transitionsTreeView = TransitionsTreeView(self)
+            self.transitionsTreeView = TransitionsTreeView(self.transition_model)
         else:
-            self.transitionsTreeView = TransitionsListView(self)
+            self.transitionsTreeView = TransitionsListView(self.transition_model)
         self.tabTransitions.layout().addWidget(self.transitionsTreeView)
 
         # Setup effects tree
+        self.effects_model = EffectsModel()
         if s.get("effects_view") == "details":
-            self.effectsTreeView = EffectsTreeView(self)
+            self.effectsTreeView = EffectsTreeView(self.effects_model)
         else:
-            self.effectsTreeView = EffectsListView(self)
+            self.effectsTreeView = EffectsListView(self.effects_model)
         self.tabEffects.layout().addWidget(self.effectsTreeView)
 
         # Setup emojis view
-        self.emojiListView = EmojisListView(self)
+        self.emoji_model = EmojisModel()
+        self.emojiListView = EmojisListView(self.emoji_model)
         self.tabEmojis.layout().addWidget(self.emojiListView)
 
         # Set up status bar
diff --git a/src/windows/models/transition_model.py b/src/windows/models/transition_model.py
@@ -27,7 +27,7 @@
 
 import os
 
-from PyQt5.QtCore import QMimeData, Qt
+from PyQt5.QtCore import QMimeData, Qt, QSortFilterProxyModel
 from PyQt5.QtGui import *
 from PyQt5.QtWidgets import QMessageBox
 import openshot  # Python module for libopenshot (required video editing module installed separately)
@@ -58,6 +58,37 @@ def mimeData(self, indexes):
         return data
 
 
+class TransitionFilterProxyModel(QSortFilterProxyModel):
+    """Proxy class used for sorting and filtering model data"""
+
+    def filterAcceptsRow(self, sourceRow, sourceParent):
+        """Filter for common transitions and text filter"""
+
+        if get_app().window.actionTransitionsShowCommon.isChecked():
+            # Fetch the group name
+            index = self.sourceModel().index(sourceRow, 2, sourceParent) # group name column
+            group_name = self.sourceModel().data(index) # group name (i.e. common)
+
+            # Fetch the transitions name
+            index = self.sourceModel().index(sourceRow, 0, sourceParent) # transition name column
+            trans_name = self.sourceModel().data(index) # transition name (i.e. Fade In)
+
+            # Return, if regExp match in displayed format.
+            return "common" == group_name and self.filterRegExp().indexIn(trans_name) >= 0
+
+        # Continue running built-in parent filter logic
+        return super(TransitionFilterProxyModel, self).filterAcceptsRow(sourceRow, sourceParent)
+
+    def lessThan(self, left, right):
+        """Sort with both group name and transition name"""
+        leftData = self.sourceModel().data(left)
+        leftGroup = self.sourceModel().data(left, 257) # Strange way to access 'type' column in model
+        rightData = self.sourceModel().data(right)
+        rightGroup = self.sourceModel().data(right, 257)
+
+        return leftGroup < rightGroup and leftData < rightData
+
+
 class TransitionsModel():
     def update_model(self, clear=True):
         log.info("updating transitions model.")
@@ -115,15 +146,6 @@ def update_model(self, clear=True):
                 else:
                     trans_name = self.app._tr(trans_name)
 
-                if not win.actionTransitionsShowAll.isChecked():
-                    if win.actionTransitionsShowCommon.isChecked():
-                        if not type == "common":
-                            continue  # to next file, didn't match filter
-
-                if win.transitionsFilter.text() != "":
-                    if not win.transitionsFilter.text().lower() in trans_name.lower():
-                        continue
-
                 # Check for thumbnail path (in build-in cache)
                 thumb_path = os.path.join(info.IMAGES_PATH, "cache",  "{}.png".format(fileBaseName))
 
@@ -164,6 +186,7 @@ def update_model(self, clear=True):
                 col.setIcon(QIcon(thumb_path))
                 col.setText(trans_name)
                 col.setToolTip(trans_name)
+                col.setData(type)
                 col.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled | Qt.ItemIsUserCheckable | Qt.ItemIsDragEnabled)
                 row.append(col)
 
diff --git a/src/windows/views/effects_listview.py b/src/windows/views/effects_listview.py
@@ -1,26 +1,26 @@
-""" 
+"""
  @file
  @brief This file contains the effects file listview, used by the main window
  @author Jonathan Thomas <jonathan@openshot.org>
- 
+
  @section LICENSE
- 
+
  Copyright (c) 2008-2018 OpenShot Studios, LLC
  (http://www.openshotstudios.com). This file is part of
  OpenShot Video Editor (http://www.openshot.org), an open-source project
  dedicated to delivering high quality video editing and animation solutions
  to the world.
- 
+
  OpenShot Video Editor 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, either version 3 of the License, or
  (at your option) any later version.
- 
+
  OpenShot Video Editor 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 OpenShot Library.  If not, see <http://www.gnu.org/licenses/>.
  """
@@ -67,15 +67,15 @@ def filter_changed(self):
     def refresh_view(self):
         self.effects_model.update_model()
 
-    def __init__(self, *args):
+    def __init__(self, model):
         # Invoke parent init
-        QListView.__init__(self, *args)
+        QListView.__init__(self)
 
         # Get a reference to the window object
         self.win = get_app().window
 
         # Get Model data
-        self.effects_model = EffectsModel()
+        self.effects_model = model
 
         # Keep track of mouse press start position to determine when to start drag
         self.setAcceptDrops(True)
diff --git a/src/windows/views/effects_treeview.py b/src/windows/views/effects_treeview.py
@@ -1,26 +1,26 @@
-""" 
+"""
  @file
  @brief This file contains the effects file treeview, used by the main window
  @author Jonathan Thomas <jonathan@openshot.org>
- 
+
  @section LICENSE
- 
+
  Copyright (c) 2008-2018 OpenShot Studios, LLC
  (http://www.openshotstudios.com). This file is part of
  OpenShot Video Editor (http://www.openshot.org), an open-source project
  dedicated to delivering high quality video editing and animation solutions
  to the world.
- 
+
  OpenShot Video Editor 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, either version 3 of the License, or
  (at your option) any later version.
- 
+
  OpenShot Video Editor 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 OpenShot Library.  If not, see <http://www.gnu.org/licenses/>.
  """
@@ -70,15 +70,15 @@ def refresh_view(self):
         self.hideColumn(3)
         self.hideColumn(4)
 
-    def __init__(self, *args):
+    def __init__(self, model):
         # Invoke parent init
-        QTreeView.__init__(self, *args)
+        QTreeView.__init__(self)
 
         # Get a reference to the window object
         self.win = get_app().window
 
         # Get Model data
-        self.effects_model = EffectsModel()
+        self.effects_model = model
 
         # Keep track of mouse press start position to determine when to start drag
         self.setAcceptDrops(True)
diff --git a/src/windows/views/emojis_listview.py b/src/windows/views/emojis_listview.py
@@ -114,20 +114,21 @@ def filter_changed(self):
         self.refresh_view()
 
     def refresh_view(self):
+        """Filter transitions with proxy class"""
         filter_text = self.win.emojisFilter.text()
         self.proxy_model.setFilterRegExp(QRegExp(filter_text.replace(' ', '.*')))
         self.proxy_model.setFilterCaseSensitivity(Qt.CaseInsensitive)
         self.proxy_model.sort(Qt.AscendingOrder)
 
-    def __init__(self, *args):
+    def __init__(self, model):
         # Invoke parent init
-        QListView.__init__(self, *args)
+        QListView.__init__(self)
 
         # Get a reference to the window object
         self.win = get_app().window
 
         # Get Model data
-        self.emojis_model = EmojisModel()
+        self.emojis_model = model
 
         # Create proxy model (for sorting and filtering)
         self.proxy_model = QSortFilterProxyModel(self)
diff --git a/src/windows/views/transitions_listview.py b/src/windows/views/transitions_listview.py
@@ -1,36 +1,36 @@
-""" 
+"""
  @file
  @brief This file contains the transitions file treeview, used by the main window
  @author Jonathan Thomas <jonathan@openshot.org>
- 
+
  @section LICENSE
- 
+
  Copyright (c) 2008-2018 OpenShot Studios, LLC
  (http://www.openshotstudios.com). This file is part of
  OpenShot Video Editor (http://www.openshot.org), an open-source project
  dedicated to delivering high quality video editing and animation solutions
  to the world.
- 
+
  OpenShot Video Editor 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, either version 3 of the License, or
  (at your option) any later version.
- 
+
  OpenShot Video Editor 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 OpenShot Library.  If not, see <http://www.gnu.org/licenses/>.
  """
 
-from PyQt5.QtCore import QSize, QPoint, Qt
+from PyQt5.QtCore import QSize, QPoint, Qt, QRegExp
 from PyQt5.QtGui import *
 from PyQt5.QtWidgets import QListView, QMenu
 
 from classes.app import get_app
-from windows.models.transition_model import TransitionsModel
+from windows.models.transition_model import TransitionsModel, TransitionFilterProxyModel
 
 import json
 
@@ -54,12 +54,12 @@ def startDrag(self, event):
         """ Override startDrag method to display custom icon """
 
         # Get image of selected item
-        selected_row = self.transition_model.model.itemFromIndex(self.selectionModel().selectedIndexes()[0]).row()
+        selected_row = self.transition_model.model.itemFromIndex(self.proxy_model.mapToSource(self.selectionModel().selectedIndexes()[0])).row()
         icon = self.transition_model.model.item(selected_row, 0).icon()
 
         # Start drag operation
         drag = QDrag(self)
-        drag.setMimeData(self.transition_model.model.mimeData(self.selectionModel().selectedIndexes()))
+        drag.setMimeData(self.proxy_model.mimeData(self.selectionModel().selectedIndexes()))
         # drag.setPixmap(QIcon.fromTheme('document-new').pixmap(QSize(self.drag_item_size,self.drag_item_size)))
         drag.setPixmap(icon.pixmap(QSize(self.drag_item_size, self.drag_item_size)))
         drag.setHotSpot(QPoint(self.drag_item_size / 2, self.drag_item_size / 2))
@@ -69,25 +69,36 @@ def filter_changed(self):
         self.refresh_view()
 
     def refresh_view(self):
-        self.transition_model.update_model()
+        """Filter transitions with proxy class"""
+        filter_text = self.win.transitionsFilter.text()
+        self.proxy_model.setFilterRegExp(QRegExp(filter_text.replace(' ', '.*')))
+        self.proxy_model.setFilterCaseSensitivity(Qt.CaseInsensitive)
+        self.proxy_model.sort(Qt.AscendingOrder)
 
-    def __init__(self, *args):
+    def __init__(self, model):
         # Invoke parent init
-        QListView.__init__(self, *args)
+        QListView.__init__(self)
 
         # Get a reference to the window object
         self.win = get_app().window
 
         # Get Model data
-        self.transition_model = TransitionsModel()
+        self.transition_model = model
+
+        # Create proxy model (for sorting and filtering)
+        self.proxy_model = TransitionFilterProxyModel(self)
+        self.proxy_model.setDynamicSortFilter(True)
+        self.proxy_model.setFilterCaseSensitivity(Qt.CaseInsensitive)
+        self.proxy_model.setSortCaseSensitivity(Qt.CaseSensitive)
+        self.proxy_model.setSourceModel(self.transition_model.model)
 
         # Keep track of mouse press start position to determine when to start drag
         self.setAcceptDrops(True)
         self.setDragEnabled(True)
         self.setDropIndicatorShown(True)
 
         # Setup header columns
-        self.setModel(self.transition_model.model)
+        self.setModel(self.proxy_model)
         self.setIconSize(QSize(131, 108))
         self.setGridSize(QSize(102, 92))
         self.setViewMode(QListView.IconMode)
@@ -97,8 +108,8 @@ def __init__(self, *args):
         self.setTextElideMode(Qt.ElideRight)
         self.setStyleSheet('QListView::item { padding-top: 2px; }')
 
-        # Refresh view
-        self.refresh_view()
+        # Load initial transition model data
+        self.transition_model.update_model()
 
         # setup filter events
         app = get_app()
diff --git a/src/windows/views/transitions_treeview.py b/src/windows/views/transitions_treeview.py
