Description

Instrument selector on the left side of InstrumentView.

Definition at line 29 of file InstrumentListView.h.

Inheritance diagram for InstrumentListView:

Collaboration diagram for InstrumentListView:

Signals
void	instrumentSelected (InstrumentItem *instrument)

Public Member Functions
	InstrumentListView (ProjectDocument document, QWidget parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())

InstrumentItem *	currentInstrument () const

QSize	minimumSizeHint () const override

QSize	sizeHint () const override

QList< QAction * >	toolbarActions () const

Private Slots
void	onCopy ()
	Makes a copy of the currently selected instrument. More...

void	onItemSelectionChanged ()

void	onLoadFromLibrary ()

void	onNewDepthProbe ()

void	onNewGisas ()

void	onNewOffspec ()

void	onNewSpecular ()

void	onRemove ()
	Removes currently selected instrument. More...

void	onStoreInLibrary ()

Private Member Functions
void	ensureItemSelected ()

void	updateActions ()

void	updateFunctionalityNarrowing ()
	Show/hide UI elements according to settings in current project. More...

Private Attributes
QAction *	m_copyAction

ProjectDocument *	m_document

QListView *	m_listView

QAction *	m_loadFromLibraryAction

InstrumentListModel *	m_model

QAction *	m_newDepthProbeAction

QAction *	m_newGisasAction

QAction *	m_newOffspecAction

QAction *	m_newSpecularAction

QAction *	m_removeAction

QAction *	m_separatorAction1

QAction *	m_separatorAction2

QAction *	m_storeInLibraryAction

Constructor & Destructor Documentation

◆ InstrumentListView()

InstrumentListView::InstrumentListView	(	ProjectDocument *	document,
		QWidget *	parent = `nullptr`,
		Qt::WindowFlags	f = `Qt::WindowFlags()`
	)

Definition at line 27 of file InstrumentListView.cpp.

     : QWidget(parent, f)
     , m_document(document)
 {
     setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Expanding);
  
     auto* layout = new QVBoxLayout(this);
     layout->setMargin(10);
  
     m_listView = new QListView(this);
     m_listView->setViewMode(QListView::IconMode);
     m_listView->setIconSize(QSize(96, 84));
     m_listView->setMovement(QListView::Static);
     m_listView->setMaximumWidth(200);
     m_listView->setSpacing(12);
     m_listView->setSelectionMode(QAbstractItemView::SingleSelection);
  
     m_listView->setObjectName("listView");
     m_listView->setStyleSheet(
         QString::fromUtf8("QListView#listView\n"
                           "{\n"
                           "   selection-background-color : rgb(98,100,105); \n"
                           "   selection-color: rgb(255,255,255);\n"
                           "   border: 1px solid rgb(98,100,105);\n"
                           "}\n"));
     layout->addWidget(m_listView);
  
     m_model = new InstrumentListModel(this, m_document->instrumentsEditController());
     m_listView->setModel(m_model);
  
     m_newGisasAction = new QAction("New GISAS", this);
     m_newGisasAction->setIcon(QIcon(":/images/shape-square-plus.svg"));
     m_newGisasAction->setToolTip("Add new GISAS instrument with default settings");
     connect(m_newGisasAction, &QAction::triggered, this, &InstrumentListView::onNewGisas);
     addAction(m_newGisasAction);
  
     m_newOffspecAction = new QAction("New off-specular", this);
     m_newOffspecAction->setIcon(QIcon(":/images/shape-square-plus.svg"));
     m_newOffspecAction->setToolTip("Add new off-specular instrument with default settings");
     connect(m_newOffspecAction, &QAction::triggered, this, &InstrumentListView::onNewOffspec);
     addAction(m_newOffspecAction);
  
     m_newSpecularAction = new QAction("New specular", this);
     m_newSpecularAction->setIcon(QIcon(":/images/shape-square-plus.svg"));
     m_newSpecularAction->setToolTip("Add new specular instrument with default settings");
     connect(m_newSpecularAction, &QAction::triggered, this, &InstrumentListView::onNewSpecular);
     addAction(m_newSpecularAction);
  
     m_newDepthProbeAction = new QAction("New depth probe", this);
     m_newDepthProbeAction->setIcon(QIcon(":/images/shape-square-plus.svg"));
     m_newDepthProbeAction->setToolTip("Add new depth probe instrument with default settings");
     connect(m_newDepthProbeAction, &QAction::triggered, this, &InstrumentListView::onNewDepthProbe);
     addAction(m_newDepthProbeAction);
  
     m_separatorAction1 = new QAction(this);
     m_separatorAction1->setSeparator(true);
     addAction(m_separatorAction1);
  
     m_removeAction = new QAction("Remove", this);
     m_removeAction->setIcon(QIcon(":/images/delete.svg"));
     m_removeAction->setToolTip("Remove selected instrument");
     connect(m_removeAction, &QAction::triggered, this, &InstrumentListView::onRemove);
     addAction(m_removeAction);
  
     m_copyAction = new QAction("Copy", this);
     m_copyAction->setIcon(QIcon(":/images/content-copy.svg"));
     m_copyAction->setToolTip("Make a copy of the selected instrument");
     connect(m_copyAction, &QAction::triggered, this, &InstrumentListView::onCopy);
     addAction(m_copyAction);
  
     m_separatorAction2 = new QAction(this);
     m_separatorAction2->setSeparator(true);
     addAction(m_separatorAction2);
  
     m_storeInLibraryAction = new QAction("Store in library", this);
     m_storeInLibraryAction->setIcon(QIcon(":/images/library.svg"));
     m_storeInLibraryAction->setToolTip("Store instrument in library");
     connect(m_storeInLibraryAction, &QAction::triggered, this,
             &InstrumentListView::onStoreInLibrary);
     addAction(m_storeInLibraryAction);
  
     m_loadFromLibraryAction = new QAction("Choose from library", this);
     m_loadFromLibraryAction->setIcon(QIcon(":/images/library.svg"));
     m_loadFromLibraryAction->setToolTip("Load an instrument from the instrument library");
     connect(m_loadFromLibraryAction, &QAction::triggered, this,
             &InstrumentListView::onLoadFromLibrary);
     addAction(m_loadFromLibraryAction);
  
     setContextMenuPolicy(Qt::ActionsContextMenu);
  
     connect(m_listView->selectionModel(), &QItemSelectionModel::selectionChanged, this,
             &InstrumentListView::onItemSelectionChanged);
  
     connect(m_document, &ProjectDocument::modified, this,
             &InstrumentListView::updateFunctionalityNarrowing);
  
     updateFunctionalityNarrowing();
  
     updateActions();
     ensureItemSelected();
 }

References ensureItemSelected(), ProjectDocument::instrumentsEditController(), m_copyAction, m_document, m_listView, m_loadFromLibraryAction, m_model, m_newDepthProbeAction, m_newGisasAction, m_newOffspecAction, m_newSpecularAction, m_removeAction, m_separatorAction1, m_separatorAction2, m_storeInLibraryAction, ProjectDocument::modified(), onCopy(), onItemSelectionChanged(), onLoadFromLibrary(), onNewDepthProbe(), onNewGisas(), onNewOffspec(), onNewSpecular(), onRemove(), onStoreInLibrary(), updateActions(), and updateFunctionalityNarrowing().

Here is the call graph for this function:

Member Function Documentation

◆ currentInstrument()

InstrumentItem * InstrumentListView::currentInstrument ( ) const

Definition at line 148 of file InstrumentListView.cpp.

 {
     const QModelIndexList indexes = m_listView->selectionModel()->selectedIndexes();
     if (!indexes.empty())
         return m_model->instrumentForIndex(indexes.front());
     return nullptr;
 }

References InstrumentListModel::instrumentForIndex(), m_listView, and m_model.

Referenced by InstrumentView::createWidgetsForCurrentInstrument(), InstrumentView::onInstrumentChangedByEditor(), InstrumentView::onInstrumentChangedFromExternal(), InstrumentView::onInstrumentdescriptionEdited(), and InstrumentView::onInstrumentNameEdited().

Here is the call graph for this function:

◆ ensureItemSelected()

void InstrumentListView::ensureItemSelected ( )

private

Definition at line 269 of file InstrumentListView.cpp.

 {
     if (!m_listView->selectionModel()->hasSelection() && m_model->rowCount()) {
         QModelIndex last = m_model->index(m_model->rowCount() - 1, 0, QModelIndex());
         m_listView->selectionModel()->select(last, QItemSelectionModel::ClearAndSelect);
     }
 }

References m_listView, m_model, and InstrumentListModel::rowCount().

Referenced by InstrumentListView(), and onRemove().

Here is the call graph for this function:

◆ instrumentSelected

void InstrumentListView::instrumentSelected ( InstrumentItem * instrument )

signal

Referenced by InstrumentView::InstrumentView(), and onItemSelectionChanged().

◆ minimumSizeHint()

QSize InstrumentListView::minimumSizeHint ( ) const

override

Definition at line 135 of file InstrumentListView.cpp.

 {
     return QSize(96, 200);
 }

◆ onCopy

void InstrumentListView::onCopy ( )

privateslot

Makes a copy of the currently selected instrument.

Definition at line 203 of file InstrumentListView.cpp.

 {
     QModelIndexList indexes = m_listView->selectionModel()->selectedIndexes();
     if (!indexes.empty()) {
         QModelIndex idx = m_model->copyInstrument(indexes.front());
         m_listView->selectionModel()->select(idx, QItemSelectionModel::ClearAndSelect);
     }
 }

References InstrumentListModel::copyInstrument(), m_listView, and m_model.

Referenced by InstrumentListView().

Here is the call graph for this function:

◆ onItemSelectionChanged

void InstrumentListView::onItemSelectionChanged ( )

privateslot

Definition at line 156 of file InstrumentListView.cpp.

 {
     updateActions();
  
     QModelIndexList indexes = m_listView->selectionModel()->selectedIndexes();
     if (!indexes.empty())
         emit instrumentSelected(m_model->instrumentForIndex(indexes.front()));
     else
         emit instrumentSelected(nullptr);
 }

References InstrumentListModel::instrumentForIndex(), instrumentSelected(), m_listView, m_model, and updateActions().

Referenced by InstrumentListView().

Here is the call graph for this function:

◆ onLoadFromLibrary

void InstrumentListView::onLoadFromLibrary ( )

privateslot

Definition at line 228 of file InstrumentListView.cpp.

 {
     if (gSessionData->instrumentLibrary.isEmpty()) {
         QMessageBox::information(GUI::Global::mainWindow, "Select from library",
                                  "The library does not contain instruments so far.");
         return;
     }
  
     InstrumentLibraryEditor dlg(GUI::Global::mainWindow);
     dlg.setGisasEnabled(m_document->functionalities().testFlag(ProjectDocument::Gisas));
     dlg.setOffspecEnabled(m_document->functionalities().testFlag(ProjectDocument::Offspec));
     dlg.setSpecularEnabled(m_document->functionalities().testFlag(ProjectDocument::Specular));
     dlg.setDepthProbeEnabled(m_document->functionalities().testFlag(ProjectDocument::DepthProbe));
  
     auto* instrumentToCopy = dlg.execChoose();
     if (instrumentToCopy == nullptr)
         return;
  
     QModelIndex idx = m_model->copyInstrument(instrumentToCopy);
     m_listView->selectionModel()->select(idx, QItemSelectionModel::ClearAndSelect);
 }

References InstrumentListModel::copyInstrument(), ProjectDocument::DepthProbe, InstrumentLibraryEditor::execChoose(), ProjectDocument::functionalities(), ProjectDocument::Gisas, gSessionData, GUI::View::Helpers::information(), SessionData::instrumentLibrary, InstrumentLibrary::isEmpty(), m_document, m_listView, m_model, GUI::Global::mainWindow, ProjectDocument::Offspec, InstrumentLibraryEditor::setDepthProbeEnabled(), InstrumentLibraryEditor::setGisasEnabled(), InstrumentLibraryEditor::setOffspecEnabled(), InstrumentLibraryEditor::setSpecularEnabled(), and ProjectDocument::Specular.

Referenced by InstrumentListView().

Here is the call graph for this function:

◆ onNewDepthProbe

void InstrumentListView::onNewDepthProbe ( )

privateslot

Definition at line 185 of file InstrumentListView.cpp.

 {
     QModelIndex idx = m_model->addNewDepthProbeInstrument();
     m_listView->selectionModel()->select(idx, QItemSelectionModel::ClearAndSelect);
 }

References InstrumentListModel::addNewDepthProbeInstrument(), m_listView, and m_model.

Referenced by InstrumentListView().

Here is the call graph for this function:

◆ onNewGisas

void InstrumentListView::onNewGisas ( )

privateslot

Definition at line 167 of file InstrumentListView.cpp.

 {
     QModelIndex idx = m_model->addNewGISASInstrument();
     m_listView->selectionModel()->select(idx, QItemSelectionModel::ClearAndSelect);
 }

References InstrumentListModel::addNewGISASInstrument(), m_listView, and m_model.

Referenced by InstrumentListView().

Here is the call graph for this function:

◆ onNewOffspec

void InstrumentListView::onNewOffspec ( )

privateslot

Definition at line 173 of file InstrumentListView.cpp.

 {
     QModelIndex idx = m_model->addNewOffspecInstrument();
     m_listView->selectionModel()->select(idx, QItemSelectionModel::ClearAndSelect);
 }

References InstrumentListModel::addNewOffspecInstrument(), m_listView, and m_model.

Referenced by InstrumentListView().

Here is the call graph for this function:

◆ onNewSpecular

void InstrumentListView::onNewSpecular ( )

privateslot

Definition at line 179 of file InstrumentListView.cpp.

 {
     QModelIndex idx = m_model->addNewSpecularInstrument();
     m_listView->selectionModel()->select(idx, QItemSelectionModel::ClearAndSelect);
 }

References InstrumentListModel::addNewSpecularInstrument(), m_listView, and m_model.

Referenced by InstrumentListView().

Here is the call graph for this function:

◆ onRemove

void InstrumentListView::onRemove ( )

privateslot

Removes currently selected instrument.

Definition at line 192 of file InstrumentListView.cpp.

 {
     QModelIndexList indexes = m_listView->selectionModel()->selectedIndexes();
     if (!indexes.empty()) {
         m_model->removeInstrument(indexes.front());
  
         ensureItemSelected();
     }
 }

References ensureItemSelected(), m_listView, m_model, and InstrumentListModel::removeInstrument().

Referenced by InstrumentListView().

Here is the call graph for this function:

◆ onStoreInLibrary

void InstrumentListView::onStoreInLibrary ( )

privateslot

Definition at line 212 of file InstrumentListView.cpp.

 {
     if (!m_listView->selectionModel()->hasSelection())
         return;
  
     QModelIndex idx = m_listView->selectionModel()->selectedIndexes().front();
     InstrumentItem* instrument = m_model->instrumentForIndex(idx);
  
     InstrumentLibraryEditor dlg(GUI::Global::mainWindow);
     dlg.setGisasEnabled(m_document->functionalities().testFlag(ProjectDocument::Gisas));
     dlg.setOffspecEnabled(m_document->functionalities().testFlag(ProjectDocument::Offspec));
     dlg.setSpecularEnabled(m_document->functionalities().testFlag(ProjectDocument::Specular));
     dlg.setDepthProbeEnabled(m_document->functionalities().testFlag(ProjectDocument::DepthProbe));
     dlg.execAdd(*instrument);
 }

References ProjectDocument::DepthProbe, InstrumentLibraryEditor::execAdd(), ProjectDocument::functionalities(), ProjectDocument::Gisas, InstrumentListModel::instrumentForIndex(), m_document, m_listView, m_model, GUI::Global::mainWindow, ProjectDocument::Offspec, InstrumentLibraryEditor::setDepthProbeEnabled(), InstrumentLibraryEditor::setGisasEnabled(), InstrumentLibraryEditor::setOffspecEnabled(), InstrumentLibraryEditor::setSpecularEnabled(), and ProjectDocument::Specular.

Referenced by InstrumentListView().

Here is the call graph for this function:

◆ sizeHint()

QSize InstrumentListView::sizeHint ( ) const

override

Definition at line 130 of file InstrumentListView.cpp.

 {
     return QSize(170, 400);
 }

◆ toolbarActions()

QList< QAction * > InstrumentListView::toolbarActions ( ) const

Definition at line 140 of file InstrumentListView.cpp.

 {
     return {m_newGisasAction,       m_newOffspecAction, m_newSpecularAction,
             m_newDepthProbeAction,  m_separatorAction1, m_removeAction,
             m_copyAction,           m_separatorAction2, m_storeInLibraryAction,
             m_loadFromLibraryAction};
 }

References m_copyAction, m_loadFromLibraryAction, m_newDepthProbeAction, m_newGisasAction, m_newOffspecAction, m_newSpecularAction, m_removeAction, m_separatorAction1, m_separatorAction2, and m_storeInLibraryAction.

Referenced by InstrumentView::InstrumentView().

◆ updateActions()

void InstrumentListView::updateActions ( )

private

Definition at line 261 of file InstrumentListView.cpp.

 {
     bool enabled = m_listView->selectionModel()->hasSelection();
     m_removeAction->setEnabled(enabled);
     m_copyAction->setEnabled(enabled);
     m_storeInLibraryAction->setEnabled(enabled);
 }

References m_copyAction, m_listView, m_removeAction, and m_storeInLibraryAction.

Referenced by InstrumentListView(), and onItemSelectionChanged().

◆ updateFunctionalityNarrowing()

void InstrumentListView::updateFunctionalityNarrowing ( )

private

Show/hide UI elements according to settings in current project.

Definition at line 250 of file InstrumentListView.cpp.

 {
     const auto f = m_document->functionalities();
  
     m_newGisasAction->setVisible(f.testFlag(ProjectDocument::Gisas));
     m_newOffspecAction->setVisible(f.testFlag(ProjectDocument::Offspec));
     m_newSpecularAction->setVisible(f.testFlag(ProjectDocument::Specular));
     m_newDepthProbeAction->setVisible(f.testFlag(ProjectDocument::DepthProbe));
     m_copyAction->setVisible(!m_document->singleInstrumentMode());
 }

References ProjectDocument::DepthProbe, ProjectDocument::functionalities(), ProjectDocument::Gisas, m_copyAction, m_document, m_newDepthProbeAction, m_newGisasAction, m_newOffspecAction, m_newSpecularAction, ProjectDocument::Offspec, ProjectDocument::singleInstrumentMode(), and ProjectDocument::Specular.

Referenced by InstrumentListView().

Here is the call graph for this function:

Member Data Documentation

◆ m_copyAction

QAction* InstrumentListView::m_copyAction

private

Definition at line 76 of file InstrumentListView.h.

Referenced by InstrumentListView(), toolbarActions(), updateActions(), and updateFunctionalityNarrowing().

◆ m_document

ProjectDocument* InstrumentListView::m_document

private

Definition at line 67 of file InstrumentListView.h.

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

◆ m_listView

QListView* InstrumentListView::m_listView

private

Definition at line 68 of file InstrumentListView.h.

Referenced by InstrumentListView(), currentInstrument(), ensureItemSelected(), onCopy(), onItemSelectionChanged(), onLoadFromLibrary(), onNewDepthProbe(), onNewGisas(), onNewOffspec(), onNewSpecular(), onRemove(), onStoreInLibrary(), and updateActions().

◆ m_loadFromLibraryAction

QAction* InstrumentListView::m_loadFromLibraryAction

private

Definition at line 79 of file InstrumentListView.h.

Referenced by InstrumentListView(), and toolbarActions().

◆ m_model

InstrumentListModel* InstrumentListView::m_model

private

Definition at line 69 of file InstrumentListView.h.

Referenced by InstrumentListView(), currentInstrument(), ensureItemSelected(), onCopy(), onItemSelectionChanged(), onLoadFromLibrary(), onNewDepthProbe(), onNewGisas(), onNewOffspec(), onNewSpecular(), onRemove(), and onStoreInLibrary().

◆ m_newDepthProbeAction

QAction* InstrumentListView::m_newDepthProbeAction

private

Definition at line 73 of file InstrumentListView.h.

Referenced by InstrumentListView(), toolbarActions(), and updateFunctionalityNarrowing().

◆ m_newGisasAction

QAction* InstrumentListView::m_newGisasAction

private

Definition at line 70 of file InstrumentListView.h.

Referenced by InstrumentListView(), toolbarActions(), and updateFunctionalityNarrowing().

◆ m_newOffspecAction

QAction* InstrumentListView::m_newOffspecAction

private

Definition at line 71 of file InstrumentListView.h.

Referenced by InstrumentListView(), toolbarActions(), and updateFunctionalityNarrowing().

◆ m_newSpecularAction

QAction* InstrumentListView::m_newSpecularAction

private

Definition at line 72 of file InstrumentListView.h.

Referenced by InstrumentListView(), toolbarActions(), and updateFunctionalityNarrowing().

◆ m_removeAction

QAction* InstrumentListView::m_removeAction

private

Definition at line 75 of file InstrumentListView.h.

Referenced by InstrumentListView(), toolbarActions(), and updateActions().

◆ m_separatorAction1

QAction* InstrumentListView::m_separatorAction1

private

Definition at line 74 of file InstrumentListView.h.

Referenced by InstrumentListView(), and toolbarActions().

◆ m_separatorAction2

QAction* InstrumentListView::m_separatorAction2

private

Definition at line 77 of file InstrumentListView.h.

Referenced by InstrumentListView(), and toolbarActions().

◆ m_storeInLibraryAction

QAction* InstrumentListView::m_storeInLibraryAction

private

Definition at line 78 of file InstrumentListView.h.

Referenced by InstrumentListView(), toolbarActions(), and updateActions().

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

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

Description

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ InstrumentListView()

Member Function Documentation

◆ currentInstrument()

◆ ensureItemSelected()

◆ instrumentSelected

◆ minimumSizeHint()

◆ onCopy

◆ onItemSelectionChanged

◆ onLoadFromLibrary

◆ onNewDepthProbe

◆ onNewGisas

◆ onNewOffspec

◆ onNewSpecular

◆ onRemove

◆ onStoreInLibrary

◆ sizeHint()

◆ toolbarActions()

◆ updateActions()

◆ updateFunctionalityNarrowing()

Member Data Documentation

◆ m_copyAction

◆ m_document

◆ m_listView

◆ m_loadFromLibraryAction

◆ m_model

◆ m_newDepthProbeAction

◆ m_newGisasAction

◆ m_newOffspecAction

◆ m_newSpecularAction

◆ m_removeAction

◆ m_separatorAction1

◆ m_separatorAction2

◆ m_storeInLibraryAction