ScriptPanel Class Reference

Description

Resides at the bottom of SampleView and displays a Python script.

Definition at line 31 of file ScriptPanel.h.

Inheritance diagram for ScriptPanel:

Collaboration diagram for ScriptPanel:

Public Member Functions
	ScriptPanel (QWidget *parent)
void	onSampleModified ()
void	setCurrentSample (MultiLayerItem *sampleItem)

Protected Member Functions
void	hideEvent (QHideEvent *) override
void	showEvent (QShowEvent *) override

Private Member Functions
QString	generateCodeSnippet ()
	generates string representing code snippet for all multi layers in the model More...
void	updateEditor ()
	Update the editor with the script content. More...

Private Attributes
CautionSign *	m_cautionSign
MultiLayerItem *	m_currentMultiLayerItem
PythonSyntaxHighlighter *	m_highlighter
QTextEdit *	m_textEdit
UpdateTimer *	m_updateTimer

Constructor & Destructor Documentation

ScriptPanel()

ScriptPanel::ScriptPanel ( QWidget *  parent )

explicit

Definition at line 35 of file ScriptPanel.cpp.

    : QWidget(parent)
    , m_textEdit(new QTextEdit)
    , m_highlighter(nullptr)
    , m_updateTimer(new UpdateTimer(accumulateUpdatesDuringMsec, this))
    , m_cautionSign(new CautionSign(m_textEdit))
    , m_currentMultiLayerItem(nullptr)
{
    setWindowTitle("Python Script");
    setObjectName("ScriptPanel");
 
    m_textEdit->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 
    auto* mainLayout = new QVBoxLayout(this);
    mainLayout->setContentsMargins(0, 0, 0, 0);
    mainLayout->addWidget(m_textEdit);
 
    m_textEdit->setReadOnly(true);
    QFont textFont("Monospace");
    m_textEdit->setFont(textFont);
    m_textEdit->setFontPointSize(DesignerHelper::getPythonEditorFontSize());
 
    connect(m_updateTimer, &UpdateTimer::timeToUpdate, this, &ScriptPanel::updateEditor,
            Qt::UniqueConnection);
}

References DesignerHelper::getPythonEditorFontSize(), m_textEdit, m_updateTimer, UpdateTimer::timeToUpdate(), and updateEditor().

Here is the call graph for this function:

Member Function Documentation

generateCodeSnippet()

QString ScriptPanel::generateCodeSnippet ( )

private

generates string representing code snippet for all multi layers in the model

Definition at line 101 of file ScriptPanel.cpp.

{
    m_cautionSign->clear();
 
    if (m_currentMultiLayerItem == nullptr)
        return {};
 
    QString result;
    try {
        auto sample = GUI::Transform::ToCore::itemToSample(*m_currentMultiLayerItem);
        result.append(QString::fromStdString(Py::Export::sampleCode(*sample)));
    } 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);
    }
 
    return result;
}

References CautionSign::clear(), GUI::Transform::ToCore::itemToSample(), m_cautionSign, m_currentMultiLayerItem, and CautionSign::setCautionMessage().

Referenced by updateEditor().

Here is the call graph for this function:

hideEvent()

void ScriptPanel::hideEvent ( QHideEvent *  )

overrideprotected

Definition at line 96 of file ScriptPanel.cpp.

{
    m_updateTimer->reset();
}

References m_updateTimer, and UpdateTimer::reset().

Here is the call graph for this function:

onSampleModified()

void ScriptPanel::onSampleModified

(

)

Definition at line 67 of file ScriptPanel.cpp.

{
    if (isVisible())
        m_updateTimer->scheduleUpdate();
}

References m_updateTimer, and UpdateTimer::scheduleUpdate().

Referenced by SampleView::SampleView().

Here is the call graph for this function:

setCurrentSample()

void ScriptPanel::setCurrentSample

(

MultiLayerItem *

sampleItem

)

Definition at line 61 of file ScriptPanel.cpp.

{
    m_currentMultiLayerItem = sampleItem;
    updateEditor();
}

References m_currentMultiLayerItem, and updateEditor().

Referenced by SampleView::SampleView().

Here is the call graph for this function:

showEvent()

void ScriptPanel::showEvent ( QShowEvent *  )

overrideprotected

Definition at line 91 of file ScriptPanel.cpp.

{
    m_updateTimer->scheduleUpdate();
}

References m_updateTimer, and UpdateTimer::scheduleUpdate().

Here is the call graph for this function:

updateEditor()

void ScriptPanel::updateEditor ( )

private

Update the editor with the script content.

Definition at line 73 of file ScriptPanel.cpp.

{
    if (!m_highlighter) {
        m_highlighter = new PythonSyntaxHighlighter(m_textEdit->document());
        m_textEdit->setLineWrapMode(QTextEdit::NoWrap);
    }
 
    const int oldScrollbarValue = m_textEdit->verticalScrollBar()->value();
 
    const QString codeSnippet = generateCodeSnippet();
    if (!codeSnippet.isEmpty())
        m_textEdit->setText(codeSnippet);
    else
        m_textEdit->clear();
 
    m_textEdit->verticalScrollBar()->setValue(oldScrollbarValue);
}

References generateCodeSnippet(), m_highlighter, and m_textEdit.

Referenced by ScriptPanel(), and setCurrentSample().

Here is the call graph for this function:

Member Data Documentation

m_cautionSign

CautionSign* ScriptPanel::m_cautionSign

private

Definition at line 54 of file ScriptPanel.h.

Referenced by generateCodeSnippet().

m_currentMultiLayerItem

MultiLayerItem* ScriptPanel::m_currentMultiLayerItem

private

Definition at line 55 of file ScriptPanel.h.

Referenced by generateCodeSnippet(), and setCurrentSample().

m_highlighter

PythonSyntaxHighlighter* ScriptPanel::m_highlighter

private

Definition at line 52 of file ScriptPanel.h.

Referenced by updateEditor().

m_textEdit

QTextEdit* ScriptPanel::m_textEdit

private

Definition at line 51 of file ScriptPanel.h.

Referenced by ScriptPanel(), and updateEditor().

m_updateTimer

UpdateTimer* ScriptPanel::m_updateTimer

private

Definition at line 53 of file ScriptPanel.h.

Referenced by ScriptPanel(), hideEvent(), onSampleModified(), and showEvent().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/SampleDesigner/ScriptPanel.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/SampleDesigner/ScriptPanel.cpp