help_dialog.py

Go to the documentation of this file.

"""!
********************************************************************************
@file   help_dialog.py
@brief  Create help dialog
********************************************************************************
"""
 
import os
import logging
from typing import TYPE_CHECKING
 
from Source.version import __title__
from Source.Util.app_data import HELP_PATH
from Source.Util.gui_toolkit import HELP_DIALOG, create_dialog, config_tab, DIALOG
if TYPE_CHECKING:
    from Source.Controller.main_window import MainWindow
 
log = logging.getLogger(__title__)
 
 
def create_help_dialog(ui: "MainWindow") -> DIALOG:
    """!
    @brief Create help dialog.
    @param ui : main window to create dialog with same style
    @return help dialog
    """
    dialog_help = create_dialog(ui, minmax=True)
    ui_help = HELP_DIALOG()
    ui_help.setupUi(dialog_help)
    d_help_text_source_link = {}
    d_help_text_source_link[ui_help.helpTextGeneral] = "general.md"
    d_help_text_source_link[ui_help.helpTextConfiguration] = "configuration.md"
    d_help_text_source_link[ui_help.helpTextUser] = "user.md"
    d_help_text_source_link[ui_help.helpTextArticles] = "articles.md"
    d_help_text_source_link[ui_help.helpTextReport] = "report.md"
    d_help_text_source_link[ui_help.helpTextPrinter] = "printer.md"
    config_tab(ui_help.helpTextReader, text="", tab_index=6, main_tab=ui_help.tabWidget_helpMenu, tab_name="")
    config_tab(ui_help.helpTextDisplay, text="", tab_index=7, main_tab=ui_help.tabWidget_helpMenu, tab_name="")
    config_tab(ui_help.helpTextWebserver, text="", tab_index=8, main_tab=ui_help.tabWidget_helpMenu, tab_name="")
    config_tab(None, main_tab=ui_help.tabWidget_helpMenu, tab_index=0)
    for q_text_browser, s_source_file in d_help_text_source_link.items():
        with open(os.path.join(HELP_PATH + s_source_file), mode="r", encoding="utf-8") as f:
            text = f.read()
            text = text[text.find("#"):]
            config_tab(q_text_browser, text=text)
    return dialog_help