Improved keyboard focus management for UI panels and menus

Ankalot · Ankalot · commit e77c3556c8d6 · 2026-06-07T17:34:28.000+03:00
diff --git a/plugin/include/XenRoll/editor/PluginEditor.h b/plugin/include/XenRoll/editor/PluginEditor.h
@@ -367,9 +367,12 @@ class AudioPluginAudioProcessorEditor : public juce::AudioProcessorEditor,
     void timerCallback();
 
     /**
-     * @brief Bring keyboard focus back to main panel
+     * @brief Bring keyboard focus back to viewed panel
      */
-    void bringBackKeyboardFocus() { mainPanel->grabKeyboardFocus(); }
+    void bringBackKeyboardFocus() {
+        if (viewedPanel) 
+            viewedPanel->grabKeyboardFocus();
+    }
 
     /**
      * @brief Called when A4 frequency changes
@@ -442,6 +445,8 @@ class AudioPluginAudioProcessorEditor : public juce::AudioProcessorEditor,
   private:
     AudioPluginAudioProcessor &processorRef;
 
+    juce::Component* viewedPanel;
+
     std::shared_ptr<DissonanceMeter> dissonanceMeter;
 
     std::shared_ptr<PitchMemory> pitchMemory;
diff --git a/plugin/include/XenRoll/editor/menus/ClockDiagramMenu.h b/plugin/include/XenRoll/editor/menus/ClockDiagramMenu.h
@@ -21,6 +21,8 @@ class ClockDiagramMenu : public juce::Component {
         g.drawRect(getLocalBounds().toFloat(), Theme::wider);
     }
 
+    void visibilityChanged() override;
+
   private:
     AudioPluginAudioProcessorEditor &editor;
     Parameters &params;
diff --git a/plugin/include/XenRoll/editor/menus/EditRatiosMarksMenu.h b/plugin/include/XenRoll/editor/menus/EditRatiosMarksMenu.h
@@ -21,6 +21,8 @@ class EditRatiosMarksMenu : public juce::Component {
         g.drawRect(getLocalBounds().toFloat(), Theme::wider);
     }
 
+    void visibilityChanged() override;
+
   private:
     AudioPluginAudioProcessorEditor &editor;
     Parameters &params;
diff --git a/plugin/include/XenRoll/editor/menus/GenNewKeysMenu.h b/plugin/include/XenRoll/editor/menus/GenNewKeysMenu.h
@@ -21,6 +21,8 @@ class GenNewKeysMenu : public juce::Component {
         g.drawRect(getLocalBounds().toFloat(), Theme::wider);
     }
 
+    void visibilityChanged() override;
+
   private:
     AudioPluginAudioProcessorEditor &editor;
     Parameters &params;
diff --git a/plugin/include/XenRoll/editor/menus/InstancesMenu.h b/plugin/include/XenRoll/editor/menus/InstancesMenu.h
@@ -13,15 +13,7 @@ class InstancesMenu : public juce::Component {
 
     void buildMenu();
 
-    void visibilityChanged() override {
-        if (isVisible()) {
-            std::set<int> mbNewPossibleInds = getPossibleInds();
-            if (mbNewPossibleInds != possibleInds) {
-                possibleInds = mbNewPossibleInds;
-                buildMenu();
-            }
-        }
-    }
+    void visibilityChanged() override;
 
     void paint(juce::Graphics &g) override {
         g.fillAll(params.theme.darker);
diff --git a/plugin/include/XenRoll/editor/menus/MoreToolsMenu.h b/plugin/include/XenRoll/editor/menus/MoreToolsMenu.h
@@ -21,6 +21,8 @@ class MoreToolsMenu : public juce::Component {
         g.drawRect(getLocalBounds().toFloat(), Theme::wider);
     }
 
+    void visibilityChanged() override;
+
   private:
     AudioPluginAudioProcessorEditor &editor;
     Theme &theme;
diff --git a/plugin/include/XenRoll/editor/menus/VocalToMelodyMenu.h b/plugin/include/XenRoll/editor/menus/VocalToMelodyMenu.h
@@ -32,11 +32,7 @@ class VocalToMelodyMenu : public juce::Component {
                    Theme::wider);
     }
 
-    void visibilityChanged() override {
-        if (isVisible()) {
-            micGain_dBSlider->setValue(GlobalSettings::getInstance().getMicGain_dB());
-        }
-    }
+    void visibilityChanged() override;
 
   private:
     AudioPluginAudioProcessorEditor &editor;
diff --git a/plugin/include/XenRoll/editor/panels/HelpPanel.h b/plugin/include/XenRoll/editor/panels/HelpPanel.h
@@ -8,7 +8,10 @@ namespace audio_plugin {
 
 class HelpPanel : public juce::Component {
   public:
-    HelpPanel(Theme &theme) : theme(theme) { setVisible(false); }
+    HelpPanel(Theme &theme) : theme(theme) {
+        setWantsKeyboardFocus(true);
+        setVisible(false);
+    }
 
     void paint(juce::Graphics &g) override {
         g.fillAll(theme.darker);
diff --git a/plugin/source/editor/PluginEditor.cpp b/plugin/source/editor/PluginEditor.cpp
@@ -197,6 +197,7 @@ AudioPluginAudioProcessorEditor::AudioPluginAudioProcessorEditor(AudioPluginAudi
     mainPanel->initViewport();
     mainPanel->setPlayHeadTime(playHeadTime);
     addAndMakeVisible(mainViewport.get());
+    viewedPanel = mainPanel.get();
 
     clockDiagramPanel =
         std::make_unique<ClockDiagramPanel>(processorRef.params, *this, mainPanel->getNotes());
@@ -273,7 +274,14 @@ AudioPluginAudioProcessorEditor::AudioPluginAudioProcessorEditor(AudioPluginAudi
     addAndMakeVisible(pitchMemorySettingsButton.get());
 
     settingsButton->onClick = [this](const juce::MouseEvent &me) {
-        settingsViewport->setVisible(!settingsViewport->isVisible());
+        bool newVisible = !settingsViewport->isVisible();
+        settingsViewport->setVisible(newVisible); // viewport
+        if (newVisible) {
+            viewedPanel = settingsPanel.get();    // panel
+        } else {
+            viewedPanel = mainPanel.get();
+        }
+        bringBackKeyboardFocus();
 
         helpViewport->setVisible(false);
         dissonancePanel->setVisible(false);
@@ -283,7 +291,14 @@ AudioPluginAudioProcessorEditor::AudioPluginAudioProcessorEditor(AudioPluginAudi
         return false;
     };
     helpButton->onClick = [this](const juce::MouseEvent &me) {
-        helpViewport->setVisible(!helpViewport->isVisible());
+        bool newVisible = !helpViewport->isVisible();
+        helpViewport->setVisible(newVisible); // viewport
+        if (newVisible) {
+            viewedPanel = helpPanel.get();    // panel
+        } else {
+            viewedPanel = mainPanel.get();
+        }
+        bringBackKeyboardFocus();
 
         settingsViewport->setVisible(false);
         dissonancePanel->setVisible(false);
@@ -293,7 +308,14 @@ AudioPluginAudioProcessorEditor::AudioPluginAudioProcessorEditor(AudioPluginAudi
         return false;
     };
     dissonanceButton->onClick = [this](const juce::MouseEvent &me) {
-        dissonancePanel->setVisible(!dissonancePanel->isVisible());
+        bool newVisible = !dissonancePanel->isVisible();
+        dissonancePanel->setVisible(newVisible);
+        if (newVisible) {
+            viewedPanel = dissonancePanel.get();
+        } else {
+            viewedPanel = mainPanel.get();
+        }
+        bringBackKeyboardFocus();
 
         helpViewport->setVisible(false);
         settingsViewport->setVisible(false);
@@ -303,7 +325,14 @@ AudioPluginAudioProcessorEditor::AudioPluginAudioProcessorEditor(AudioPluginAudi
         return false;
     };
     pitchMemorySettingsButton->onClick = [this](const juce::MouseEvent &me) {
-        pitchMemorySettingsPanel->setVisible(!pitchMemorySettingsPanel->isVisible());
+        bool newVisible = !pitchMemorySettingsPanel->isVisible();
+        pitchMemorySettingsPanel->setVisible(newVisible);
+        if (newVisible) {
+            viewedPanel = pitchMemorySettingsPanel.get();
+        } else {
+            viewedPanel = mainPanel.get();
+        }
+        bringBackKeyboardFocus();
 
         settingsViewport->setVisible(false);
         helpViewport->setVisible(false);
diff --git a/plugin/source/editor/menus/ClockDiagramMenu.cpp b/plugin/source/editor/menus/ClockDiagramMenu.cpp
@@ -41,4 +41,10 @@ ClockDiagramMenu::ClockDiagramMenu(Parameters &params, AudioPluginAudioProcessor
     const int totalHeight = y + vertPadding;
     setSize(width, totalHeight);
 }
+
+void ClockDiagramMenu::visibilityChanged() {
+    if (!isVisible()) {
+        editor.bringBackKeyboardFocus();
+    }
+}
 } // namespace audio_plugin
diff --git a/plugin/source/editor/menus/EditRatiosMarksMenu.cpp b/plugin/source/editor/menus/EditRatiosMarksMenu.cpp
@@ -84,4 +84,11 @@ EditRatiosMarksMenu::EditRatiosMarksMenu(Parameters &params,
     const int totalHeight = y + vertPadding;
     setSize(width, totalHeight);
 }
+
+void EditRatiosMarksMenu::visibilityChanged() {
+    if (!isVisible()) {
+        editor.bringBackKeyboardFocus();
+    }
+}
+
 } // namespace audio_plugin
diff --git a/plugin/source/editor/menus/GenNewKeysMenu.cpp b/plugin/source/editor/menus/GenNewKeysMenu.cpp
@@ -115,4 +115,11 @@ GenNewKeysMenu::GenNewKeysMenu(Parameters &params, AudioPluginAudioProcessorEdit
     const int totalHeight = y + vertPadding;
     setSize(width, totalHeight);
 }
+
+void GenNewKeysMenu::visibilityChanged() {
+    if (!isVisible()) {
+        editor.bringBackKeyboardFocus();
+    }
+}
+
 } // namespace audio_plugin
diff --git a/plugin/source/editor/menus/InstancesMenu.cpp b/plugin/source/editor/menus/InstancesMenu.cpp
@@ -103,4 +103,16 @@ std::set<int> InstancesMenu::getPossibleInds() {
     return inds;
 }
 
+void InstancesMenu::visibilityChanged() {
+    if (isVisible()) {
+        std::set<int> mbNewPossibleInds = getPossibleInds();
+        if (mbNewPossibleInds != possibleInds) {
+            possibleInds = mbNewPossibleInds;
+            buildMenu();
+        }
+    } else {
+        editor.bringBackKeyboardFocus();
+    }
+}
+
 } // namespace audio_plugin
diff --git a/plugin/source/editor/menus/MoreToolsMenu.cpp b/plugin/source/editor/menus/MoreToolsMenu.cpp
@@ -69,4 +69,10 @@ MoreToolsMenu::MoreToolsMenu(AudioPluginAudioProcessorEditor &editor, Theme &the
     const int totalHeight = y + vertPadding;
     setSize(width, totalHeight);
 }
+
+void MoreToolsMenu::visibilityChanged() {
+    if (!isVisible()) {
+        editor.bringBackKeyboardFocus();
+    }
+}
 } // namespace audio_plugin
diff --git a/plugin/source/editor/menus/VocalToMelodyMenu.cpp b/plugin/source/editor/menus/VocalToMelodyMenu.cpp
@@ -193,4 +193,12 @@ VocalToMelodyMenu::VocalToMelodyMenu(Parameters &params, AudioPluginAudioProcess
     const int totalHeight = y + vertPadding;
     setSize(width, totalHeight);
 }
+
+void VocalToMelodyMenu::visibilityChanged() {
+    if (isVisible()) {
+        micGain_dBSlider->setValue(GlobalSettings::getInstance().getMicGain_dB());
+    } else {
+        editor.bringBackKeyboardFocus();
+    }
+}
 } // namespace audio_plugin
diff --git a/plugin/source/editor/panels/DissonancePanel.cpp b/plugin/source/editor/panels/DissonancePanel.cpp
@@ -5,6 +5,8 @@ namespace audio_plugin {
 DissonancePanel::DissonancePanel(Parameters &params,
                                  std::shared_ptr<DissonanceMeter> dissonanceMeter)
     : params(params), dissonanceMeter(dissonanceMeter) {
+    // so InterInput won't receive focus when panel becomes focused
+    setWantsKeyboardFocus(true);
     setVisible(false);
 
     // Other
diff --git a/plugin/source/editor/panels/PitchMemorySettingsPanel.cpp b/plugin/source/editor/panels/PitchMemorySettingsPanel.cpp
@@ -5,6 +5,7 @@ namespace audio_plugin {
 PitchMemorySettingsPanel::PitchMemorySettingsPanel(Parameters &params,
                                                    AudioPluginAudioProcessorEditor &editor)
     : params(params) {
+    setWantsKeyboardFocus(true);
     setVisible(false);
 
     const juce::String TV_0 = juce::String("TV") + juce::juce_wchar(0x2080);
diff --git a/plugin/source/editor/panels/SettingsPanel.cpp b/plugin/source/editor/panels/SettingsPanel.cpp
@@ -4,6 +4,7 @@
 namespace audio_plugin {
 SettingsPanel::SettingsPanel(Parameters &params, AudioPluginAudioProcessorEditor &editor)
     : params(params) {
+    setWantsKeyboardFocus(true);
     setVisible(false);
 
     // ==================== BASIC SETTINGS ====================

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ class ClockDiagramMenu : public juce::Component {`
`21`	`21`	`g.drawRect(getLocalBounds().toFloat(), Theme::wider);`
`22`	`22`	`}`
`23`	`23`
	`24`	`+ void visibilityChanged() override;`
	`25`	`+`
`24`	`26`	`private:`
`25`	`27`	`AudioPluginAudioProcessorEditor &editor;`
`26`	`28`	`Parameters &params;`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ class EditRatiosMarksMenu : public juce::Component {`
`21`	`21`	`g.drawRect(getLocalBounds().toFloat(), Theme::wider);`
`22`	`22`	`}`
`23`	`23`
	`24`	`+ void visibilityChanged() override;`
	`25`	`+`
`24`	`26`	`private:`
`25`	`27`	`AudioPluginAudioProcessorEditor &editor;`
`26`	`28`	`Parameters &params;`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ class GenNewKeysMenu : public juce::Component {`
`21`	`21`	`g.drawRect(getLocalBounds().toFloat(), Theme::wider);`
`22`	`22`	`}`
`23`	`23`
	`24`	`+ void visibilityChanged() override;`
	`25`	`+`
`24`	`26`	`private:`
`25`	`27`	`AudioPluginAudioProcessorEditor &editor;`
`26`	`28`	`Parameters &params;`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ class MoreToolsMenu : public juce::Component {`
`21`	`21`	`g.drawRect(getLocalBounds().toFloat(), Theme::wider);`
`22`	`22`	`}`
`23`	`23`
	`24`	`+ void visibilityChanged() override;`
	`25`	`+`
`24`	`26`	`private:`
`25`	`27`	`AudioPluginAudioProcessorEditor &editor;`
`26`	`28`	`Theme &theme;`