InstrumentLibraryEditor Class Reference

Description

Definition at line 28 of file InstrumentLibraryEditor.h.

Inheritance diagram for InstrumentLibraryEditor:

Collaboration diagram for InstrumentLibraryEditor:

Classes
class	TreeModel
	A model extension for InstrumentsTreeModel which. More...

Public Member Functions
	InstrumentLibraryEditor (QWidget *parent)
	~InstrumentLibraryEditor () override
void	execAdd (const InstrumentItem &instrumentToAdd)
	Execute the dialog to add an instrument to the library. More...
InstrumentItem *	execChoose ()
	Execute the dialog for choosing an instrument from the library. Returns nullptr if canceled. More...
void	setDepthProbeEnabled (bool b)
void	setGisasEnabled (bool b)
void	setOffspecEnabled (bool b)
void	setSpecularEnabled (bool b)

Private Member Functions
void	createWidgetsForCurrentInstrument ()
QList< QAction * >	getOverlayActions (const QModelIndex &index, bool asHover)
void	onCurrentChangedForChoose ()
void	onInstrumentChangedByEditor ()
void	onInstrumentDescriptionEdited (const QString &t)
void	onInstrumentNameEdited (const QString &newName)
void	onItemDoubleClickedForChoose (const QModelIndex &index)

Private Attributes
InstrumentItem *	m_chosenItem
TreeModel *	m_treeModel
Ui::InstrumentLibraryEditor *	m_ui

Constructor & Destructor Documentation

InstrumentLibraryEditor()

InstrumentLibraryEditor::InstrumentLibraryEditor

(

QWidget *

parent

)

Definition at line 36 of file InstrumentLibraryEditor.cpp.

    : QDialog(parent)
    , m_ui(new Ui::InstrumentLibraryEditor)
    , m_treeModel(new TreeModel(this, gSessionData->instrumentLibrary.collectedItems()))
    , m_chosenItem(nullptr)
{
    m_ui->setupUi(this);
 
    setAttribute(Qt::WA_StyledBackground, true);
    setProperty("stylable", true); // for stylesheet addressing
    setWindowIcon(QIcon(":/images/library.svg"));
    setWindowFlag(Qt::WindowContextHelpButtonHint, false);
 
    m_treeModel->enableEmptyHeadlines(false);
 
    m_ui->treeView->setItemsExpandable(false);
    m_ui->treeView->setRootIsDecorated(false);
    m_ui->treeView->setHeaderHidden(true);
    m_ui->treeView->setContextMenuPolicy(Qt::CustomContextMenu);
    m_ui->treeView->setModel(m_treeModel);
    m_ui->treeView->expandAll();
    m_ui->treeView->setVerticalScrollMode(QTreeView::ScrollPerPixel);
    m_ui->treeView->setIndentation(0);
    m_ui->treeView->setItemDelegate(new ItemDelegateForHTML(this));
    m_ui->treeView->setIconSize(QSize(128, 128));
 
    connect(m_treeModel, &QAbstractItemModel::modelReset,
            [this]() { m_ui->treeView->expandAll(); });
 
    // ensure a current item when widget is shown
    // setCurrentItem(m_treeModel->topMostItem());
    GUI::Util::Style::setResizable(this);
    appSettings->loadWindowSizeAndPos(this);
}

References appSettings, InstrumentsTreeModel::enableEmptyHeadlines(), ApplicationSettings::loadWindowSizeAndPos(), m_treeModel, m_ui, and GUI::Util::Style::setResizable().

Here is the call graph for this function:

~InstrumentLibraryEditor()

InstrumentLibraryEditor::~InstrumentLibraryEditor ( )

override

Definition at line 71 of file InstrumentLibraryEditor.cpp.

{
    appSettings->saveWindowSizeAndPos(this);
}

References appSettings, and ApplicationSettings::saveWindowSizeAndPos().

Here is the call graph for this function:

Member Function Documentation

createWidgetsForCurrentInstrument()

void InstrumentLibraryEditor::createWidgetsForCurrentInstrument ( )

private

Definition at line 182 of file InstrumentLibraryEditor.cpp.

{
    auto* currentInstrument = m_treeModel->itemForIndex(m_ui->treeView->currentIndex());
    if (!currentInstrument) {
        m_ui->scrollArea->setWidget(new QWidget(m_ui->scrollArea)); // blank widget
        return;
    }
 
    QWidget* w = new QWidget(m_ui->scrollArea);
    auto* layout = new QVBoxLayout(w);
 
    w->setAttribute(Qt::WA_StyledBackground, true);
    w->setProperty("stylable", true); // for stylesheet addressing
 
    auto* g = new QGroupBox(m_ui->scrollArea);
    g->setTitle(QString("Information (%1 instrument)").arg(currentInstrument->instrumentType()));
 
    auto* formLayout = new QFormLayout(g);
    formLayout->setMargin(17);
    formLayout->setSpacing(8);
    layout->addWidget(g);
 
    auto* nameEdit = new QLineEdit(g);
    formLayout->addRow("Name:", nameEdit);
    nameEdit->setText(currentInstrument->instrumentName());
    connect(nameEdit, &QLineEdit::textEdited, this,
            &InstrumentLibraryEditor::onInstrumentNameEdited);
 
    auto* descriptionEdit = new QTextEdit(g);
    descriptionEdit->setMinimumWidth(300);
    descriptionEdit->setMaximumHeight(100);
    descriptionEdit->setAcceptRichText(false);
    descriptionEdit->setTabChangesFocus(true);
    descriptionEdit->setPlainText(currentInstrument->description());
    formLayout->addRow("Description:", descriptionEdit);
    connect(descriptionEdit, &QTextEdit::textChanged,
            [=]() { onInstrumentDescriptionEdited(descriptionEdit->toPlainText()); });
 
    GroupBoxCollapser::installIntoGroupBox(g);
 
    if (auto* sp = dynamic_cast<SpecularInstrumentItem*>(currentInstrument)) {
        auto* editor = new SpecularInstrumentEditor(
            m_ui->scrollArea, sp, gSessionData->instrumentLibrary.editController());
        connect(editor, &SpecularInstrumentEditor::dataChanged, this,
                &InstrumentLibraryEditor::onInstrumentChangedByEditor);
        layout->addWidget(editor);
    } else if (auto* os = dynamic_cast<OffspecInstrumentItem*>(currentInstrument)) {
        auto* editor = new OffspecInstrumentEditor(m_ui->scrollArea, os);
        connect(editor, &OffspecInstrumentEditor::dataChanged, this,
                &InstrumentLibraryEditor::onInstrumentChangedByEditor);
        layout->addWidget(editor);
    } else if (auto* gisas = dynamic_cast<GISASInstrumentItem*>(currentInstrument)) {
        auto* editor = new GISASInstrumentEditor(m_ui->scrollArea, gisas);
        connect(editor, &GISASInstrumentEditor::dataChanged, this,
                &InstrumentLibraryEditor::onInstrumentChangedByEditor);
        layout->addWidget(editor);
    } else if (auto* dp = dynamic_cast<DepthProbeInstrumentItem*>(currentInstrument)) {
        auto* editor = new DepthProbeInstrumentEditor(m_ui->scrollArea, dp);
        connect(editor, &DepthProbeInstrumentEditor::dataChanged, this,
                &InstrumentLibraryEditor::onInstrumentChangedByEditor);
        layout->addWidget(editor);
    } else
        ASSERT(false);
 
    m_ui->scrollArea->setWidget(w);
}

References DepthProbeInstrumentEditor::dataChanged(), GISASInstrumentEditor::dataChanged(), OffspecInstrumentEditor::dataChanged(), SpecularInstrumentEditor::dataChanged(), InstrumentLibrary::editController(), gSessionData, GroupBoxCollapser::installIntoGroupBox(), SessionData::instrumentLibrary, InstrumentsTreeModel::itemForIndex(), m_treeModel, m_ui, onInstrumentChangedByEditor(), onInstrumentDescriptionEdited(), and onInstrumentNameEdited().

Referenced by execAdd(), and onCurrentChangedForChoose().

Here is the call graph for this function:

execAdd()

void InstrumentLibraryEditor::execAdd

(

const InstrumentItem &

instrumentToAdd

)

Execute the dialog to add an instrument to the library.

Definition at line 116 of file InstrumentLibraryEditor.cpp.

{
    const QString& newName =
        gSessionData->instrumentLibrary.suggestName(instrumentToAdd.instrumentName());
    auto* addedInstrument = gSessionData->instrumentLibrary.add(newName, instrumentToAdd);
 
    setWindowTitle("Instrument Library - Add instrument");
 
    m_treeModel->setNewInstrument(addedInstrument);
    m_treeModel->setTypeEnabled(TreeModel::instrumentType(addedInstrument), true);
 
    ItemViewOverlayButtons::install(
        m_ui->treeView, [=](const QModelIndex& i, bool h) { return getOverlayActions(i, h); });
    m_ui->treeView->setItemDelegate(new ItemDelegateForHTML(this));
    connect(m_ui->treeView->selectionModel(), &QItemSelectionModel::currentChanged, this,
            &InstrumentLibraryEditor::createWidgetsForCurrentInstrument);
 
    m_ui->buttonBox->addButton(QDialogButtonBox::Close);
    m_ui->buttonBox->button(QDialogButtonBox::Ok)->hide();
    m_ui->buttonBox->button(QDialogButtonBox::Cancel)->hide();
 
    QModelIndex index = m_treeModel->indexForItem(addedInstrument);
    m_ui->treeView->expandAll();
    m_ui->treeView->setCurrentIndex(index);
    m_ui->treeView->scrollTo(index, QAbstractItemView::PositionAtTop);
    createWidgetsForCurrentInstrument();
    exec();
}

References InstrumentLibrary::add(), createWidgetsForCurrentInstrument(), gSessionData, InstrumentsTreeModel::indexForItem(), ItemViewOverlayButtons::install(), SessionData::instrumentLibrary, InstrumentItem::instrumentName(), InstrumentsTreeModel::instrumentType(), m_treeModel, m_ui, InstrumentLibraryEditor::TreeModel::setNewInstrument(), InstrumentsTreeModel::setTypeEnabled(), and InstrumentLibrary::suggestName().

Referenced by InstrumentListView::onStoreInLibrary().

Here is the call graph for this function:

execChoose()

InstrumentItem * InstrumentLibraryEditor::execChoose

(

)

Execute the dialog for choosing an instrument from the library. Returns nullptr if canceled.

Definition at line 96 of file InstrumentLibraryEditor.cpp.

{
    setWindowTitle("Instrument Library - Choose instrument");
 
    ItemViewOverlayButtons::install(
        m_ui->treeView, [=](const QModelIndex& i, bool h) { return getOverlayActions(i, h); });
    m_ui->treeView->setItemDelegate(new ItemDelegateForHTML(this));
 
    connect(m_ui->treeView, &QTreeView::doubleClicked, this,
            &InstrumentLibraryEditor::onItemDoubleClickedForChoose);
    connect(m_ui->treeView->selectionModel(), &QItemSelectionModel::currentChanged, this,
            &InstrumentLibraryEditor::onCurrentChangedForChoose);
    onCurrentChangedForChoose();
 
    if (exec() == QDialog::Accepted)
        return m_chosenItem;
 
    return nullptr;
}

References ItemViewOverlayButtons::install(), m_chosenItem, m_ui, onCurrentChangedForChoose(), and onItemDoubleClickedForChoose().

Referenced by InstrumentListView::onLoadFromLibrary().

Here is the call graph for this function:

getOverlayActions()

QList< QAction * > InstrumentLibraryEditor::getOverlayActions ( const QModelIndex &  index, bool  asHover  )

private

Definition at line 159 of file InstrumentLibraryEditor.cpp.

{
    if (m_treeModel->isHeadline(index))
        return {};
 
    // -- index belongs to item
    if (!asHover)
        return {};
 
    auto* item = m_treeModel->itemForIndex(index);
    if (item == nullptr)
        return {};
 
    auto* removeAction = new QAction(this);
    removeAction->setText("Remove");
    removeAction->setIcon(QIcon(":/images/delete.svg"));
    removeAction->setIconText("Remove");
    removeAction->setToolTip("Remove this instrument");
    connect(removeAction, &QAction::triggered, [=]() { m_treeModel->removeItem(item); });
 
    return {removeAction};
}

References InstrumentsTreeModel::isHeadline(), InstrumentsTreeModel::itemForIndex(), m_treeModel, and InstrumentsTreeModel::removeItem().

Here is the call graph for this function:

onCurrentChangedForChoose()

void InstrumentLibraryEditor::onCurrentChangedForChoose ( )

private

Definition at line 152 of file InstrumentLibraryEditor.cpp.

{
    m_chosenItem = m_treeModel->itemForIndex(m_ui->treeView->currentIndex());
    m_ui->buttonBox->button(QDialogButtonBox::Ok)->setEnabled(m_chosenItem != nullptr);
    createWidgetsForCurrentInstrument();
}

References createWidgetsForCurrentInstrument(), InstrumentsTreeModel::itemForIndex(), m_chosenItem, m_treeModel, and m_ui.

Referenced by execChoose().

Here is the call graph for this function:

onInstrumentChangedByEditor()

void InstrumentLibraryEditor::onInstrumentChangedByEditor ( )

private

Definition at line 261 of file InstrumentLibraryEditor.cpp.

{
    auto* currentInstrument = m_treeModel->itemForIndex(m_ui->treeView->currentIndex());
    gSessionData->instrumentLibrary.editController()->notifyInstrumentChanged(currentInstrument);
}

References InstrumentLibrary::editController(), gSessionData, SessionData::instrumentLibrary, InstrumentsTreeModel::itemForIndex(), m_treeModel, m_ui, and InstrumentsEditController::notifyInstrumentChanged().

Referenced by createWidgetsForCurrentInstrument().

Here is the call graph for this function:

onInstrumentDescriptionEdited()

void InstrumentLibraryEditor::onInstrumentDescriptionEdited ( const QString &  t )

private

Definition at line 255 of file InstrumentLibraryEditor.cpp.

{
    QModelIndex index = m_ui->treeView->currentIndex();
    m_treeModel->setData(index, t, Qt::ToolTipRole);
}

References m_treeModel, m_ui, and InstrumentsTreeModel::setData().

Referenced by createWidgetsForCurrentInstrument().

Here is the call graph for this function:

onInstrumentNameEdited()

void InstrumentLibraryEditor::onInstrumentNameEdited ( const QString &  newName )

private

Definition at line 249 of file InstrumentLibraryEditor.cpp.

{
    QModelIndex index = m_ui->treeView->currentIndex();
    m_treeModel->setData(index, newName, Qt::EditRole);
}

References m_treeModel, m_ui, and InstrumentsTreeModel::setData().

Referenced by createWidgetsForCurrentInstrument().

Here is the call graph for this function:

onItemDoubleClickedForChoose()

void InstrumentLibraryEditor::onItemDoubleClickedForChoose ( const QModelIndex &  index )

private

Definition at line 145 of file InstrumentLibraryEditor.cpp.

{
    m_chosenItem = m_treeModel->itemForIndex(index);
    if (m_chosenItem != nullptr)
        accept();
}

References InstrumentsTreeModel::itemForIndex(), m_chosenItem, and m_treeModel.

Referenced by execChoose().

Here is the call graph for this function:

setDepthProbeEnabled()

void InstrumentLibraryEditor::setDepthProbeEnabled

(

bool

b

)

Definition at line 91 of file InstrumentLibraryEditor.cpp.

{
    m_treeModel->setTypeEnabled(InstrumentsTreeModel::DepthProbe, b);
}

References InstrumentsTreeModel::DepthProbe, m_treeModel, and InstrumentsTreeModel::setTypeEnabled().

Referenced by InstrumentListView::onLoadFromLibrary(), and InstrumentListView::onStoreInLibrary().

Here is the call graph for this function:

setGisasEnabled()

void InstrumentLibraryEditor::setGisasEnabled

(

bool

b

)

Definition at line 76 of file InstrumentLibraryEditor.cpp.

{
    m_treeModel->setTypeEnabled(InstrumentsTreeModel::Gisas, b);
}

References InstrumentsTreeModel::Gisas, m_treeModel, and InstrumentsTreeModel::setTypeEnabled().

Referenced by InstrumentListView::onLoadFromLibrary(), and InstrumentListView::onStoreInLibrary().

Here is the call graph for this function:

setOffspecEnabled()

void InstrumentLibraryEditor::setOffspecEnabled

(

bool

b

)

Definition at line 81 of file InstrumentLibraryEditor.cpp.

{
    m_treeModel->setTypeEnabled(InstrumentsTreeModel::Offspec, b);
}

References m_treeModel, InstrumentsTreeModel::Offspec, and InstrumentsTreeModel::setTypeEnabled().

Referenced by InstrumentListView::onLoadFromLibrary(), and InstrumentListView::onStoreInLibrary().

Here is the call graph for this function:

setSpecularEnabled()

void InstrumentLibraryEditor::setSpecularEnabled

(

bool

b

)

Definition at line 86 of file InstrumentLibraryEditor.cpp.

{
    m_treeModel->setTypeEnabled(InstrumentsTreeModel::Specular, b);
}

References m_treeModel, InstrumentsTreeModel::setTypeEnabled(), and InstrumentsTreeModel::Specular.

Referenced by InstrumentListView::onLoadFromLibrary(), and InstrumentListView::onStoreInLibrary().

Here is the call graph for this function:

Member Data Documentation

m_chosenItem

InstrumentItem* InstrumentLibraryEditor::m_chosenItem

private

Definition at line 76 of file InstrumentLibraryEditor.h.

Referenced by execChoose(), onCurrentChangedForChoose(), and onItemDoubleClickedForChoose().

m_treeModel

TreeModel* InstrumentLibraryEditor::m_treeModel

private

Definition at line 75 of file InstrumentLibraryEditor.h.

Referenced by InstrumentLibraryEditor(), createWidgetsForCurrentInstrument(), execAdd(), getOverlayActions(), onCurrentChangedForChoose(), onInstrumentChangedByEditor(), onInstrumentDescriptionEdited(), onInstrumentNameEdited(), onItemDoubleClickedForChoose(), setDepthProbeEnabled(), setGisasEnabled(), setOffspecEnabled(), and setSpecularEnabled().

m_ui

Ui::InstrumentLibraryEditor* InstrumentLibraryEditor::m_ui

private

Definition at line 74 of file InstrumentLibraryEditor.h.

Referenced by InstrumentLibraryEditor(), createWidgetsForCurrentInstrument(), execAdd(), execChoose(), onCurrentChangedForChoose(), onInstrumentChangedByEditor(), onInstrumentDescriptionEdited(), and onInstrumentNameEdited().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Instrument/InstrumentLibraryEditor.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Instrument/InstrumentLibraryEditor.cpp