sound.py

Go to the documentation of this file.

"""!
********************************************************************************
@file   sound.py
@brief  Sound module
********************************************************************************
"""
 
import sys
import logging
from typing import Optional, TYPE_CHECKING
 
from Source.version import __title__
from Source.Util.app_data import S_SOUND_CASH_PATH, S_SOUND_CLEAR_PATH, S_SOUND_UNLOCK_PATH, S_SOUND_TOUCH_PATH, \
    ICON_SOUND_LIGHT, ICON_SOUND_DARK, ICON_SOUND_MUTE_LIGHT, ICON_SOUND_MUTE_DARK, write_sound_settings
from Source.Util.gui_toolkit import config_menu, create_sound
if TYPE_CHECKING:
    from Source.Controller.main_window import MainWindow
 
log = logging.getLogger(__title__)
 
 
class Sound:
    """!
    @brief Sounds for actions
    @param ui : main window object
    """
 
    def __init__(self, ui: "MainWindow") -> None:
        self.ui = ui
        self.b_sound = False
        self.c_sound_print = create_sound(S_SOUND_CASH_PATH)
        self.c_sound_clear = create_sound(S_SOUND_CLEAR_PATH)
        self.c_sound_unlock = create_sound(S_SOUND_UNLOCK_PATH)
        self.c_sound_touch = create_sound(S_SOUND_TOUCH_PATH)
 
    def update_sound_status(self, b_sound: Optional[bool] = None, b_update_settings: bool = True) -> None:
        """!
        @brief Update sound status.
        @param b_sound : [True] sound active; [False] sound muted; [None] toggle actual sound state
        @param b_update_settings : [True] print sound info at status bar; [False] no output on status bar
        """
        if b_sound is None:
            b_sound = not self.b_sound  # toggle sound status if no sound state set
        if b_update_settings:
            self.b_sound = b_sound
            write_sound_settings(self.b_sound)
        if self.b_sound:
            s_sound_icon = ICON_SOUND_LIGHT if self.ui.model.c_monitor.is_light_theme() else ICON_SOUND_DARK
            s_statusbar_text = ["Sound On", "Ton an"]
        else:
            s_sound_icon = ICON_SOUND_MUTE_LIGHT if self.ui.model.c_monitor.is_light_theme() else ICON_SOUND_MUTE_DARK
            s_statusbar_text = ["Sound Off", "Ton aus"]
        if b_update_settings:
            self.ui.set_status(s_statusbar_text)
        config_menu(self.ui.action_sound, icon=s_sound_icon)