MultiLayerForm Class Reference

Description

Form to present/edit a MultiLayer (sample)

Definition at line 28 of file MultiLayerForm.h.

Inheritance diagram for MultiLayerForm:

Collaboration diagram for MultiLayerForm:

Public Member Functions
	MultiLayerForm (QWidget *parent, MultiLayerItem *sampleItem, SampleEditorController *ec)
void	ensureVisible (QWidget *w)
LayerForm *	findNextLayerForm (QWidget *w)
	Search for the next LayerForm, starting from the given widget. More...
void	onAboutToRemoveLayer (LayerItem *layerItem)
	Call this before removing (deleting) a LayerItem. More...
void	onLayerAdded (LayerItem *layerItem)
	Create widgets for the new layer. More...
void	onLayerMoved (LayerItem *layerItem)
	Call this when a layerItem has been moved to a different position. More...
void	setUseAngstrom (bool angstrom)
	Show values in Angstrom or nanometers. More...
void	setUseRadiant (bool radiant)
	Show values in radiants or degrees. More...
void	showAddLayerButtons (bool show)
	Shows or hides the "Add Layer" buttons. More...
void	showInlineEditButtons (bool b)
	Show or hide all buttons related to structure editing (like "add layer", "remove particle") More...
void	updateRowVisibilities ()
void	updateUnits ()
	Update the presented units in all contained widgets according to current settings. More...
bool	useAngstrom () const
bool	useRadiant () const

Private Attributes
QList< QPushButton * >	m_addLayerButtons
SampleEditorController *	m_ec
	Ptr is borrowed, don't delete. More...
QVBoxLayout *	m_layout
MultiLayerItem *	m_sampleItem
	Ptr is borrowed, don't delete. More...
bool	m_showInlineEditButtons = false
bool	m_useAngstrom
bool	m_useRadiant

Constructor & Destructor Documentation

MultiLayerForm()

MultiLayerForm::MultiLayerForm	(	QWidget *	parent,
		MultiLayerItem *	sampleItem,
		SampleEditorController *	ec
	)

Definition at line 55 of file MultiLayerForm.cpp.

    : QWidget(parent)
    , m_sampleItem(sampleItem)
    , m_ec(ec)
    , m_useAngstrom(false)
    , m_useRadiant(false)
{
    setObjectName("MultiLayerForm"); // important for style sheet addressing
    setAttribute(Qt::WA_StyledBackground, true);
 
    m_layout = new QVBoxLayout(this);
 
    auto* props = new QGroupBox(this);
    props->setTitle("Sample");
    FormLayouter layouter(props, ec);
    layouter.setContentsMargins(6, 6, 0, 6);
 
    auto* nameEdit = new QLineEdit(props);
    layouter.addRow("Name:", nameEdit);
    nameEdit->setText(sampleItem->sampleName());
    connect(nameEdit, &QLineEdit::textEdited, ec, &SampleEditorController::setSampleName);
 
    auto* descriptionEdit = new QTextEdit(props);
    descriptionEdit->setMinimumWidth(300);
    descriptionEdit->setMaximumHeight(100);
    descriptionEdit->setAcceptRichText(false);
    descriptionEdit->setTabChangesFocus(true);
    descriptionEdit->setPlainText(sampleItem->description());
    layouter.addRow("Description:", descriptionEdit);
    connect(descriptionEdit, &QTextEdit::textChanged,
            [=]() { m_ec->setSampleDescription(descriptionEdit->toPlainText()); });
 
    layouter.addValue(sampleItem->crossCorrLength());
    layouter.addVector(sampleItem->externalFieldVector(), false);
    auto* collapser = GroupBoxCollapser::installIntoGroupBox(props, false);
 
    auto* showInRealSpaceAction = ActionFactory::createShowInRealSpaceAction(
        this, "sample", [=] { m_ec->requestViewInRealSpace(m_sampleItem); });
 
    collapser->addAction(showInRealSpaceAction);
 
    m_layout->addWidget(props);
 
    for (auto* layer : sampleItem->layers()) {
        m_layout->addWidget(new AddLayerWidget(this, layer, m_ec));
        m_layout->addWidget(new LayerForm(this, layer, m_ec));
    }
    m_layout->addWidget(new AddLayerWidget(this, nullptr, m_ec));
    m_layout->setSizeConstraint(QLayout::SetMinimumSize);
    m_layout->addStretch(1);
}

References FormLayouter::addRow(), FormLayouter::addValue(), FormLayouter::addVector(), ActionFactory::createShowInRealSpaceAction(), MultiLayerItem::crossCorrLength(), MultiLayerItem::description(), MultiLayerItem::externalFieldVector(), GroupBoxCollapser::installIntoGroupBox(), MultiLayerItem::layers(), m_ec, m_layout, m_sampleItem, SampleEditorController::requestViewInRealSpace(), MultiLayerItem::sampleName(), FormLayouter::setContentsMargins(), SampleEditorController::setSampleDescription(), and SampleEditorController::setSampleName().

Here is the call graph for this function:

Member Function Documentation

ensureVisible()

void MultiLayerForm::ensureVisible

(

QWidget *

w

)

Definition at line 248 of file MultiLayerForm.cpp.

{
    // #baLayerEditor implement ensureVisible
}

Referenced by SampleEditorController::setDoubleFromUndo().

findNextLayerForm()

LayerForm * MultiLayerForm::findNextLayerForm

(

QWidget *

w

)

Search for the next LayerForm, starting from the given widget.

The search starts with the given widget itself If it is a LayerForm, it is returned. If no following LayerForm is found, nullptr is returned.

Definition at line 282 of file MultiLayerForm.cpp.

{
    while (w != nullptr && dynamic_cast<LayerForm*>(w) == nullptr) {
        const auto index = m_layout->indexOf(w);
        if (index + 1 < m_layout->count())
            w = m_layout->itemAt(index + 1)->widget();
        else
            return nullptr;
    }
 
    return dynamic_cast<LayerForm*>(w);
}

References m_layout.

Referenced by SampleEditorController::onStoppedToMoveLayer().

onAboutToRemoveLayer()

void MultiLayerForm::onAboutToRemoveLayer

(

LayerItem *

layerItem

)

Call this before removing (deleting) a LayerItem.

Any widgets related to the item will be deleted or scheduled for later deletion.

Definition at line 161 of file MultiLayerForm.cpp.

{
    LayerForm* layerForm = nullptr;
    AddLayerWidget* addLayerWidget = nullptr;
    for (auto* c : findChildren<QWidget*>()) {
        if (auto* w = dynamic_cast<AddLayerWidget*>(c))
            if (w->m_layer == layerItem)
                addLayerWidget = w;
 
        if (auto* w = dynamic_cast<LayerForm*>(c)) {
            if (w->layerItem() == layerItem)
                layerForm = w;
        }
    }
 
    if (layerForm) {
        // delete editors which are subscribed to SessionItems
        GUI::Util::Layout::clearLayout(layerForm->layout());
        layerForm->hide();
        layerForm->setParent(nullptr); // so it is not findable in update routines
        layerForm->deleteLater();      // delete later (this is the sender)
    }
 
 
    delete addLayerWidget;
}

References GUI::Util::Layout::clearLayout().

Referenced by SampleEditorController::removeLayerFromUndo().

Here is the call graph for this function:

onLayerAdded()

void MultiLayerForm::onLayerAdded

(

LayerItem *

layerItem

)

Create widgets for the new layer.

Definition at line 114 of file MultiLayerForm.cpp.

{
    const int rowInMultiLayer = m_sampleItem->layers().indexOf(layerItem);
 
    const int rowInLayout = rowInMultiLayer * 2 + 1;
 
    m_layout->insertWidget(rowInLayout, new LayerForm(this, layerItem, m_ec));
 
    // same row => button is above!
    m_layout->insertWidget(rowInLayout, new AddLayerWidget(this, layerItem, m_ec));
 
    updateRowVisibilities();
}

References MultiLayerItem::layers(), m_ec, m_layout, m_sampleItem, and updateRowVisibilities().

Referenced by SampleEditorController::addLayerFromUndo(), and CommandRemoveLayer::undo().

Here is the call graph for this function:

onLayerMoved()

void MultiLayerForm::onLayerMoved

(

LayerItem *

layerItem

)

Call this when a layerItem has been moved to a different position.

This updates the item's position in the layout.

Definition at line 128 of file MultiLayerForm.cpp.

{
    LayerForm* wl = nullptr;
    AddLayerWidget* al = nullptr;
    for (int index = 0; index < m_layout->count(); index++) {
        if (auto* w = dynamic_cast<AddLayerWidget*>(m_layout->itemAt(index)->widget()))
            if (w->m_layer == layerItem) {
                al = w;
                m_layout->takeAt(index);
                break;
            }
    }
 
    for (int index = 0; index < m_layout->count(); index++) {
        if (auto* w = dynamic_cast<LayerForm*>(m_layout->itemAt(index)->widget()))
            if (w->layerItem() == layerItem) {
                wl = w;
                m_layout->takeAt(index);
                break;
            }
    }
 
    const int rowInMultiLayer = m_sampleItem->layers().indexOf(layerItem);
    const int rowInLayout = rowInMultiLayer * 2 + 1;
 
    m_layout->insertWidget(rowInLayout, wl);
 
    // same row => button is above!
    m_layout->insertWidget(rowInLayout, al);
 
    updateRowVisibilities();
}

References MultiLayerItem::layers(), m_layout, m_sampleItem, and updateRowVisibilities().

Referenced by SampleEditorController::onStoppedToMoveLayer().

Here is the call graph for this function:

setUseAngstrom()

void MultiLayerForm::setUseAngstrom

(

bool

angstrom

)

Show values in Angstrom or nanometers.

Definition at line 253 of file MultiLayerForm.cpp.

{
    m_useAngstrom = angstrom;
    updateUnits();
}

References angstrom, m_useAngstrom, and updateUnits().

Referenced by LayerOrientedSampleEditor::onUnitActionToggled(), and LayerOrientedSampleEditor::setCurrentSample().

Here is the call graph for this function:

setUseRadiant()

void MultiLayerForm::setUseRadiant

(

bool

radiant

)

Show values in radiants or degrees.

Definition at line 264 of file MultiLayerForm.cpp.

{
    m_useRadiant = radiant;
    updateUnits();
}

References m_useRadiant, radiant, and updateUnits().

Here is the call graph for this function:

showAddLayerButtons()

void MultiLayerForm::showAddLayerButtons

(

bool

show

)

Shows or hides the "Add Layer" buttons.

Definition at line 275 of file MultiLayerForm.cpp.

{
    for (auto* c : findChildren<QWidget*>())
        if (dynamic_cast<AddLayerWidget*>(c))
            c->setVisible(show);
}

Referenced by SampleEditorController::onStartingToMoveLayer(), SampleEditorController::onStoppedToMoveLayer(), and updateRowVisibilities().

showInlineEditButtons()

void MultiLayerForm::showInlineEditButtons

(

bool

b

)

Show or hide all buttons related to structure editing (like "add layer", "remove particle")

Definition at line 108 of file MultiLayerForm.cpp.

{
    m_showInlineEditButtons = b;
    updateRowVisibilities();
}

References m_showInlineEditButtons, and updateRowVisibilities().

Referenced by LayerOrientedSampleEditor::onShowInlineEditButtonsToggled(), and LayerOrientedSampleEditor::setCurrentSample().

Here is the call graph for this function:

updateRowVisibilities()

void MultiLayerForm::updateRowVisibilities

(

)

Definition at line 188 of file MultiLayerForm.cpp.

{
    for (auto* c : findChildren<QWidget*>()) {
        if (auto* w = dynamic_cast<LayerForm*>(c))
            w->enableStructureEditing(m_showInlineEditButtons);
        if (auto* w = dynamic_cast<ParticleLayoutForm*>(c))
            w->enableStructureEditing(m_showInlineEditButtons);
        if (auto* w = dynamic_cast<ParticleForm*>(c))
            w->enableStructureEditing(m_showInlineEditButtons);
        if (auto* w = dynamic_cast<ParticleCompositionForm*>(c))
            w->enableStructureEditing(m_showInlineEditButtons);
        if (auto* w = dynamic_cast<ParticleCoreShellForm*>(c))
            w->enableStructureEditing(m_showInlineEditButtons);
        if (auto* w = dynamic_cast<MesoCrystalForm*>(c))
            w->enableStructureEditing(m_showInlineEditButtons);
    }
 
    showAddLayerButtons(m_showInlineEditButtons);
 
    for (auto* c : findChildren<LayerForm*>())
        c->updateLayerPositionDependentElements();
}

References m_showInlineEditButtons, and showAddLayerButtons().

Referenced by onLayerAdded(), onLayerMoved(), SampleEditorController::removeLayerFromUndo(), and showInlineEditButtons().

Here is the call graph for this function:

updateUnits()

void MultiLayerForm::updateUnits

(

)

Update the presented units in all contained widgets according to current settings.

Definition at line 212 of file MultiLayerForm.cpp.

{
    const auto set = [](DoubleSpinBox* spinbox, Unit valueUnit, Unit displayUnit) {
        if (spinbox->baseUnit() == valueUnit)
            spinbox->setDisplayUnit(displayUnit);
    };
 
    for (auto* editor : findChildren<DoubleSpinBox*>()) {
        if (m_useAngstrom) {
            set(editor, Unit::nanometer, Unit::angstrom);
            set(editor, Unit::angstrom, Unit::angstrom);
            set(editor, Unit::nanometer2, Unit::angstrom2);
            set(editor, Unit::angstrom2, Unit::angstrom2);
            set(editor, Unit::nanometerMinus2, Unit::angstromMinus2);
            set(editor, Unit::angstromMinus2, Unit::angstromMinus2);
        } else {
            set(editor, Unit::nanometer, Unit::nanometer);
            set(editor, Unit::angstrom, Unit::nanometer);
            set(editor, Unit::nanometer2, Unit::nanometer2);
            set(editor, Unit::angstrom2, Unit::nanometer2);
            set(editor, Unit::nanometerMinus2, Unit::nanometerMinus2);
            set(editor, Unit::angstromMinus2, Unit::nanometerMinus2);
        }
 
        if (m_useRadiant) {
            set(editor, Unit::degree, Unit::radiant);
            set(editor, Unit::radiant, Unit::radiant);
        } else {
            set(editor, Unit::degree, Unit::degree);
            set(editor, Unit::radiant, Unit::degree);
        }
    }
    for (auto* label : findChildren<QLabel*>())
        LayerEditorUtils::updateLabelUnit(label);
}

References angstrom, angstrom2, angstromMinus2, DoubleSpinBox::baseUnit(), degree, m_useAngstrom, m_useRadiant, nanometer, nanometer2, nanometerMinus2, radiant, DoubleSpinBox::setDisplayUnit(), and LayerEditorUtils::updateLabelUnit().

Referenced by SampleEditorController::addLayerFromUndo(), SampleEditorController::addLayout(), SampleEditorController::addParticle(), SampleEditorController::selectInterference(), SampleEditorController::setCoreFormFactor(), SampleEditorController::setCurrentIndex(), SampleEditorController::setMesoCrystalBasis(), SampleEditorController::setShellFormFactor(), setUseAngstrom(), and setUseRadiant().

Here is the call graph for this function:

useAngstrom()

bool MultiLayerForm::useAngstrom

(

)

const

Definition at line 259 of file MultiLayerForm.cpp.

{
    return m_useAngstrom;
}

References m_useAngstrom.

useRadiant()

bool MultiLayerForm::useRadiant

(

)

const

Definition at line 270 of file MultiLayerForm.cpp.

{
    return m_useRadiant;
}

References m_useRadiant.

Member Data Documentation

m_addLayerButtons

QList<QPushButton*> MultiLayerForm::m_addLayerButtons

private

Definition at line 80 of file MultiLayerForm.h.

m_ec

SampleEditorController* MultiLayerForm::m_ec

private

Ptr is borrowed, don't delete.

Definition at line 76 of file MultiLayerForm.h.

Referenced by MultiLayerForm(), and onLayerAdded().

m_layout

QVBoxLayout* MultiLayerForm::m_layout

private

Definition at line 74 of file MultiLayerForm.h.

Referenced by MultiLayerForm(), findNextLayerForm(), onLayerAdded(), and onLayerMoved().

m_sampleItem

MultiLayerItem* MultiLayerForm::m_sampleItem

private

Ptr is borrowed, don't delete.

Definition at line 75 of file MultiLayerForm.h.

Referenced by MultiLayerForm(), onLayerAdded(), and onLayerMoved().

m_showInlineEditButtons

bool MultiLayerForm::m_showInlineEditButtons = false

private

Definition at line 77 of file MultiLayerForm.h.

Referenced by showInlineEditButtons(), and updateRowVisibilities().

m_useAngstrom

bool MultiLayerForm::m_useAngstrom

private

Definition at line 78 of file MultiLayerForm.h.

Referenced by setUseAngstrom(), updateUnits(), and useAngstrom().

m_useRadiant

bool MultiLayerForm::m_useRadiant

private

Definition at line 79 of file MultiLayerForm.h.

Referenced by setUseRadiant(), updateUnits(), and useRadiant().

---

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

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