Added emoji group drop-down filter, to better sort and filter, and a custom Proxy class for filtering. Also enabled locale aware sorting on listview and treeviews.

Author: jonoomph

src/windows/main_window.py

@@ -2216,10 +2216,12 @@ def setup_toolbars(self):
 
         # Add emojis toolbar
         self.emojisToolbar = QToolBar("Emojis Toolbar")
+        self.emojiFilterGroup = QComboBox()
         self.emojisFilter = QLineEdit()
         self.emojisFilter.setObjectName("emojisFilter")
         self.emojisFilter.setPlaceholderText(_("Filter"))
         self.emojisFilter.setClearButtonEnabled(True)
+        self.emojisToolbar.addWidget(self.emojiFilterGroup)
         self.emojisToolbar.addWidget(self.emojisFilter)
         self.tabEmojis.layout().addWidget(self.emojisToolbar)
 

src/windows/models/emoji_model.py

@@ -59,6 +59,30 @@ def mimeData(self, indexes):
         return data
 
 
+class EmojiFilterProxyModel(QSortFilterProxyModel):
+    """Proxy class used for sorting and filtering model data"""
+
+    def filterAcceptsRow(self, sourceRow, sourceParent):
+        """Filter for emoji groups and text filter"""
+
+        if get_app().window.emojiFilterGroup.currentData() and \
+                get_app().window.emojiFilterGroup.currentData() != "Show All":
+            # 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 emoji name
+            index = self.sourceModel().index(sourceRow, 0, sourceParent) # transition name column
+            emoji_name = self.sourceModel().data(index) # emoji name (i.e. Smiley Face)
+
+            # Return, if regExp match in displayed format.
+            return get_app().window.emojiFilterGroup.currentData() == group_name and \
+                   self.filterRegExp().indexIn(emoji_name) >= 0
+
+        # Continue running built-in parent filter logic
+        return super(EmojiFilterProxyModel, self).filterAcceptsRow(sourceRow, sourceParent)
+
+
 class EmojisModel():
     def update_model(self, clear=True):
         log.info("updating emoji model.")
@@ -88,13 +112,14 @@ def update_model(self, clear=True):
 
         # get a list of files in the OpenShot /emojis directory
         emojis_dir = os.path.join(info.PATH, "emojis", "color", "svg")
-        transition_groups = [{"type": "common", "dir": emojis_dir, "files": os.listdir(emojis_dir)}, ]
+        emoji_paths = [{"type": "common", "dir": emojis_dir, "files": os.listdir(emojis_dir)}, ]
+        emoji_groups = {}
 
         # Add optional user-defined transitions folder
         if os.path.exists(info.EMOJIS_PATH) and os.listdir(info.EMOJIS_PATH):
-            transition_groups.append({"type": "user", "dir": info.EMOJIS_PATH, "files": os.listdir(info.EMOJIS_PATH)})
+            emoji_paths.append({"type": "user", "dir": info.EMOJIS_PATH, "files": os.listdir(info.EMOJIS_PATH)})
 
-        for group in transition_groups:
+        for group in emoji_paths:
             type = group["type"]
             dir = group["dir"]
             files = group["files"]
@@ -109,9 +134,13 @@ def update_model(self, clear=True):
 
                 # get name of transition
                 emoji = emoji_lookup.get(fileBaseName, {})
-                emoji_name = emoji.get("annotation", fileBaseName)
+                emoji_name = _(emoji.get("annotation", fileBaseName).capitalize())
                 emoji_type = emoji.get("group", "user")
 
+                # Track unique emoji groups
+                if emoji_type not in emoji_groups.keys():
+                    emoji_groups[emoji_type] = emoji_type
+
                 # Check for thumbnail path (in build-in cache)
                 thumb_path = os.path.join(info.IMAGES_PATH, "cache",  "{}.png".format(fileBaseName))
 
@@ -152,6 +181,7 @@ def update_model(self, clear=True):
                 col.setIcon(QIcon(thumb_path))
                 col.setText(emoji_name)
                 col.setToolTip(emoji_name)
+                col.setData(emoji_type)
                 col.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled | Qt.ItemIsUserCheckable | Qt.ItemIsDragEnabled)
                 row.append(col)
 
@@ -181,6 +211,12 @@ def update_model(self, clear=True):
                     self.model.appendRow(row)
                     self.model_paths[path] = path
 
+        # Loop through emoji groups, and populate emoji filter drop-down
+        get_app().window.emojiFilterGroup.clear()
+        get_app().window.emojiFilterGroup.addItem(_("Show All"), "Show All")
+        for emoji_type in sorted(emoji_groups.keys()):
+            get_app().window.emojiFilterGroup.addItem(_(emoji_type.capitalize()), emoji_type)
+
     def __init__(self, *args):
 
         # Create standard model

src/windows/views/effects_listview.py

@@ -87,6 +87,7 @@ def __init__(self, model):
         self.proxy_model.setFilterCaseSensitivity(Qt.CaseInsensitive)
         self.proxy_model.setSortCaseSensitivity(Qt.CaseSensitive)
         self.proxy_model.setSourceModel(self.effects_model.model)
+        self.proxy_model.setSortLocaleAware(True)
 
         # Keep track of mouse press start position to determine when to start drag
         self.setAcceptDrops(True)

src/windows/views/effects_treeview.py

@@ -94,6 +94,7 @@ def __init__(self, model):
         self.proxy_model.setFilterCaseSensitivity(Qt.CaseInsensitive)
         self.proxy_model.setSortCaseSensitivity(Qt.CaseSensitive)
         self.proxy_model.setSourceModel(self.effects_model.model)
+        self.proxy_model.setSortLocaleAware(True)
 
         # Keep track of mouse press start position to determine when to start drag
         self.setAcceptDrops(True)

src/windows/views/emojis_listview.py

@@ -33,7 +33,7 @@
 import openshot  # Python module for libopenshot (required video editing module installed separately)
 from classes.query import File
 from classes.app import get_app
-from windows.models.emoji_model import EmojisModel
+from windows.models.emoji_model import EmojisModel, EmojiFilterProxyModel
 from classes.logger import log
 import json
 
@@ -131,11 +131,12 @@ def __init__(self, model):
         self.emojis_model = model
 
         # Create proxy model (for sorting and filtering)
-        self.proxy_model = QSortFilterProxyModel(self)
+        self.proxy_model = EmojiFilterProxyModel(self)
         self.proxy_model.setDynamicSortFilter(False)
         self.proxy_model.setFilterCaseSensitivity(Qt.CaseInsensitive)
         self.proxy_model.setSortCaseSensitivity(Qt.CaseSensitive)
         self.proxy_model.setSourceModel(self.emojis_model.model)
+        self.proxy_model.setSortLocaleAware(True)
 
         # Keep track of mouse press start position to determine when to start drag
         self.setAcceptDrops(True)
@@ -158,3 +159,4 @@ def __init__(self, model):
         # setup filter events
         app = get_app()
         app.window.emojisFilter.textChanged.connect(self.filter_changed)
+        app.window.emojiFilterGroup.currentIndexChanged.connect(self.filter_changed)

src/windows/views/files_listview.py

@@ -335,6 +335,7 @@ def __init__(self, model):
         self.proxy_model.setFilterCaseSensitivity(Qt.CaseInsensitive)
         self.proxy_model.setSortCaseSensitivity(Qt.CaseSensitive)
         self.proxy_model.setSourceModel(self.files_model.model)
+        self.proxy_model.setSortLocaleAware(True)
 
         # Keep track of mouse press start position to determine when to start drag
         self.setAcceptDrops(True)

src/windows/views/files_treeview.py

@@ -387,6 +387,7 @@ def __init__(self, model):
         self.proxy_model.setFilterCaseSensitivity(Qt.CaseInsensitive)
         self.proxy_model.setSortCaseSensitivity(Qt.CaseSensitive)
         self.proxy_model.setSourceModel(self.files_model.model)
+        self.proxy_model.setSortLocaleAware(True)
 
         # Keep track of mouse press start position to determine when to start drag
         self.setAcceptDrops(True)

src/windows/views/transitions_listview.py

@@ -91,6 +91,7 @@ def __init__(self, model):
         self.proxy_model.setFilterCaseSensitivity(Qt.CaseInsensitive)
         self.proxy_model.setSortCaseSensitivity(Qt.CaseSensitive)
         self.proxy_model.setSourceModel(self.transition_model.model)
+        self.proxy_model.setSortLocaleAware(True)
 
         # Keep track of mouse press start position to determine when to start drag
         self.setAcceptDrops(True)

src/windows/views/transitions_treeview.py

@@ -95,6 +95,7 @@ def __init__(self, model):
         self.proxy_model.setFilterCaseSensitivity(Qt.CaseInsensitive)
         self.proxy_model.setSortCaseSensitivity(Qt.CaseSensitive)
         self.proxy_model.setSourceModel(self.transition_model.model)
+        self.proxy_model.setSortLocaleAware(True)
 
         # Keep track of mouse press start position to determine when to start drag
         self.setAcceptDrops(True)