Skip to content

Custom Dialogs

Application-specific dialog widgets.

Available Dialogs

UserGuideDialogView

Dialog for displaying the application user guide with theme-aware markdown rendering.

from src.custom_widgets.dialogs.user_guide_dialog.view.user_guide_dialog import (
    UserGuideDialogView,
)

# Show user guide
dialog = UserGuideDialogView(parent)
dialog.exec()

Structure

dialogs/
    __init__.py
    README.md
    user_guide_dialog/
        __init__.py
        user_guide_dialog.py    # UserGuideDialogView
        pyui/
            __init__.py
            ui_user_guide_dialog.py  # Qt Designer generated

Dialog vs prompt_dialogs

Use Case Location
Generic message boxes, inputs src/shared_services/prompt_dialogs/
Application-specific dialogs src/custom_widgets/dialogs/

What Belongs Here

Put here: - Application-specific dialogs (user guide, about, etc.) - Dialogs with custom content/behavior - Dialogs used across multiple views

Do NOT put here: - Generic message boxes (use prompt_dialogs/) - Module-specific dialogs (stay in module's view/) - One-off dialogs only used in one view