LayerOrientedSampleEditor Class Reference

Description

Sample editor with layer oriented presentation of a sample.

Definition at line 31 of file LayerOrientedSampleEditor.h.

Inheritance diagram for LayerOrientedSampleEditor:

Collaboration diagram for LayerOrientedSampleEditor:

Signals
void	aboutToRemoveItem (SampleItem item)
void	modified ()
void	requestCreateNewSample ()
void	requestViewInRealSpace (SampleItem itemToShow)

Public Member Functions
	LayerOrientedSampleEditor (QWidget *parent, ProjectDocument *document)
	~LayerOrientedSampleEditor () override
void	setCurrentSample (MultiLayerItem *sampleItem)

Private Member Functions
QWidget *	createEmptyWidget ()
	Create empty widget with a button for sample creation. More...
void	createLayerColors ()
void	onShowInlineEditButtonsToggled (bool checked)
void	onUnitActionToggled ()
void	updateActionEnabling ()

Private Attributes
QAction *	m_asAngstromAction
MultiLayerItem *	m_currentMultiLayerItem = nullptr
MultiLayerForm *	m_currentMultiLayerWidget
ProjectDocument *	m_document
QMap< MultiLayerItem *, SampleEditorController * >	m_editControllers
QAction *	m_redoAction
QScrollArea *	m_scrollArea
QAction *	m_showInlineEditButtonsAction
QToolBar *	m_toolbar
QAction *	m_undoAction

Constructor & Destructor Documentation

LayerOrientedSampleEditor()

LayerOrientedSampleEditor::LayerOrientedSampleEditor	(	QWidget *	parent,
		ProjectDocument *	document
	)

Definition at line 28 of file LayerOrientedSampleEditor.cpp.

    : QWidget(parent)
    , m_currentMultiLayerWidget(nullptr)
    , m_undoAction(nullptr)
    , m_redoAction(nullptr)
    , m_showInlineEditButtonsAction(nullptr)
    , m_asAngstromAction(nullptr)
    , m_currentMultiLayerItem(nullptr)
    , m_document(document)
{
    setAttribute(Qt::WA_StyledBackground, true);
    setProperty("stylable", true); // for stylesheet addressing
 
    m_scrollArea = new QScrollArea(this);
    m_scrollArea->setWidgetResizable(true);
    m_scrollArea->setWidget(createEmptyWidget());
 
    m_toolbar = new StyledToolbar(this);
    m_toolbar->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
 
    auto* mainLayout = new QVBoxLayout(this);
    mainLayout->setContentsMargins(0, 0, 0, 0);
    mainLayout->setSpacing(0);
    mainLayout->addWidget(m_toolbar);
    mainLayout->addWidget(m_scrollArea);
 
    m_showInlineEditButtonsAction = new QAction(QIcon(":/images/edit.svg"), "Edit structure", this);
    connect(m_showInlineEditButtonsAction, &QAction::toggled, this,
            &LayerOrientedSampleEditor::onShowInlineEditButtonsToggled);
    m_showInlineEditButtonsAction->setCheckable(true);
    m_showInlineEditButtonsAction->setChecked(true);
    m_toolbar->addAction(m_showInlineEditButtonsAction);
 
    m_asAngstromAction = new QAction(this);
    m_asAngstromAction->setIcon(QIcon(":/images/unit_angstrom.svg"));
    m_asAngstromAction->setToolTip(u8"Use \u00c5ngstrom as unit (where applicable)");
    connect(m_asAngstromAction, &QAction::toggled, this,
            &LayerOrientedSampleEditor::onUnitActionToggled);
    m_asAngstromAction->setCheckable(true);
 
    auto* asNanometerAction = new QAction(this);
    asNanometerAction->setIcon(QIcon(":/images/unit_nm.svg"));
    asNanometerAction->setToolTip("Use nanometer as unit (where applicable)");
    connect(asNanometerAction, &QAction::toggled, this,
            &LayerOrientedSampleEditor::onUnitActionToggled);
    asNanometerAction->setCheckable(true);
 
    auto* ag = new QActionGroup(this);
    ag->addAction(asNanometerAction);
    ag->addAction(m_asAngstromAction);
    if (appSettings->defaultUnitIsAngstrom())
        m_asAngstromAction->setChecked(true);
    else
        asNanometerAction->setChecked(true);
 
    m_toolbar->addActions(ag->actions());
}

References appSettings, createEmptyWidget(), ApplicationSettings::defaultUnitIsAngstrom(), m_asAngstromAction, m_scrollArea, m_showInlineEditButtonsAction, m_toolbar, onShowInlineEditButtonsToggled(), and onUnitActionToggled().

Here is the call graph for this function:

~LayerOrientedSampleEditor()

LayerOrientedSampleEditor::~LayerOrientedSampleEditor ( )

override

Definition at line 86 of file LayerOrientedSampleEditor.cpp.

{
    qDeleteAll(m_editControllers.values());
}

References m_editControllers.

Member Function Documentation

aboutToRemoveItem

void LayerOrientedSampleEditor::aboutToRemoveItem ( SampleItem  item )

signal

Referenced by SampleView::SampleView(), and setCurrentSample().

createEmptyWidget()

QWidget * LayerOrientedSampleEditor::createEmptyWidget ( )

private

Create empty widget with a button for sample creation.

Definition at line 180 of file LayerOrientedSampleEditor.cpp.

{
    auto* emptyWidget = new QWidget(this);
    emptyWidget->setProperty("stylable", true); // for stylesheet addressing
 
    auto* btn = new QPushButton("Create sample", emptyWidget);
    connect(btn, &QPushButton::clicked, this, &LayerOrientedSampleEditor::requestCreateNewSample);
 
    auto* layout = new QHBoxLayout(emptyWidget);
    layout->setContentsMargins(10, 20, 10, 20);
    layout->addStretch();
    layout->addWidget(btn);
    layout->addStretch();
    layout->setAlignment(Qt::AlignTop);
 
    return emptyWidget;
}

References requestCreateNewSample().

Referenced by LayerOrientedSampleEditor(), and setCurrentSample().

createLayerColors()

void LayerOrientedSampleEditor::createLayerColors ( )

private

Definition at line 163 of file LayerOrientedSampleEditor.cpp.

{
    if (!m_currentMultiLayerItem)
        return;
 
    int col = 0;
    for (auto* l : m_currentMultiLayerItem->layers()) {
        if (l->color().isValid())
            continue;
 
        l->setColor(LayerEditorUtils::predefinedLayerColors()[col]);
        col++;
        if (col == LayerEditorUtils::predefinedLayerColors().size())
            col = 0;
    }
}

References MultiLayerItem::layers(), m_currentMultiLayerItem, and LayerEditorUtils::predefinedLayerColors().

Referenced by setCurrentSample().

Here is the call graph for this function:

modified

void LayerOrientedSampleEditor::modified ( )

signal

Referenced by SampleView::SampleView(), and setCurrentSample().

onShowInlineEditButtonsToggled()

void LayerOrientedSampleEditor::onShowInlineEditButtonsToggled ( bool  checked )

private

Definition at line 151 of file LayerOrientedSampleEditor.cpp.

{
    if (m_currentMultiLayerWidget)
        m_currentMultiLayerWidget->showInlineEditButtons(checked);
}

References m_currentMultiLayerWidget, and MultiLayerForm::showInlineEditButtons().

Referenced by LayerOrientedSampleEditor().

Here is the call graph for this function:

onUnitActionToggled()

void LayerOrientedSampleEditor::onUnitActionToggled ( )

private

Definition at line 157 of file LayerOrientedSampleEditor.cpp.

{
    if (m_currentMultiLayerWidget)
        m_currentMultiLayerWidget->setUseAngstrom(m_asAngstromAction->isChecked());
}

References m_asAngstromAction, m_currentMultiLayerWidget, and MultiLayerForm::setUseAngstrom().

Referenced by LayerOrientedSampleEditor().

Here is the call graph for this function:

requestCreateNewSample

void LayerOrientedSampleEditor::requestCreateNewSample ( )

signal

Referenced by SampleView::SampleView(), and createEmptyWidget().

requestViewInRealSpace

void LayerOrientedSampleEditor::requestViewInRealSpace ( SampleItem  itemToShow )

signal

Referenced by SampleView::SampleView(), and setCurrentSample().

setCurrentSample()

void LayerOrientedSampleEditor::setCurrentSample

(

MultiLayerItem *

sampleItem

)

Definition at line 91 of file LayerOrientedSampleEditor.cpp.

{
    if (m_currentMultiLayerItem != nullptr)
        m_editControllers[m_currentMultiLayerItem]->setMultiLayerForm(nullptr);
 
    m_currentMultiLayerWidget = nullptr;
    delete m_scrollArea->takeWidget();
 
    // use the correct toolbar buttons (from correct undo stack)
    delete m_undoAction;
    m_undoAction = nullptr;
    delete m_redoAction;
    m_redoAction = nullptr;
 
    m_currentMultiLayerItem = sampleItem;
    if (m_currentMultiLayerItem == nullptr) {
        m_scrollArea->setWidget(createEmptyWidget());
        updateActionEnabling();
        return;
    }
 
    if (!m_editControllers.contains(m_currentMultiLayerItem))
        m_editControllers.insert(m_currentMultiLayerItem,
                                 new SampleEditorController(m_document, m_currentMultiLayerItem));
    auto* ec = m_editControllers[m_currentMultiLayerItem];
    connect(ec, &SampleEditorController::requestViewInRealSpace, this,
            &LayerOrientedSampleEditor::requestViewInRealSpace);
    connect(ec, &SampleEditorController::aboutToRemoveItem, this,
            &LayerOrientedSampleEditor::aboutToRemoveItem);
    connect(ec, &SampleEditorController::modified, this, &LayerOrientedSampleEditor::modified);
 
    m_undoAction = ec->undoStack()->createUndoAction(this);
    m_redoAction = ec->undoStack()->createRedoAction(this);
    m_undoAction->setIcon(QIcon(":/images/undo-variant.svg"));
    m_redoAction->setIcon(QIcon(":/images/redo.svg"));
 
    m_toolbar->addAction(m_undoAction);
    m_toolbar->addAction(m_redoAction);
 
    createLayerColors();
 
    m_currentMultiLayerWidget = new MultiLayerForm(this, m_currentMultiLayerItem, ec);
    ec->setMultiLayerForm(m_currentMultiLayerWidget);
    m_currentMultiLayerWidget->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Minimum);
    m_scrollArea->setWidget(m_currentMultiLayerWidget);
    m_currentMultiLayerWidget->showInlineEditButtons(m_showInlineEditButtonsAction->isChecked());
    m_currentMultiLayerWidget->setUseAngstrom(m_asAngstromAction->isChecked());
 
    updateActionEnabling();
}

References aboutToRemoveItem(), SampleEditorController::aboutToRemoveItem(), createEmptyWidget(), createLayerColors(), m_asAngstromAction, m_currentMultiLayerItem, m_currentMultiLayerWidget, m_document, m_editControllers, m_redoAction, m_scrollArea, m_showInlineEditButtonsAction, m_toolbar, m_undoAction, modified(), SampleEditorController::modified(), SampleEditorController::requestViewInRealSpace(), requestViewInRealSpace(), MultiLayerForm::setUseAngstrom(), MultiLayerForm::showInlineEditButtons(), and updateActionEnabling().

Referenced by SampleView::SampleView().

Here is the call graph for this function:

updateActionEnabling()

void LayerOrientedSampleEditor::updateActionEnabling ( )

private

Definition at line 142 of file LayerOrientedSampleEditor.cpp.

{
    // Undo/Redo is not complete => hide the related buttons/actions
    if (m_undoAction)
        m_undoAction->setVisible(false);
    if (m_redoAction)
        m_redoAction->setVisible(false);
}

References m_redoAction, and m_undoAction.

Referenced by setCurrentSample().

Member Data Documentation

m_asAngstromAction

QAction* LayerOrientedSampleEditor::m_asAngstromAction

private

Definition at line 62 of file LayerOrientedSampleEditor.h.

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

m_currentMultiLayerItem

MultiLayerItem* LayerOrientedSampleEditor::m_currentMultiLayerItem = nullptr

private

Definition at line 63 of file LayerOrientedSampleEditor.h.

Referenced by createLayerColors(), and setCurrentSample().

m_currentMultiLayerWidget

MultiLayerForm* LayerOrientedSampleEditor::m_currentMultiLayerWidget

private

Definition at line 56 of file LayerOrientedSampleEditor.h.

Referenced by onShowInlineEditButtonsToggled(), onUnitActionToggled(), and setCurrentSample().

m_document

ProjectDocument* LayerOrientedSampleEditor::m_document

private

Definition at line 65 of file LayerOrientedSampleEditor.h.

Referenced by setCurrentSample().

m_editControllers

QMap<MultiLayerItem*, SampleEditorController*> LayerOrientedSampleEditor::m_editControllers

private

Definition at line 64 of file LayerOrientedSampleEditor.h.

Referenced by ~LayerOrientedSampleEditor(), and setCurrentSample().

m_redoAction

QAction* LayerOrientedSampleEditor::m_redoAction

private

Definition at line 60 of file LayerOrientedSampleEditor.h.

Referenced by setCurrentSample(), and updateActionEnabling().

m_scrollArea

QScrollArea* LayerOrientedSampleEditor::m_scrollArea

private

Definition at line 57 of file LayerOrientedSampleEditor.h.

Referenced by LayerOrientedSampleEditor(), and setCurrentSample().

m_showInlineEditButtonsAction

QAction* LayerOrientedSampleEditor::m_showInlineEditButtonsAction

private

Definition at line 61 of file LayerOrientedSampleEditor.h.

Referenced by LayerOrientedSampleEditor(), and setCurrentSample().

m_toolbar

QToolBar* LayerOrientedSampleEditor::m_toolbar

private

Definition at line 58 of file LayerOrientedSampleEditor.h.

Referenced by LayerOrientedSampleEditor(), and setCurrentSample().

m_undoAction

QAction* LayerOrientedSampleEditor::m_undoAction

private

Definition at line 59 of file LayerOrientedSampleEditor.h.

Referenced by setCurrentSample(), and updateActionEnabling().

---

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

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