Add Cmd+W close shortcut (on Mac) to more dialogs (#3905)

* Enable Cmd+W shortcut in "Edit Current" on Mac

* Enable Cmd+W shortcut in "Fields" editor on Mac

* Enable Cmd+W shortcut in "Cards" editing on Mac

* Enable Cmd+W shortcut in "Sync" tab modal on Mac

* Enable Cmd+W shortcut in "Custom Study" tab modal on Mac

* Enable Cmd+W shortcut in Settings view on Mac

* Enable Cmd+W shortcut in Export dialogs on Mac

* Enable Cmd+W shortcut for getText dialog on Mac

* Enable Cmd+W shortcut in "Change Deck" on Mac

* Enable Cmd+W shortcut in Reposition dialog on Mac

* Enable Cmd+W shortcut in "Grade Now" dialog on Mac

* Enable Cmd+W shortcut in "Reset…" dialog on Mac

* Remove duplicate camelCase variant of add_close_shortcut (dae)

- The camelCase variant will remain accessible with a warning.
- The removed setattr line is legacy cruft, and wasn't doing anything.

Author: beyondcompute

qt/aqt/addons.py

@@ -40,7 +40,7 @@
 from aqt.log import ADDON_LOGGER_PREFIX, find_addon_logger, get_addon_logs_folder
 from aqt.qt import *
 from aqt.utils import (
-    addCloseShortcut,
+    add_close_shortcut,
     askUser,
     disable_help_button,
     getFile,
@@ -829,7 +829,7 @@ def __init__(self, addonsManager: AddonManager) -> None:
         self.setAcceptDrops(True)
         self.redrawAddons()
         restoreGeom(self, "addons")
-        addCloseShortcut(self)
+        add_close_shortcut(self)
         gui_hooks.addons_dialog_will_show(self)
         self._onAddonSelectionChanged()
         self.show()

qt/aqt/browser/browser.py

@@ -57,6 +57,7 @@
 from aqt.utils import (
     HelpPage,
     KeyboardModifiersPressed,
+    add_close_shortcut,
     add_ellipsis_to_action_label,
     current_window,
     ensure_editor_saved,
@@ -1092,6 +1093,7 @@ def grade_now(self) -> None:
         dialog.setWindowTitle(tr.actions_grade_now())
         layout = QHBoxLayout()
         dialog.setLayout(layout)
+        add_close_shortcut(dialog)
 
         # Add grade buttons
         for ease, label in [

qt/aqt/browser/card_info.py

@@ -14,7 +14,7 @@
 from anki.lang import without_unicode_isolation
 from aqt.qt import *
 from aqt.utils import (
-    addCloseShortcut,
+    add_close_shortcut,
     disable_help_button,
     qconnect,
     restoreGeom,
@@ -53,7 +53,7 @@ def _setup_ui(self, card_id: CardId | None) -> None:
         self.mw.garbage_collect_on_dialog_finish(self)
         disable_help_button(self)
         restoreGeom(self, self.GEOMETRY_KEY, default_size=(800, 800))
-        addCloseShortcut(self)
+        add_close_shortcut(self)
         setWindowIcon(self)
 
         self.web: AnkiWebView | None = AnkiWebView(

qt/aqt/changenotetype.py

@@ -15,7 +15,7 @@
 from aqt.operations.notetype import change_notetype_of_notes
 from aqt.qt import *
 from aqt.utils import (
-    addCloseShortcut,
+    add_close_shortcut,
     disable_help_button,
     restoreGeom,
     saveGeom,
@@ -49,7 +49,7 @@ def _setup_ui(self, notetype_id: NotetypeId) -> None:
         self.setMinimumSize(400, 300)
         disable_help_button(self)
         restoreGeom(self, self.TITLE, default_size=(800, 800))
-        addCloseShortcut(self)
+        add_close_shortcut(self)
 
         self.web = AnkiWebView(kind=AnkiWebViewKind.CHANGE_NOTETYPE)
         self.web.setVisible(False)

qt/aqt/clayout.py

@@ -27,6 +27,7 @@
 from aqt.theme import theme_manager
 from aqt.utils import (
     HelpPage,
+    add_close_shortcut,
     ask_user_dialog,
     askUser,
     disable_help_button,
@@ -90,6 +91,7 @@ def __init__(
         gui_hooks.card_layout_will_show(self)
         self.redraw_everything()
         restoreGeom(self, "CardLayout")
+        add_close_shortcut(self)
         restoreSplitter(self.mainArea, "CardLayoutMainArea")
         self.setWindowModality(Qt.WindowModality.ApplicationModal)
         self.show()

qt/aqt/customstudy.py

@@ -15,7 +15,7 @@
 from aqt.operations.scheduling import custom_study
 from aqt.qt import *
 from aqt.taglimit import TagLimit
-from aqt.utils import disable_help_button, tr
+from aqt.utils import add_close_shortcut, disable_help_button, tr
 
 RADIO_NEW = 1
 RADIO_REV = 2
@@ -63,6 +63,7 @@ def __init__(
         self.form.setupUi(self)
         disable_help_button(self)
         self.setupSignals()
+        add_close_shortcut(self)
         self.form.radioNew.click()
         self.open()
 

qt/aqt/deckdescription.py

@@ -10,7 +10,7 @@
 from aqt.operations import QueryOp
 from aqt.operations.deck import update_deck_dict
 from aqt.qt import *
-from aqt.utils import addCloseShortcut, disable_help_button, restoreGeom, saveGeom, tr
+from aqt.utils import add_close_shortcut, disable_help_button, restoreGeom, saveGeom, tr
 
 
 class DeckDescriptionDialog(QDialog):
@@ -45,7 +45,7 @@ def _setup_ui(self) -> None:
         self.setMinimumWidth(400)
         disable_help_button(self)
         restoreGeom(self, self.TITLE)
-        addCloseShortcut(self)
+        add_close_shortcut(self)
 
         box = QVBoxLayout()
 

qt/aqt/deckoptions.py

@@ -13,7 +13,7 @@
 from aqt.qt import *
 from aqt.utils import (
     KeyboardModifiersPressed,
-    addCloseShortcut,
+    add_close_shortcut,
     disable_help_button,
     restoreGeom,
     saveGeom,
@@ -42,7 +42,7 @@ def _setup_ui(self) -> None:
         self.setMinimumWidth(400)
         disable_help_button(self)
         restoreGeom(self, self.TITLE, default_size=(800, 800))
-        addCloseShortcut(self)
+        add_close_shortcut(self)
 
         self.web = AnkiWebView(kind=AnkiWebViewKind.DECK_OPTIONS)
         self.web.load_sveltekit_page(f"deck-options/{self._deck['id']}")

qt/aqt/editcurrent.py

@@ -9,7 +9,7 @@
 from anki.errors import NotFoundError
 from aqt import gui_hooks
 from aqt.qt import *
-from aqt.utils import restoreGeom, saveGeom, tr
+from aqt.utils import add_close_shortcut, restoreGeom, saveGeom, tr
 
 
 class EditCurrent(QMainWindow):
@@ -36,6 +36,7 @@ def __init__(self, mw: aqt.AnkiQt) -> None:
         close_button = self.form.buttonBox.button(QDialogButtonBox.StandardButton.Close)
         assert close_button is not None
         close_button.setShortcut(QKeySequence("Ctrl+Return"))
+        add_close_shortcut(self)
         # qt5.14+ doesn't handle numpad enter on Windows
         self.compat_add_shorcut = QShortcut(QKeySequence("Ctrl+Enter"), self)
         qconnect(self.compat_add_shorcut.activated, close_button.click)

qt/aqt/exporting.py

@@ -19,6 +19,7 @@
 from aqt.errors import show_exception
 from aqt.qt import *
 from aqt.utils import (
+    add_close_shortcut,
     checkInvalidFilename,
     disable_help_button,
     getSaveFile,
@@ -46,6 +47,7 @@ def __init__(
         self.cids = cids
         disable_help_button(self)
         self.setup(did)
+        add_close_shortcut(self)
         self.exec()
 
     def setup(self, did: DeckId | None) -> None:

qt/aqt/fields.py

@@ -15,6 +15,7 @@
 from aqt.schema_change_tracker import ChangeTracker
 from aqt.utils import (
     HelpPage,
+    add_close_shortcut,
     askUser,
     disable_help_button,
     getOnlyText,
@@ -50,6 +51,7 @@ def __init__(
             without_unicode_isolation(tr.fields_fields_for(val=self.model["name"]))
         )
 
+        add_close_shortcut(self)
         disable_help_button(self)
         help_button = self.form.buttonBox.button(QDialogButtonBox.StandardButton.Help)
         assert help_button is not None

qt/aqt/import_export/exporting.py

@@ -27,6 +27,7 @@
 from aqt.progress import ProgressUpdate
 from aqt.qt import *
 from aqt.utils import (
+    add_close_shortcut,
     checkInvalidFilename,
     disable_help_button,
     getSaveFile,
@@ -53,6 +54,7 @@ def __init__(
         self.nids = nids
         disable_help_button(self)
         self.setup(did)
+        add_close_shortcut(self)
         self.open()
 
     def setup(self, did: DeckId | None) -> None:

qt/aqt/import_export/import_dialog.py

@@ -12,7 +12,7 @@
 import aqt.main
 import aqt.operations
 from aqt.qt import *
-from aqt.utils import addCloseShortcut, disable_help_button, restoreGeom, saveGeom, tr
+from aqt.utils import add_close_shortcut, disable_help_button, restoreGeom, saveGeom, tr
 from aqt.webview import AnkiWebView, AnkiWebViewKind
 
 
@@ -62,7 +62,7 @@ def _setup_ui(self) -> None:
         self.setMinimumSize(*self.MIN_SIZE)
         disable_help_button(self)
         restoreGeom(self, self.args.title, default_size=self.DEFAULT_SIZE)
-        addCloseShortcut(self)
+        add_close_shortcut(self)
 
         self.web: AnkiWebView | None = AnkiWebView(kind=self.args.kind)
         self.web.setVisible(False)

qt/aqt/operations/scheduling.py

@@ -24,7 +24,7 @@
 from anki.scheduler.v3 import Scheduler as V3Scheduler
 from aqt.operations import CollectionOp
 from aqt.qt import *
-from aqt.utils import disable_help_button, getText, tooltip, tr
+from aqt.utils import add_close_shortcut, disable_help_button, getText, tooltip, tr
 
 
 def set_due_date_dialog(
@@ -104,6 +104,7 @@ def forget_cards(
 
     dialog = QDialog(parent)
     disable_help_button(dialog)
+    add_close_shortcut(dialog)
     form = aqt.forms.forget.Ui_Dialog()
     form.setupUi(dialog)
 
@@ -153,6 +154,7 @@ def reposition_new_cards_dialog(
 
     dialog = QDialog(parent)
     disable_help_button(dialog)
+    add_close_shortcut(dialog)
     dialog.setWindowModality(Qt.WindowModality.WindowModal)
     form = aqt.forms.reposition.Ui_Dialog()
     form.setupUi(dialog)

qt/aqt/preferences.py

@@ -22,6 +22,7 @@
 from aqt.theme import Theme
 from aqt.utils import (
     HelpPage,
+    add_close_shortcut,
     askUser,
     disable_help_button,
     is_win,
@@ -64,6 +65,7 @@ def __init__(self, mw: AnkiQt) -> None:
         self.setup_profile()
         self.setup_global()
         self.setup_configurable_answer_keys()
+        add_close_shortcut(self)
         self.show()
 
     def setup_configurable_answer_keys(self):

qt/aqt/stats.py

@@ -16,7 +16,7 @@
 from aqt.qt import *
 from aqt.theme import theme_manager
 from aqt.utils import (
-    addCloseShortcut,
+    add_close_shortcut,
     disable_help_button,
     getSaveFile,
     maybeHideClose,
@@ -69,7 +69,7 @@ def __init__(self, mw: aqt.main.AnkiQt) -> None:
         assert b is not None
         b.setAutoDefault(False)
         maybeHideClose(self.form.buttonBox)
-        addCloseShortcut(self)
+        add_close_shortcut(self)
         gui_hooks.stats_dialog_will_show(self)
         self.form.web.hide_while_preserving_layout()
         self.show()
@@ -182,7 +182,7 @@ def __init__(self, mw: aqt.main.AnkiQt) -> None:
         qconnect(f.year.clicked, lambda: self.changePeriod(1))
         qconnect(f.life.clicked, lambda: self.changePeriod(2))
         maybeHideClose(self.form.buttonBox)
-        addCloseShortcut(self)
+        add_close_shortcut(self)
         gui_hooks.stats_dialog_old_will_show(self)
         self.show()
         self.refresh()

qt/aqt/studydeck.py

@@ -16,6 +16,7 @@
 from aqt.utils import (
     HelpPage,
     HelpPageArgument,
+    add_close_shortcut,
     disable_help_button,
     openHelp,
     restoreGeom,
@@ -52,6 +53,7 @@ def __init__(
         gui_hooks.state_did_reset.append(self.onReset)
         self.geomKey = f"studyDeck-{geomKey}"
         restoreGeom(self, self.geomKey)
+        add_close_shortcut(self)
         disable_help_button(self)
         if not cancel:
             self.form.buttonBox.removeButton(

qt/aqt/sync.py

@@ -28,6 +28,7 @@
     qconnect,
 )
 from aqt.utils import (
+    add_close_shortcut,
     ask_user_dialog,
     disable_help_button,
     show_warning,
@@ -380,6 +381,7 @@ def get_id_and_pass_from_user(
     qconnect(bb.accepted, diag.accept)
     qconnect(bb.rejected, diag.reject)
     vbox.addWidget(bb)
+    add_close_shortcut(diag)
     diag.setLayout(vbox)
     diag.adjustSize()
     diag.show()

qt/aqt/utils.py

@@ -560,6 +560,7 @@ def getText(
     d = GetTextDialog(
         parent, prompt, help=help, edit=edit, default=default, title=title, **kwargs
     )
+    add_close_shortcut(d)
     d.setWindowModality(Qt.WindowModality.WindowModal)
     if geomKey:
         restoreGeom(d, geomKey)
@@ -988,14 +989,6 @@ def maybeHideClose(bbox: QDialogButtonBox) -> None:
             bbox.removeButton(b)
 
 
-def addCloseShortcut(widg: QDialog) -> None:
-    if not is_mac:
-        return
-    shortcut = QShortcut(QKeySequence("Ctrl+W"), widg)
-    qconnect(shortcut.activated, widg.reject)
-    setattr(widg, "_closeShortcut", shortcut)
-
-
 def add_close_shortcut(widg: QWidget) -> None:
     if not is_mac:
         return