Refactor key event handling in SuraPlayer into a separate KeyHandler class.

Author: MahmoudAtef999

ui/sura_player_ui/key_handler.py

@@ -0,0 +1,97 @@
+from PyQt6.QtGui import QKeyEvent
+from PyQt6.QtCore import Qt
+from utils.universal_speech import UniversalSpeech
+
+
+class KeyHandler:
+    """
+    Handles keyboard events in the application, including arrow key actions and keyboard shortcuts.
+
+    This class separates key handling logic from the main window, making the code more modular and easier to maintain.
+    """
+
+    def __init__(self, parent):
+        """
+        Initializes the KeyHandler with references to the parent window's functions and UI elements.
+
+        :param parent: The main application window (QMainWindow).
+        """
+        self.parent = parent  # Reference to the main window
+
+        # Mapping arrow keys to their respective functions
+        self.arrow_actions = {
+            Qt.Key_Left: parent.rewind,
+            Qt.Key_Right: parent.forward
+        }
+
+        # Mapping modifier keys to the corresponding time values for rewinding/forwarding
+        self.arrow_modifiers = {
+            Qt.ControlModifier | Qt.ShiftModifier: 60,  # Ctrl + Shift -> 60 seconds
+            Qt.ShiftModifier: 10,  # Shift -> 10 seconds
+            Qt.ControlModifier: 20,  # Ctrl -> 20 seconds
+        }
+
+        # Mapping shortcut keys to their corresponding actions
+        self.shortcuts = {
+            ord("E"): lambda: UniversalSpeech.say(parent.elapsed_time_label.text()),
+            ord("R"): lambda: UniversalSpeech.say(parent.remaining_time_label.text()),
+            ord("T"): lambda: UniversalSpeech.say(parent.total_time.text()),
+            ord("C"): lambda: UniversalSpeech.say(parent.reciter_combo.currentText()),
+            ord("V"): lambda: UniversalSpeech.say(parent.surah_combo.currentText()),
+            ord("I"): lambda: UniversalSpeech.say(
+                f"{parent.surah_combo.currentText()}, {parent.reciter_combo.currentText()}"
+            ),
+            **{Qt.Key.Key_0 + i: lambda i=i: parent.set_position(i * 10, by_percent=True) for i in range(10)},
+            Qt.Key_MediaTogglePlayPause: parent.toggle_play_pause,
+            Qt.Key_MediaStop: parent.stop,
+            Qt.Key_MediaPrevious: parent.previous_surah,
+            Qt.Key_MediaNext: parent.next_surah,
+        }
+
+    def handle_key_press(self, event: QKeyEvent) -> bool:
+        """
+        Handles key press events by delegating to the appropriate method.
+
+        :param event: The key press event (QKeyEvent).
+        :return: True if the event was handled, False otherwise.
+        """
+        if self.process_arrows(event):
+            return True
+
+        # Ignore unknown shortcuts if Ctrl, Shift, or Alt is held
+        if event.modifiers() & (Qt.ControlModifier | Qt.ShiftModifier | Qt.AltModifier):
+            return True
+
+        if  self.process_shortcuts(event):
+            return True
+
+        return False
+
+    def process_arrows(self, event: QKeyEvent) -> bool:
+        """
+        Handles left and right arrow keys with different modifier combinations.
+
+        :param event: The key press event (QKeyEvent).
+        :return: True if the event was handled, False otherwise.
+        """
+        action = self.arrow_actions.get(event.key())
+        if action:
+            for modifier, value in self.arrow_modifiers.items():
+                if event.modifiers() == modifier:
+                    action(value)
+                    return True
+        return False
+
+    def process_shortcuts(self, event: QKeyEvent) -> bool:
+        """
+        Handles predefined keyboard shortcuts for playback control and UI interactions.
+
+        :param event: The key press event (QKeyEvent).
+        :return: True if the event was handled, False otherwise.
+        """
+        key_code = event.nativeVirtualKey() or event.key()
+        action = self.shortcuts.get(key_code)
+        if action:
+            action()
+            return True
+        return False

ui/sura_player_ui/sura_player_ui.py

@@ -19,6 +19,7 @@
 from utils.user_data import PreferencesManager
 from utils.settings import SettingsManager
 from.menubar import MenuBar
+from .key_handler import KeyHandler
 
 
 class SuraPlayerWindow(QMainWindow):
@@ -34,8 +35,7 @@ def __init__(self, parent=None) -> None:
         self.player = SurahPlayer()
         self.audio_player_thread = AudioPlayerThread(self.player, self)
         self.filter_manager = FilterManager()
-        self.filter_mode = False
-        self.search_text = ""
+        self.key_handler = KeyHandler(self)
 
         central_widget = QWidget()
         layout = QVBoxLayout(central_widget)
@@ -415,61 +415,7 @@ def keyPressEvent(self, event: QKeyEvent):
         if self.filter_manager.handle_key_press(event):
             return
 
-        if event.key() == Qt.Key_Left:
-            if event.modifiers() & (Qt.ControlModifier | Qt.ShiftModifier):
-                self.rewind(60)
-            elif event.modifiers() & Qt.ShiftModifier:
-                self.rewind(10)
-            elif event.modifiers() & Qt.ControlModifier:
-                self.rewind(20)
-
-        elif event.key() == Qt.Key_Right:
-            if event.modifiers() & (Qt.ControlModifier | Qt.ShiftModifier):
-                self.forward(60)
-            elif event.modifiers() & Qt.ShiftModifier:
-                self.forward(10)
-            elif event.modifiers() & Qt.ControlModifier:
-                self.forward(20)
-
-        else:
-            super().keyPressEvent(event)
-
-
-
-
-
-        if event.modifiers() & (Qt.ControlModifier | Qt.ShiftModifier | Qt.AltModifier):
-            return
-
-        shortcuts = {
-            ord("E"): lambda: UniversalSpeech.say(self.elapsed_time_label.text()),
-            ord("R"): lambda: UniversalSpeech.say(self.remaining_time_label.text()),
-            ord("T"): lambda: UniversalSpeech.say(self.total_time.text()),
-            ord("C"): lambda: UniversalSpeech.say(self.reciter_combo.currentText()),
-            ord("V"): lambda: UniversalSpeech.say(self.surah_combo.currentText()),
-            ord("I"): lambda: UniversalSpeech.say(F"{self.surah_combo.currentText()}, {self.reciter_combo.currentText()}"),
-            Qt.Key.Key_1: lambda: self.set_position(10, by_percent=True),
-            Qt.Key.Key_2: lambda: self.set_position(20, by_percent=True),
-            Qt.Key.Key_3: lambda: self.set_position(30, by_percent=True),
-            Qt.Key.Key_4: lambda: self.set_position(40, by_percent=True),
-            Qt.Key.Key_5: lambda: self.set_position(50, by_percent=True),
-            Qt.Key.Key_6: lambda: self.set_position(60, by_percent=True),
-            Qt.Key.Key_7: lambda: self.set_position(70, by_percent=True),
-            Qt.Key.Key_8: lambda: self.set_position(80, by_percent=True),
-            Qt.Key.Key_9: lambda: self.set_position(90, by_percent=True),
-            Qt.Key.Key_0: lambda: self.set_position(0, by_percent=True),
-            Qt.Key_MediaTogglePlayPause: lambda: self.toggle_play_pause(),
-            Qt.Key_MediaStop: lambda: self.stop(),
-            Qt.Key_MediaPrevious: lambda: self.previous_surah(),
-            Qt.Key_MediaNext: lambda: self.next_surah(),
-        }
-        
-        key_native = event.nativeVirtualKey()
-        if key_native in shortcuts:
-            shortcuts[key_native]()
-            return
-        elif event.key() in  shortcuts:
-            shortcuts[event.key()]()
+        if self.key_handler.handle_key_press(event):
             return
 
         return super().keyPressEvent(event)