PythonScriptWidget Class Reference

Description

The PythonScriptWidget displays a python script which represents full simulation. Part of SimulationSetupWidget.

Definition at line 29 of file PythonScriptWidget.h.

Inheritance diagram for PythonScriptWidget:

Collaboration diagram for PythonScriptWidget:

Public Member Functions
	PythonScriptWidget (QWidget *parent=nullptr)
	~PythonScriptWidget () override
void	generatePythonScript (const MultiLayerItem *sampleItem, const InstrumentItem *instrumentItem, const SimulationOptionsItem &optionItem, const QString &outputDir="")

Private Slots
void	onExportToFileButton ()

Private Attributes
CautionSign *	m_cautionSign
QString	m_outputDir
QTextEdit *	m_textEdit

Constructor & Destructor Documentation

PythonScriptWidget()

PythonScriptWidget::PythonScriptWidget

(

QWidget *

parent = nullptr

)

Definition at line 36 of file PythonScriptWidget.cpp.

    : QDialog(parent)
    , m_textEdit(new QTextEdit)
    , m_cautionSign(new CautionSign(m_textEdit))
{
    setObjectName("PythonScriptWidget");
    setWindowTitle("Python Script");
    setMinimumSize(128, 128);
    resize(512, 400);
    setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 
    auto* toolbar = new StyledToolbar;
    toolbar->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
 
    auto* exportAction = new QAction(this);
    exportAction->setIcon(QIcon(":/images/content-save-outline.svg"));
    exportAction->setText("Save to file");
    exportAction->setToolTip("Opens dialog to save given script into the file");
    connect(exportAction, &QAction::triggered, this, &PythonScriptWidget::onExportToFileButton);
 
    toolbar->addAction(exportAction);
 
    m_textEdit->setReadOnly(true);
    QFont textFont("Monospace");
    m_textEdit->setFont(textFont);
    m_textEdit->setFontPointSize(DesignerHelper::getPythonEditorFontSize());
    m_textEdit->setLineWrapMode(QTextEdit::NoWrap);
    auto* highlighter = new PythonSyntaxHighlighter(m_textEdit->document());
    Q_UNUSED(highlighter);
 
    auto* mainLayout = new QVBoxLayout;
    mainLayout->setContentsMargins(0, 0, 0, 0);
    mainLayout->setMargin(0);
    mainLayout->setSpacing(0);
    mainLayout->addWidget(toolbar);
    mainLayout->addWidget(m_textEdit);
 
    setLayout(mainLayout);
 
    setAttribute(Qt::WA_DeleteOnClose, true);
    GUI::Util::Style::setResizable(this);
    appSettings->loadWindowSizeAndPos(this);
}

References appSettings, DesignerHelper::getPythonEditorFontSize(), ApplicationSettings::loadWindowSizeAndPos(), m_textEdit, onExportToFileButton(), and GUI::Util::Style::setResizable().

Here is the call graph for this function:

~PythonScriptWidget()

PythonScriptWidget::~PythonScriptWidget ( )

override

Definition at line 81 of file PythonScriptWidget.cpp.

{
    appSettings->saveWindowSizeAndPos(this);
}

References appSettings, and ApplicationSettings::saveWindowSizeAndPos().

Here is the call graph for this function:

Member Function Documentation

generatePythonScript()

void PythonScriptWidget::generatePythonScript	(	const MultiLayerItem *	sampleItem,
		const InstrumentItem *	instrumentItem,
		const SimulationOptionsItem &	optionItem,
		const QString &	outputDir = ""
	)

Definition at line 86 of file PythonScriptWidget.cpp.

{
    m_outputDir = outputDir;
    m_cautionSign->clear();
 
    try {
        const auto simulation =
            GUI::Transform::ToCore::itemsToSimulation(sampleItem, instrumentItem, optionItem);
 
        QString code = QString::fromStdString(Py::Export::simulationPlotCode(*simulation));
        m_textEdit->clear();
        m_textEdit->setText(code);
    } catch (const std::exception& ex) {
        QString message =
            QString(
                "Generation of Python Script failed. Code is not complete.\n\n"
                "It can happen if sample requires further assembling or some of sample parameters "
                "are not valid. See details below.\n\n%1")
                .arg(QString::fromStdString(ex.what()));
 
        m_cautionSign->setCautionMessage(message);
    }
}

References CautionSign::clear(), GUI::Transform::ToCore::itemsToSimulation(), m_cautionSign, m_outputDir, m_textEdit, and CautionSign::setCautionMessage().

Here is the call graph for this function:

onExportToFileButton

void PythonScriptWidget::onExportToFileButton ( )

privateslot

Definition at line 113 of file PythonScriptWidget.cpp.

{
    QString dirname(m_outputDir);
    if (dirname.isEmpty())
        dirname = QStandardPaths::writableLocation(QStandardPaths::HomeLocation);
 
    QString filters("Python scripts (*.py)");
    QString defaultFilter("Python scripts (*.py)");
    QString defaultName = dirname + "/untitled";
 
    QString fileName = QFileDialog::getSaveFileName(
        nullptr, "Save file", defaultName, filters, &defaultFilter,
        appSettings->useNativeFileDialog() ? QFileDialog::Options()
                                           : QFileDialog::DontUseNativeDialog);
 
    if (fileName.isEmpty())
        return;
 
    if (!fileName.endsWith(".py"))
        fileName += ".py";
 
    QFile file(fileName);
    if (!file.open(QIODevice::WriteOnly)) {
        QMessageBox::warning(this, "Save Python file", "File could not be opened for writing!");
        return;
    }
    QTextStream out(&file);
    out << m_textEdit->toPlainText();
    file.close();
    raise();
}

References appSettings, m_outputDir, m_textEdit, ApplicationSettings::useNativeFileDialog(), and GUI::View::Helpers::warning().

Referenced by PythonScriptWidget().

Here is the call graph for this function:

Member Data Documentation

m_cautionSign

CautionSign* PythonScriptWidget::m_cautionSign

private

Definition at line 46 of file PythonScriptWidget.h.

Referenced by generatePythonScript().

m_outputDir

QString PythonScriptWidget::m_outputDir

private

Definition at line 47 of file PythonScriptWidget.h.

Referenced by generatePythonScript(), and onExportToFileButton().

m_textEdit

QTextEdit* PythonScriptWidget::m_textEdit

private

Definition at line 45 of file PythonScriptWidget.h.

Referenced by PythonScriptWidget(), generatePythonScript(), and onExportToFileButton().

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Script/PythonScriptWidget.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Script/PythonScriptWidget.cpp