frontengine 1.0.69__tar.gz → 1.0.70__tar.gz

{frontengine-1.0.69 → frontengine-1.0.70}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frontengine
-Version: 1.0.69
+Version: 1.0.70
 Summary: FrontEngine is use-define frontview or only use like screen saver
 Author-email: JE-Chen <jechenmailman@gmail.com>
 Project-URL: Homepage, https://github.com/Intergration-Automation-Testing/FrontEngine

frontengine-1.0.70/frontengine/show/shortcuts/shortcut_sheet.py

@@ -0,0 +1,152 @@
+"""
+快速鍵速查表：把目前綁定的全域快速鍵列在畫面上。
+
+快速鍵改得掉，所以印在說明文件裡的那份遲早會過時；這一份是直接從實際生效的綁定
+讀出來的，改過就跟著改。
+
+排版與文字是純函式（`sheet_rows`），所以「顯示的內容對不對」不必開視窗就能驗。
+
+A shortcut cheat sheet: the global shortcuts as they are actually bound.
+
+Shortcuts can be rebound, so any list written into the documentation goes stale;
+this one is read from the bindings in force and follows them.
+
+The rows are produced by a pure function (`sheet_rows`), so what it says can be
+checked without opening a window.
+"""
+from __future__ import annotations
+
+from typing import Dict, List, Optional, Tuple
+
+from PySide6.QtCore import Qt
+from PySide6.QtGui import QColor, QFont, QPainter
+from PySide6.QtWidgets import QApplication
+
+from frontengine.show.base_widget import BaseWidget
+from frontengine.utils.logging.loggin_instance import front_engine_logger
+
+# pynput 的寫法轉成看得懂的樣子
+# pynput spellings turned into something readable
+_PRETTY = {
+    "ctrl": "Ctrl", "alt": "Alt", "shift": "Shift", "cmd": "Cmd",
+    "up": "Up", "down": "Down", "left": "Left", "right": "Right",
+    "space": "Space", "enter": "Enter", "esc": "Esc", "tab": "Tab",
+}
+
+
+def pretty_combo(combo: str) -> str:
+    """
+    把 `<ctrl>+<shift>+<f12>` 變成 `Ctrl + Shift + F12`。
+
+    使用者是在對照畫面上按下去的手指，不是在讀設定檔，所以尖括號和小寫都要去掉。
+    Turn `<ctrl>+<shift>+<f12>` into `Ctrl + Shift + F12`. The reader is matching
+    this against their fingers, not against a settings file, so the angle
+    brackets and the lower case go.
+    """
+    parts = []
+    for raw in str(combo or "").split("+"):
+        name = raw.strip().strip("<>").strip()
+        if not name:
+            continue
+        if name in _PRETTY:
+            parts.append(_PRETTY[name])
+        elif len(name) > 1 and name[0] == "f" and name[1:].isdigit():
+            parts.append(name.upper())
+        else:
+            parts.append(name.upper() if len(name) == 1 else name.capitalize())
+    return " + ".join(parts)
+
+
+def sheet_rows(bindings: Dict[str, str], label_for) -> List[Tuple[str, str]]:
+    """
+    產生 (快速鍵, 動作說明) 的清單，依動作說明排序。
+
+    `bindings` 是「組合字串 -> 動作名稱」，和 HotkeyService 用的同一份，所以這裡
+    列出來的一定就是實際會生效的。沒有綁定時回傳空清單，呼叫端才能說「沒有」而
+    不是開一個空白視窗。
+    Rows of (shortcut, what it does), sorted by the description.
+
+    `bindings` is the same combo-to-action mapping HotkeyService uses, so what
+    is listed is what will actually fire. With nothing bound this returns an
+    empty list, so the caller can say so rather than opening a blank window.
+    """
+    rows = []
+    for combo, action in (bindings or {}).items():
+        if not combo or not action:
+            continue
+        rows.append((pretty_combo(combo), label_for(action)))
+    return sorted(rows, key=lambda row: row[1].lower())
+
+
+class ShortcutSheetWidget(BaseWidget):
+    """把速查表畫在畫面中央，點擊穿透。"""
+
+    PADDING = 28
+    LINE_SPACING = 10
+
+    def __init__(self, rows: List[Tuple[str, str]], title: str = "Shortcuts",
+                 font_size: int = 20, opacity: float = 0.9) -> None:
+        front_engine_logger.info(f"[ShortcutSheetWidget] Init | rows={len(rows)}")
+        super().__init__()
+        self.opacity = max(0.1, min(1.0, float(opacity)))
+        self.rows = list(rows)
+        self.title = title
+        self.font_size = max(10, int(font_size))
+        self.text_color = QColor("#ffffff")
+        self.key_color = QColor("#ffd740")
+        self.background_color = QColor(0, 0, 0, 210)
+
+    def sizeHint(self):  # pragma: no cover - Qt geometry
+        screen = QApplication.primaryScreen()
+        available = screen.availableGeometry() if screen is not None else None
+        if available is None:
+            return super().sizeHint()
+        return available.size() / 2
+
+    def draw_content(self, painter: QPainter) -> None:
+        painter.fillRect(self.rect(), self.background_color)
+
+        title_font = QFont()
+        title_font.setPixelSize(int(self.font_size * 1.3))
+        title_font.setBold(True)
+        painter.setFont(title_font)
+        painter.setPen(self.text_color)
+        y = self.PADDING + int(self.font_size * 1.3)
+        painter.drawText(self.PADDING, y, self.title)
+
+        row_font = QFont()
+        row_font.setPixelSize(self.font_size)
+        painter.setFont(row_font)
+        y += int(self.font_size * 1.4)
+
+        # 左欄放快速鍵、右欄放說明。欄寬固定，兩欄才會各自對齊成一直線。
+        # Shortcut on the left, description on the right, at a fixed column so
+        # both line up rather than drifting with the text.
+        key_column = self.PADDING
+        text_column = self.PADDING + int(self.font_size * 11)
+        for combo, description in self.rows:
+            y += self.font_size + self.LINE_SPACING
+            painter.setPen(self.key_color)
+            painter.drawText(key_column, y, combo)
+            painter.setPen(self.text_color)
+            painter.drawText(text_column, y, description)
+
+    def keyPressEvent(self, event) -> None:  # pragma: no cover - Qt event
+        if event.key() in (Qt.Key.Key_Escape,):
+            self.close()
+            return
+        super().keyPressEvent(event)
+
+
+def build_sheet(bindings: Dict[str, str], label_for, title: str = "Shortcuts",
+                font_size: int = 20) -> Optional[ShortcutSheetWidget]:
+    """
+    建立速查表；沒有任何綁定時回傳 None。
+    Build the sheet, or None when nothing is bound - an empty black rectangle
+    explains nothing.
+    """
+    rows = sheet_rows(bindings, label_for)
+    if not rows:
+        front_engine_logger.info("[ShortcutSheetWidget] nothing bound, not showing")
+        return None
+    return ShortcutSheetWidget(rows, title=title, font_size=font_size)

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine/ui/dialog/hotkey_settings_dialog.py

@@ -32,6 +32,7 @@ _ACTION_LABELS: Dict[str, Tuple[str, str]] = {
     "opacity_down": ("hotkey_opacity_down", "Opacity down"),
     "dashboard_next": ("web_dashboard_next", "Next page"),
     "toggle_lock": ("hotkey_toggle_lock", "Lock / unlock overlays"),
+    "show_shortcuts": ("hotkey_show_shortcuts", "Show this shortcut list"),
 }
 
 
@@ -39,6 +40,20 @@ def _t(key: str, fallback: str) -> str:
     return language_wrapper.language_word_dict.get(key, fallback)
 
 
+def action_label(action: str) -> str:
+    """
+    動作名稱的顯示文字，翻不到就退回動作名稱本身。
+
+    速查表和這個對話框共用同一張表：兩邊各記一份的話，改了快速鍵的說明只會改到
+    其中一邊，而使用者看到的是兩個不同的名字。
+    The display text for an action, falling back to the action name. The cheat
+    sheet and this dialog share one table: with a copy each, renaming a shortcut
+    updates only one of them and the user sees two different names.
+    """
+    key, fallback = _ACTION_LABELS.get(action, ("", str(action)))
+    return _t(key, fallback) if key else fallback
+
+
 class HotkeySettingsDialog(QDialog):
     """
     讓使用者以 pynput 組合鍵語法（例如 <ctrl>+<shift>+<f12>）重新綁定全域

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine/ui/main_ui.py

@@ -15,6 +15,7 @@ from qt_material import apply_stylesheet
 from frontengine.ui.nav.sidebar import NavigationSidebar
 from frontengine.ui.style.app_style import apply_app_style
 
+from frontengine.show.shortcuts.shortcut_sheet import build_sheet
 from frontengine.show.toast.toast_widget import show_toast
 from frontengine.system_tray.extend_system_tray import ExtendSystemTray
 from frontengine.ui.menu.help_menu import build_help_menu
@@ -55,7 +56,7 @@ from frontengine.utils.hotkey.hotkey_service import HotkeyService
 from frontengine.utils.keep_awake.keep_awake import KeepAwake
 from frontengine.utils.logging.loggin_instance import front_engine_logger
 from frontengine.utils.multi_language.language_wrapper import language_wrapper
-from frontengine.utils.multi_language.retranslate import retranslator
+from frontengine.utils.multi_language.retranslate import retranslator, translate
 from frontengine.utils.plugins.plugin_loader import load_plugins
 from frontengine.utils.preset_schedule.preset_schedule_service import PresetScheduleService
 from frontengine.ui.dialog.remote_control_dialog import (
@@ -66,6 +67,7 @@ from frontengine.ui.dialog.signage_dialog import current_settings as current_sig
 from frontengine.utils.signage.signage_service import SignageService
 from frontengine.utils.midi.midi_input import MidiInput, binding_key
 from frontengine.utils.remote.remote_server import RemoteServer
+from frontengine.ui.dialog.hotkey_settings_dialog import action_label as hotkey_action_label
 from frontengine.ui.dialog.smart_pause_dialog import current_rules
 from frontengine.utils.screen_privacy.share_watch import ShareWatchService
 from frontengine.utils.screensaver.screensaver_service import ScreensaverService
@@ -689,6 +691,33 @@ class FrontEngineMainUI(QMainWindow):
             self.web_setting_ui.show_next_dashboard_page()
         elif action == "toggle_lock":
             self.control_center_ui.toggle_lock_all()
+        elif action == "show_shortcuts":
+            self.toggle_shortcut_sheet()
+
+    def toggle_shortcut_sheet(self) -> None:
+        """
+        開關快速鍵速查表。已經開著就收起來，所以同一個快速鍵按第二次是關閉——
+        不然使用者得去找別的方法把它關掉。
+        Toggle the shortcut sheet: pressing the same shortcut again closes it,
+        rather than leaving the user hunting for another way to dismiss it.
+        """
+        existing = getattr(self, "shortcut_sheet", None)
+        if existing is not None:
+            try:
+                existing.close()
+            except RuntimeError:  # pragma: no cover - 底層物件已消失
+                pass
+            self.shortcut_sheet = None
+            return
+        sheet = build_sheet(
+            get_hotkey_bindings(),
+            lambda action: hotkey_action_label(action),
+            title=translate("shortcut_sheet_title", "Shortcuts"))
+        if sheet is None:
+            return
+        sheet.set_ui_window_flag()
+        sheet.showFullScreen()
+        self.shortcut_sheet = sheet
 
     def _on_smart_pause_changed(self, paused: bool, reason: str) -> None:
         """

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine/ui/menu/help_menu.py

@@ -36,6 +36,18 @@ def build_help_menu(ui_we_want_to_set: FrontEngineMainUI) -> None:
         "How to use..."
     )
 
+    # 也要能從選單開。只能用快速鍵叫出來的「快速鍵速查表」是個笑話：不知道快速鍵
+    # 的人正是最需要它的人。
+    # It has to be reachable from the menu too. A shortcut sheet you can only open
+    # with a shortcut is a joke: the person who does not know the shortcuts is
+    # exactly who needs it.
+    _add_action(
+        help_menu,
+        "shortcut_sheet_action",
+        lambda: ui_we_want_to_set.toggle_shortcut_sheet(),
+        "Shortcut list..."
+    )
+
     _add_action(
         help_menu,
         "help_menu_open_issue",

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine/user_setting/user_setting_file.py

@@ -17,6 +17,7 @@ default_hotkeys: Dict[str, str] = {
     "opacity_down": "<ctrl>+<shift>+<down>",
     "dashboard_next": "<ctrl>+<shift>+<right>",
     "toggle_lock": "<ctrl>+<shift>+l",
+    "show_shortcuts": "<ctrl>+<shift>+<f8>",
 }
 
 user_setting_dict: Dict[str, Any] = {

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine/utils/multi_language/english.py

@@ -569,6 +569,9 @@ english_word_dict = {
     "clipboard_clear": 'Clear (keep pinned)',
     "clipboard_persist": 'Keep this history between sessions',
     "clipboard_hint": 'History stays on this machine and is never sent anywhere. Unless you tick the box above it is kept in memory only, because clipboards often hold passwords.',
+    "shortcut_sheet_title": "Shortcuts",
+    "shortcut_sheet_action": "Shortcut list...",
+    "hotkey_show_shortcuts": "Show this shortcut list",
     "tools_layout_label": 'Window layout',
     "tools_layout_name": 'Layout name',
     "tools_layout_save": 'Save layout',

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine/utils/multi_language/france.py

@@ -559,6 +559,9 @@ french_word_dict = {
     "clipboard_clear": "Effacer (garder les épinglés)",
     "clipboard_persist": "Conserver cet historique d'une session à l'autre",
     "clipboard_hint": "L'historique reste sur cette machine et n'est jamais envoyé ailleurs. Sauf si vous cochez la case ci-dessus, il n'est gardé qu'en mémoire, car les presse-papiers contiennent souvent des mots de passe.",
+    "shortcut_sheet_title": "Raccourcis",
+    "shortcut_sheet_action": "Liste des raccourcis...",
+    "hotkey_show_shortcuts": "Afficher cette liste de raccourcis",
     "tools_layout_label": "Disposition des fenêtres",
     "tools_layout_name": "Nom de la disposition",
     "tools_layout_save": "Enregistrer la disposition",

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine/utils/multi_language/germany.py

@@ -562,6 +562,9 @@ germany_word_dict = {
     "clipboard_clear": "Löschen (Angeheftetes behalten)",
     "clipboard_persist": "Diesen Verlauf über Sitzungen hinweg behalten",
     "clipboard_hint": "Der Verlauf bleibt auf diesem Rechner und wird niemals irgendwohin gesendet. Solange Sie das Kästchen oben nicht ankreuzen, bleibt er nur im Arbeitsspeicher – denn in Zwischenablagen stehen oft Passwörter.",
+    "shortcut_sheet_title": "Tastenkürzel",
+    "shortcut_sheet_action": "Tastenkürzel-Liste...",
+    "hotkey_show_shortcuts": "Diese Tastenkürzel-Liste anzeigen",
     "tools_layout_label": "Fensteranordnung",
     "tools_layout_name": "Name der Anordnung",
     "tools_layout_save": "Anordnung speichern",

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine/utils/multi_language/italy.py

@@ -559,6 +559,9 @@ italian_word_dict = {
     "clipboard_clear": "Cancella (mantieni i fissati)",
     "clipboard_persist": "Conserva questa cronologia tra una sessione e l'altra",
     "clipboard_hint": "La cronologia resta su questa macchina e non viene mai inviata altrove. Se non spunti la casella qui sopra viene tenuta solo in memoria, perché negli appunti finiscono spesso delle password.",
+    "shortcut_sheet_title": "Scorciatoie",
+    "shortcut_sheet_action": "Elenco scorciatoie...",
+    "hotkey_show_shortcuts": "Mostra questo elenco di scorciatoie",
     "tools_layout_label": "Disposizione delle finestre",
     "tools_layout_name": "Nome della disposizione",
     "tools_layout_save": "Salva la disposizione",

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine/utils/multi_language/russian.py

@@ -559,6 +559,9 @@ russian_word_dict = {
     "clipboard_clear": "Очистить (оставить закреплённые)",
     "clipboard_persist": "Сохранять эту историю между сеансами",
     "clipboard_hint": "История остаётся на этом компьютере и никуда не отправляется. Пока флажок выше не установлен, она хранится только в памяти — ведь в буфере обмена часто оказываются пароли.",
+    "shortcut_sheet_title": "Горячие клавиши",
+    "shortcut_sheet_action": "Список горячих клавиш...",
+    "hotkey_show_shortcuts": "Показать этот список",
     "tools_layout_label": "Расположение окон",
     "tools_layout_name": "Название расположения",
     "tools_layout_save": "Сохранить расположение",

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine/utils/multi_language/simplified_chinese.py

@@ -561,6 +561,9 @@ simplified_chinese_word_dict = {
     "clipboard_clear": "清除(保留钉选)",
     "clipboard_persist": "跨工作阶段保留这份历史",
     "clipboard_hint": "历史只留在这台机器上，不会送到任何地方。除非你勾选上面那个选项，否则只保存在记忆体里 — 因为剪贴板常常有密码。",
+    "shortcut_sheet_title": "快捷键",
+    "shortcut_sheet_action": "快捷键一览⋯",
+    "hotkey_show_shortcuts": "显示快捷键一览",
     "tools_layout_label": "视窗版面",
     "tools_layout_name": "版面名称",
     "tools_layout_save": "储存版面",

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine/utils/multi_language/traditional_chinese.py

@@ -568,6 +568,9 @@ traditional_chinese_word_dict = {
     "clipboard_clear": '清空（保留釘選）',
     "clipboard_persist": '跨工作階段保存這份歷史',
     "clipboard_hint": '歷史只留在本機、不會傳到任何地方。沒有勾選上面那項時只存在記憶體，因為剪貼簿裡常常有密碼。',
+    "shortcut_sheet_title": "快速鍵",
+    "shortcut_sheet_action": "快速鍵一覽⋯",
+    "hotkey_show_shortcuts": "顯示快速鍵一覽",
     "tools_layout_label": '視窗版面',
     "tools_layout_name": '版面名稱',
     "tools_layout_save": '儲存版面',

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frontengine
-Version: 1.0.69
+Version: 1.0.70
 Summary: FrontEngine is use-define frontview or only use like screen saver
 Author-email: JE-Chen <jechenmailman@gmail.com>
 Project-URL: Homepage, https://github.com/Intergration-Automation-Testing/FrontEngine

{frontengine-1.0.69 → frontengine-1.0.70}/frontengine.egg-info/SOURCES.txt

@@ -51,6 +51,8 @@ frontengine/show/scene/scene.py
 frontengine/show/screen_care/__init__.py
 frontengine/show/screen_care/color_vision_widget.py
 frontengine/show/screen_care/screen_filter.py
+frontengine/show/shortcuts/__init__.py
+frontengine/show/shortcuts/shortcut_sheet.py
 frontengine/show/sound_player/__init__.py
 frontengine/show/sound_player/sound_effect.py
 frontengine/show/sound_player/sound_player.py

{frontengine-1.0.69 → frontengine-1.0.70}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "frontengine"
-version = "1.0.69"
+version = "1.0.70"
 authors = [
     { name = "JE-Chen", email = "jechenmailman@gmail.com" },
 ]