Source code for mantidimaging.gui.windows.wizard.view

# Copyright (C) 2024 ISIS Rutherford Appleton Laboratory UKRI
# SPDX - License - Identifier: GPL-3.0-or-later
from __future__ import annotations

from __future__ import annotations
from PyQt5.QtWidgets import QLabel, QWidget, QVBoxLayout, QGroupBox, QPushButton, QStyle
from PyQt5.QtGui import QIcon
from PyQt5.QtCore import pyqtSignal, Qt

from mantidimaging.gui.mvp_base import BaseDialogView
from .model import EnablePredicateFactory



[docs]
class WizardStage(QWidget):

    def __init__(self, name, parent: QWidget = None) -> None:
        super().__init__(None)

        self.layout = QVBoxLayout(self)
        self.title_label = QLabel("Stage: " + name)
        self.layout.addWidget(self.title_label)
        self.steps: list[WizardStep] = []


[docs]
    def add_step(self, wizard_step: WizardStep) -> None:
        self.steps.append(wizard_step)
        self.layout.addWidget(wizard_step)



[docs]
    def handle_stack_change(self, stack_history: dict | None) -> None:
        for step in self.steps:
            step.handle_stack_change(stack_history)





[docs]
class WizardStep(QWidget):

    def __init__(self, step: dict, wizard: WizardView, parent: QWidget = None) -> None:
        super().__init__(None)

        self.wizard_view = wizard

        self.name = step["name"]
        self.layout = QVBoxLayout(self)
        self.title_label = QPushButton("Step: " + self.name)
        self.title_label.setLayoutDirection(Qt.LayoutDirection.RightToLeft)

        self.layout.addWidget(self.title_label)

        self.step_box = QGroupBox()
        self.step_box_layout = QVBoxLayout(self.step_box)
        self.description = QLabel(step["description"])

        self.step_box_layout.addWidget(self.description)

        if "action" in step:
            run_button = QPushButton("Run")
            self.step_box_layout.addWidget(run_button)
            run_button.clicked.connect(lambda: wizard.presenter.run_action(step["action"]))

        self.step_box.setVisible(False)
        self.layout.addWidget(self.step_box)

        self.title_label.clicked.connect(self.show_step)
        self.wizard_view.close_steps.connect(self.hide_step)

        self.enable_predicate = EnablePredicateFactory(step.get("enable_if", ""))
        self.done_predicate = EnablePredicateFactory(step.get("done_if", ""))


[docs]
    def show_step(self) -> None:
        self.wizard_view.close_steps.emit()
        self.step_box.setVisible(True)



[docs]
    def hide_step(self) -> None:
        self.step_box.setVisible(False)



[docs]
    def handle_stack_change(self, stack_history: dict | None) -> None:
        enabled = self.enable_predicate(stack_history)

        if not enabled:
            self.step_box.setVisible(False)
        self.title_label.setEnabled(enabled)

        if self.done_predicate(stack_history):
            self.title_label.setIcon(self.style().standardIcon(QStyle.StandardPixmap.SP_DialogApplyButton))
        else:
            self.title_label.setIcon(QIcon())





[docs]
class WizardView(BaseDialogView):
    close_steps = pyqtSignal()

    def __init__(self, parent, presenter) -> None:
        super().__init__(parent, "gui/ui/wizard.ui")
        self.stages: dict[str, WizardStage] = {}
        self.presenter = presenter


[docs]
    def add_stage(self, stage_name: str) -> None:
        new_stage = WizardStage(stage_name)
        self.stages[stage_name] = new_stage
        self.wizard_top_layout.addWidget(new_stage)



[docs]
    def add_step(self, stage_name: str, step: dict[str, WizardStage]) -> None:
        new_step = WizardStep(step, self)
        self.stages[stage_name].add_step(new_step)