PICARD-2179: Ensure script editor is modal also on macOS

This fixes the script editor opening behind the options dialog on macOS

Author: phw

picard/ui/options/renaming.py

@@ -47,7 +47,10 @@
     get_config,
 )
 from picard.const import DEFAULT_FILE_NAMING_FORMAT
-from picard.const.sys import IS_WIN
+from picard.const.sys import (
+    IS_MACOS,
+    IS_WIN,
+)
 from picard.script import ScriptParser
 
 from picard.ui.options import (
@@ -150,15 +153,17 @@ def __init__(self, parent=None):
         self.ui.example_selection_note.setText(_(self.examples.notes_text) % self.examples.max_samples)
         self.ui.example_filename_sample_files_button.setToolTip(_(self.examples.tooltip_text) % self.examples.max_samples)
 
-        self.script_editor_page = ScriptEditorDialog(parent=self, examples=self.examples)
-        self.script_editor_page.signal_save.connect(self.save_from_editor)
-        self.script_editor_page.signal_update.connect(self.update_from_editor)
-        self.script_editor_page.signal_selection_changed.connect(self.update_selector_from_editor)
+        self.script_editor_dialog = ScriptEditorDialog(parent=self, examples=self.examples)
+        if IS_MACOS:  # Workaround for dialog opening behind options dialog
+            self.script_editor_dialog.setModal(True)
+        self.script_editor_dialog.signal_save.connect(self.save_from_editor)
+        self.script_editor_dialog.signal_update.connect(self.update_from_editor)
+        self.script_editor_dialog.signal_selection_changed.connect(self.update_selector_from_editor)
 
         self.update_selector_from_editor()
 
         # Sync example lists vertical scrolling and selection colors
-        self.script_editor_page.synchronize_vertical_scrollbars((self.ui.example_filename_before, self.ui.example_filename_after))
+        self.script_editor_dialog.synchronize_vertical_scrollbars((self.ui.example_filename_before, self.ui.example_filename_after))
 
         self.current_row = -1
 
@@ -167,32 +172,32 @@ def update_selector_from_editor(self):
         """
         self.ui.naming_script_selector.blockSignals(True)
         self.ui.naming_script_selector.clear()
-        for i in range(self.script_editor_page.ui.preset_naming_scripts.count()):
-            title = self.script_editor_page.ui.preset_naming_scripts.itemText(i)
-            script = self.script_editor_page.ui.preset_naming_scripts.itemData(i)
+        for i in range(self.script_editor_dialog.ui.preset_naming_scripts.count()):
+            title = self.script_editor_dialog.ui.preset_naming_scripts.itemText(i)
+            script = self.script_editor_dialog.ui.preset_naming_scripts.itemData(i)
             self.ui.naming_script_selector.addItem(title, script)
-        self.ui.naming_script_selector.setCurrentIndex(self.script_editor_page.ui.preset_naming_scripts.currentIndex())
+        self.ui.naming_script_selector.setCurrentIndex(self.script_editor_dialog.ui.preset_naming_scripts.currentIndex())
         self.ui.naming_script_selector.blockSignals(False)
 
     def update_selector_in_editor(self):
         """Update the selection in the script editor page to match local selection.
         """
-        self.script_editor_page.ui.preset_naming_scripts.setCurrentIndex(self.ui.naming_script_selector.currentIndex())
+        self.script_editor_dialog.ui.preset_naming_scripts.setCurrentIndex(self.ui.naming_script_selector.currentIndex())
 
     def match_after_to_before(self):
         """Sets the selected item in the 'after' list to the corresponding item in the 'before' list.
         """
-        self.script_editor_page.synchronize_selected_example_lines(self.current_row, self.ui.example_filename_before, self.ui.example_filename_after)
+        self.script_editor_dialog.synchronize_selected_example_lines(self.current_row, self.ui.example_filename_before, self.ui.example_filename_after)
 
     def match_before_to_after(self):
         """Sets the selected item in the 'before' list to the corresponding item in the 'after' list.
         """
-        self.script_editor_page.synchronize_selected_example_lines(self.current_row, self.ui.example_filename_after, self.ui.example_filename_before)
+        self.script_editor_dialog.synchronize_selected_example_lines(self.current_row, self.ui.example_filename_after, self.ui.example_filename_before)
 
     def show_script_editing_page(self):
-        self.script_editor_page.show()
-        self.script_editor_page.raise_()
-        self.script_editor_page.activateWindow()
+        self.script_editor_dialog.show()
+        self.script_editor_dialog.raise_()
+        self.script_editor_dialog.activateWindow()
         self.update_examples_from_local()
 
     def show_scripting_documentation(self):
@@ -217,7 +222,7 @@ def toggle_file_naming_format(self):
             self.ui.windows_compatibility.setEnabled(active)
 
     def save_from_editor(self):
-        self.script_text = self.script_editor_page.get_script()
+        self.script_text = self.script_editor_dialog.get_script()
 
     def update_from_editor(self):
         self.display_examples()
@@ -228,7 +233,7 @@ def check_formats(self):
 
     def update_example_files(self):
         self.examples.update_sample_example_files()
-        self.script_editor_page.display_examples()
+        self.script_editor_dialog.display_examples()
 
     def update_examples_from_local(self):
         override = {
@@ -239,12 +244,12 @@ def update_examples_from_local(self):
             'windows_compatibility': self.ui.windows_compatibility.isChecked(),
         }
         self.examples.update_examples(override=override)
-        self.script_editor_page.display_examples()
+        self.script_editor_dialog.display_examples()
 
     def display_examples(self):
         self.current_row = -1
         examples = self.examples.get_examples()
-        self.script_editor_page.update_example_listboxes(self.ui.example_filename_before, self.ui.example_filename_after, examples)
+        self.script_editor_dialog.update_example_listboxes(self.ui.example_filename_before, self.ui.example_filename_after, examples)
 
     def load(self):
         config = get_config()
@@ -262,7 +267,7 @@ def load(self):
         self.ui.move_additional_files.setChecked(config.setting["move_additional_files"])
         self.ui.move_additional_files_pattern.setText(config.setting["move_additional_files_pattern"])
         self.ui.delete_empty_dirs.setChecked(config.setting["delete_empty_dirs"])
-        self.script_editor_page.load()
+        self.script_editor_dialog.load()
         self.update_examples_from_local()
 
     def check(self):
@@ -292,8 +297,8 @@ def save(self):
         config.setting["move_additional_files"] = self.ui.move_additional_files.isChecked()
         config.setting["move_additional_files_pattern"] = self.ui.move_additional_files_pattern.text()
         config.setting["delete_empty_dirs"] = self.ui.delete_empty_dirs.isChecked()
-        config.setting["file_naming_scripts"] = self.script_editor_page.naming_scripts
-        config.setting["selected_file_naming_script_id"] = self.script_editor_page.selected_script_id
+        config.setting["file_naming_scripts"] = self.script_editor_dialog.naming_scripts
+        config.setting["selected_file_naming_script_id"] = self.script_editor_dialog.selected_script_id
         self.tagger.window.enable_moving_action.setChecked(config.setting["move_files"])
 
     def display_error(self, error):

picard/ui/scripteditor.py

@@ -1018,7 +1018,6 @@ def __init__(self, parent, script_item):
         super().__init__(parent=parent)
         self.script_item = script_item
         self.readonly = script_item.readonly
-        self.setWindowModality(QtCore.Qt.WindowModal)
         self.setWindowTitle(self.TITLE)
         self.displaying = False
         self.ui = Ui_ScriptDetails()

picard/ui/ui_scripteditor.py

@@ -10,8 +10,6 @@
 class Ui_ScriptEditor(object):
     def setupUi(self, ScriptEditor):
         ScriptEditor.setObjectName("ScriptEditor")
-        ScriptEditor.setWindowModality(QtCore.Qt.NonModal)
-        ScriptEditor.setEnabled(True)
         ScriptEditor.resize(902, 729)
         sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Preferred)
         sizePolicy.setHorizontalStretch(0)

picard/ui/ui_scripteditor_details.py

@@ -10,13 +10,13 @@
 class Ui_ScriptDetails(object):
     def setupUi(self, ScriptDetails):
         ScriptDetails.setObjectName("ScriptDetails")
+        ScriptDetails.setWindowModality(QtCore.Qt.WindowModal)
         ScriptDetails.resize(700, 284)
         sizePolicy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding)
         sizePolicy.setHorizontalStretch(1)
         sizePolicy.setVerticalStretch(1)
         sizePolicy.setHeightForWidth(ScriptDetails.sizePolicy().hasHeightForWidth())
         ScriptDetails.setSizePolicy(sizePolicy)
-        ScriptDetails.setModal(False)
         self.verticalLayout = QtWidgets.QVBoxLayout(ScriptDetails)
         self.verticalLayout.setObjectName("verticalLayout")
         self.gridLayout = QtWidgets.QGridLayout()

ui/scripteditor.ui

@@ -2,12 +2,6 @@
 <ui version="4.0">
  <class>ScriptEditor</class>
  <widget class="QWidget" name="ScriptEditor">
-  <property name="windowModality">
-   <enum>Qt::NonModal</enum>
-  </property>
-  <property name="enabled">
-   <bool>true</bool>
-  </property>
   <property name="geometry">
    <rect>
     <x>0</x>

ui/scripteditor_details.ui

@@ -2,6 +2,9 @@
 <ui version="4.0">
  <class>ScriptDetails</class>
  <widget class="QDialog" name="ScriptDetails">
+  <property name="windowModality">
+   <enum>Qt::WindowModal</enum>
+  </property>
   <property name="geometry">
    <rect>
     <x>0</x>
@@ -19,9 +22,6 @@
   <property name="windowTitle">
    <string>Scripting Documentation</string>
   </property>
-  <property name="modal">
-   <bool>false</bool>
-  </property>
   <layout class="QVBoxLayout" name="verticalLayout">
    <item>
     <layout class="QGridLayout" name="gridLayout">