feat(ui): add arrow key navigation and selection (#1542)

* feat(ui): arrow key navigation and selection in thumb grid

* refactor(ui): consolidate selection logic in `SelectionState`

* fix(ui): align selection behavior with other file managers

* fix(ui): prune removed entries from selection

* fix(ui): correctly set focus for thumb grid shortcuts

* fix(ui): move selection commands from edit to select menu

* feat(ui): arrow keys can move and select across adjacent pages

* chore: make list view comment a bit clearer

Author: CyanVoxel

src/tagstudio/core/library/alchemy/library.py

@@ -602,6 +602,19 @@ def get_entries(self, entry_ids: Iterable[int]) -> list[Entry]:
             entries = dict((e.id, e) for e in session.scalars(statement))
             return [entries[id] for id in entry_ids if id in entries]
 
+    def removed_entry_ids(self, entry_ids: Iterable[int]) -> set[int]:
+        """Return IDs from `entry_ids` that no longer exist in the library."""
+        entry_ids = list(entry_ids)
+        existing: set[int] = set()
+
+        with Session(self.engine) as session:
+            for sub_list in [
+                entry_ids[i : i + MAX_SQL_VARIABLES]
+                for i in range(0, len(entry_ids), MAX_SQL_VARIABLES)
+            ]:
+                existing.update(session.scalars(select(Entry.id).where(Entry.id.in_(sub_list))))
+        return set(entry_ids) - existing
+
     def get_entries_full(self, entry_ids: list[int] | set[int]) -> Iterator[Entry]:
         """Load entry and join with all joins and all tags."""
         with Session(self.engine) as session:

src/tagstudio/qt/controllers/inspector.py

@@ -50,7 +50,6 @@ def __init__(self, driver: QtDriver) -> None:
         self._driver = driver
         self._lib = self._driver.lib
         self._settings = self._driver.settings
-        self._selected: list[int] = []
         self._current_stats: FileAttributeData | None = None
 
         self._open_tag_search_action = QShortcut(
@@ -88,10 +87,12 @@ def _connect_callbacks(self) -> None:
         self.layout().preview_thumb.check_ffmpeg.connect(self._toggle_ffmpeg_warning)
 
         self._driver.entry_state.tags_changed.connect(self._on_tags_changed)
+        self._driver.selection.changed.connect(self.update_from_selection)
 
     def _on_tags_changed(self, entry_ids: set[int]) -> None:
-        if len(self._selected) == 1 and self._selected[0] in entry_ids:
-            self.layout().containers.update_from_entry(self._selected[0])
+        selected = self._driver.selection.selected
+        if len(selected) == 1 and selected[0] in entry_ids:
+            self.layout().containers.update_from_entry(selected[0])
             self.layout().tag_search_box.added = self.layout().containers.tags
 
     def _set_item_mode(self, mode: _ItemMode | None):
@@ -144,7 +145,8 @@ def _field_added_callback(self, query: str):
             self.layout().field_search_box.layout().search_field.setFocus()
 
     def _thumb_stats_updated_callback(self, filepath: Path, stats: FileAttributeData) -> None:
-        if len(self._selected) != 1:
+        selected = self._driver.selection.selected
+        if len(selected) != 1:
             return
 
         if filepath != self.layout().preview_thumb.current_file:
@@ -160,7 +162,7 @@ def _thumb_stats_updated_callback(self, filepath: Path, stats: FileAttributeData
         if stats.duration is not None:
             self._current_stats.duration = stats.duration
 
-        entry = unwrap(self._lib.get_entry(self._selected[0]))
+        entry = unwrap(self._lib.get_entry(selected[0]))
         self.layout().file_attrs.update_stats(filepath, self._current_stats, entry)
 
     def _set_selection_callback(self) -> None:
@@ -174,9 +176,10 @@ def _set_selection_callback(self) -> None:
     def _add_field_to_selected(self, template: BaseFieldTemplate) -> None:
         self.layout().containers.add_field_to_selected(template)
         # TODO: Allow editing of fields across multiple entries at once.
-        if len(self._selected) == 1:
+        selected = self._driver.selection.selected
+        if len(selected) == 1:
             if self._driver.settings.edit_field_on_add:
-                entry = unwrap(self._lib.get_entry_full(self._selected[0]))
+                entry = unwrap(self._lib.get_entry_full(selected[0]))
                 entry_field = None
                 if isinstance(template, TextFieldTemplate):
                     entry_field = entry.text_fields[-1]
@@ -185,7 +188,7 @@ def _add_field_to_selected(self, template: BaseFieldTemplate) -> None:
                 if entry_field is not None:
                     self._edit_field(entry.id, entry_field)
 
-            self.layout().containers.update_from_entry(self._selected[0])
+            self.layout().containers.update_from_entry(selected[0])
 
     def _edit_field(self, entry_id: int, field: BaseField) -> None:
         # TODO: A lot of this code is similar to or straight up shared with TileList.
@@ -225,15 +228,14 @@ def _toggle_ffmpeg_warning(self, enable_warning: bool = True) -> None:
 
         self.layout().warning_banner.hide()
 
-    def set_selection(self, selected: list[int], update_preview: bool = True) -> None:
-        """Render the panel widgets with the newest data from the Library.
+    def update_from_selection(self, update_preview: bool = True) -> None:
+        """Update the panel widgets with the selected entries' newest data from the Library.
 
         Args:
-            selected  (list[int]): List of the IDs of the selected entries.
             update_preview (bool): Should the file preview be updated?
             (Only works with one or more items selected)
         """
-        self._selected = selected
+        selected = self._driver.selection.selected
         self._set_item_mode(None)
         try:
             # No Items Selected

src/tagstudio/qt/controllers/item_thumb.py

@@ -143,10 +143,11 @@ def _on_delete(self) -> None:
             self._driver.delete_files_callback(self._item_path, self.item_id)
 
     def _toggle_item_selection(self) -> None:
-        self._driver.toggle_item_selection(
+        modifiers = QGuiApplication.keyboardModifiers()
+        self._driver.selection.toggle_item_selection(
             self.item_id,
-            append=(QGuiApplication.keyboardModifiers() == Qt.KeyboardModifier.ControlModifier),
-            bridge=(QGuiApplication.keyboardModifiers() == Qt.KeyboardModifier.ShiftModifier),
+            append=bool(modifiers & Qt.KeyboardModifier.ControlModifier),
+            bridge=bool(modifiers & Qt.KeyboardModifier.ShiftModifier),
         )
 
     def _image_rect(self) -> QRect:
@@ -343,7 +344,7 @@ def _show_check_badges(self, show: bool):
                 badge.setHidden(not (show or badge.isChecked()))
 
     def _on_badge_check(self, tag_id: int):
-        selected = self._driver.selected
+        selected = self._driver.selection.selected
         entry_ids = selected if self.item_id in selected else [self.item_id]
         is_checked = self.layout().badges[tag_id].isChecked()
         self._driver.entry_state.set_tag(entry_ids, tag_id, is_checked)
@@ -353,7 +354,7 @@ def _start_drag(self) -> None:
         paths: list[QUrl] = []
         mimedata = QMimeData()
 
-        selected_ids = self._driver.selected
+        selected_ids = self._driver.selection.selected
 
         for entry_id in selected_ids:
             entry = self._lib.get_entry(entry_id)
@@ -444,11 +445,11 @@ def mousePressEvent(self, event: QMouseEvent) -> None:
             return super().mousePressEvent(event)
 
         self._press_pos = pos
-        ctrl = QGuiApplication.keyboardModifiers() == Qt.KeyboardModifier.ControlModifier
+        ctrl = bool(QGuiApplication.keyboardModifiers() & Qt.KeyboardModifier.ControlModifier)
         self._select_on_release = False
         if ctrl or not self._selected:
             self._toggle_item_selection()
-        elif len(self._driver.selected) > 1:
+        elif len(self._driver.selection.selected) > 1:
             # Wait for release so clicking a selected item can still drag the existing selection
             self._select_on_release = True
 
@@ -478,6 +479,8 @@ def contextMenuEvent(self, event: QContextMenuEvent) -> None:
         if self._item_path is None or not self._image_rect().contains(event.pos()):
             return super().contextMenuEvent(event)
 
+        if not self._selected:
+            self._driver.selection.toggle_item_selection(self.item_id, append=False, bridge=False)
         view = self.layout()
         QMenu.exec(
             [view.open_file_action, view.open_explorer_action, view.delete_action],

src/tagstudio/qt/controllers/main_window.py

@@ -68,9 +68,6 @@ class MainMenuBar(QMenuBar):
 
     edit_menu: QMenu
     new_tag_action: QAction
-    select_all_action: QAction
-    select_inverse_action: QAction
-    clear_select_action: QAction
     copy_fields_action: QAction
     paste_fields_action: QAction
     add_tag_to_selected_action: QAction
@@ -80,6 +77,11 @@ class MainMenuBar(QMenuBar):
     field_template_manager_action: QAction
     color_manager_action: QAction
 
+    select_menu: QMenu
+    select_all_action: QAction
+    clear_select_action: QAction
+    select_inverse_action: QAction
+
     view_menu: QMenu
     show_filenames_action: QAction
 
@@ -101,6 +103,7 @@ def __init__(self, parent: QWidget | None = None):
 
         self.setup_file_menu()
         self.setup_edit_menu()
+        self.setup_select_menu()
         self.setup_view_menu()
         self.setup_tools_menu()
         self.setup_macros_menu()
@@ -193,39 +196,6 @@ def setup_edit_menu(self):
 
         self.edit_menu.addSeparator()
 
-        # Select All
-        self.select_all_action = QAction(Translations["select.all"], self)
-        self.select_all_action.setShortcut(
-            QtCore.QKeyCombination(
-                QtCore.Qt.KeyboardModifier(QtCore.Qt.KeyboardModifier.ControlModifier),
-                QtCore.Qt.Key.Key_A,
-            )
-        )
-        self.select_all_action.setToolTip("Ctrl+A")
-        self.select_all_action.setEnabled(False)
-        self.edit_menu.addAction(self.select_all_action)
-
-        # Invert Selection
-        self.select_inverse_action = QAction(Translations["select.inverse"], self)
-        self.select_inverse_action.setShortcut(
-            QtCore.QKeyCombination(
-                QtCore.Qt.KeyboardModifier(
-                    QtCore.Qt.KeyboardModifier.ControlModifier
-                    ^ QtCore.Qt.KeyboardModifier.ShiftModifier
-                ),
-                QtCore.Qt.Key.Key_I,
-            )
-        )
-        self.select_inverse_action.setToolTip("Ctrl+Shift+I")
-        self.select_inverse_action.setEnabled(False)
-        self.edit_menu.addAction(self.select_inverse_action)
-
-        # Clear Selection
-        self.clear_select_action = QAction(Translations["select.clear"], self)
-        self.clear_select_action.setEnabled(False)
-        self.clear_select_action.setToolTip("Esc")
-        self.edit_menu.addAction(self.clear_select_action)
-
         # Copy Fields
         self.copy_fields_action = QAction(Translations["edit.copy_fields"], self)
         self.copy_fields_action.setShortcut(
@@ -310,6 +280,45 @@ def setup_edit_menu(self):
         assign_mnemonics(self.edit_menu)
         self.addMenu(self.edit_menu)
 
+    def setup_select_menu(self):
+        self.select_menu = QMenu(Translations["menu.select"], self)
+
+        # Select All
+        self.select_all_action = QAction(Translations["select.all"], self)
+        self.select_all_action.setShortcut(
+            QtCore.QKeyCombination(
+                QtCore.Qt.KeyboardModifier(QtCore.Qt.KeyboardModifier.ControlModifier),
+                QtCore.Qt.Key.Key_A,
+            )
+        )
+        self.select_all_action.setToolTip("Ctrl+A")
+        self.select_all_action.setEnabled(False)
+        self.select_menu.addAction(self.select_all_action)
+
+        # Clear Selection
+        self.clear_select_action = QAction(Translations["select.clear"], self)
+        self.clear_select_action.setEnabled(False)
+        self.clear_select_action.setToolTip("Esc")
+        self.select_menu.addAction(self.clear_select_action)
+
+        # Invert Selection
+        self.select_inverse_action = QAction(Translations["select.inverse"], self)
+        self.select_inverse_action.setShortcut(
+            QtCore.QKeyCombination(
+                QtCore.Qt.KeyboardModifier(
+                    QtCore.Qt.KeyboardModifier.ControlModifier
+                    ^ QtCore.Qt.KeyboardModifier.ShiftModifier
+                ),
+                QtCore.Qt.Key.Key_I,
+            )
+        )
+        self.select_inverse_action.setToolTip("Ctrl+Shift+I")
+        self.select_inverse_action.setEnabled(False)
+        self.select_menu.addAction(self.select_inverse_action)
+
+        assign_mnemonics(self.select_menu)
+        self.addMenu(self.select_menu)
+
     def setup_view_menu(self):
         self.view_menu = QMenu(Translations["menu.view"], self)