RealDataSelectorWidget Class Reference

Description

The RealDataSelectorWidget represents left panel of ImportDataView. Contains a tree to select data set (m_itemTree & m_itemTreeModel) and properties of currently selected data (RealDataPropertiesWidget).

Definition at line 38 of file RealDataSelectorWidget.h.

Inheritance diagram for RealDataSelectorWidget:

Collaboration diagram for RealDataSelectorWidget:

Signals
void	selectionChanged (RealDataItem *)

Public Member Functions
	RealDataSelectorWidget (QWidget *parent, ProjectDocument *document)
RealDataItem *	currentItem ()
QSize	minimumSizeHint () const override
void	setCurrentItem (RealDataItem *item)
QSize	sizeHint () const override

Public Attributes
QAction *	m_import1dDataAction
QAction *	m_import2dDataAction
QAction *	m_removeDataAction
QAction *	m_renameDataAction

Private Member Functions
QModelIndex	currentIndex ()
QList< QAction * >	getOverlayActions (const QModelIndex &index, bool asHover)
void	importData1D ()
void	importData2D ()
void	onContextMenuRequest (const QPoint &point)
void	onSelectionChanged ()
void	removeCurrentItem ()
void	renameCurrentItem ()
void	updateActionEnabling ()
void	updateActionEnabling (const RealDataItem *item) const
void	updateFunctionalities ()

Private Attributes
ProjectDocument *	m_document
QTreeView *	m_itemTree
RealDataTreeModel *	m_itemTreeModel
RealDataPropertiesWidget *	m_propertiesWidget

Constructor & Destructor Documentation

RealDataSelectorWidget()

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

Definition at line 40 of file RealDataSelectorWidget.cpp.

    : QWidget(parent)
    , m_itemTree(new QTreeView(this))
    , m_itemTreeModel(new RealDataTreeModel(this, document->realDataModel()))
    , m_propertiesWidget(new RealDataPropertiesWidget(this, document))
    , m_document(document)
    , m_import1dDataAction(new QAction(this))
    , m_import2dDataAction(new QAction(this))
    , m_renameDataAction(new QAction(this))
    , m_removeDataAction(new QAction(this))
{
    setProperty("stylable", true);
    setAttribute(Qt::WA_StyledBackground, true);
 
    setMinimumSize(250, 600);
    setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Expanding);
    setWindowTitle("RealDataSelectorWidget");
 
    m_import2dDataAction->setText("Import 2D data");
    m_import2dDataAction->setIcon(QIcon(":/images/shape-square-plus.svg"));
    m_import2dDataAction->setIconText("2D");
    m_import2dDataAction->setToolTip("Import 2D data");
    connect(m_import2dDataAction, &QAction::triggered, [this]() { importData2D(); });
 
    m_import1dDataAction->setText("Import 1D data");
    m_import1dDataAction->setIcon(QIcon(":/images/shape-square-plus.svg"));
    m_import1dDataAction->setIconText("1D");
    m_import1dDataAction->setToolTip("Import 1D data");
    connect(m_import1dDataAction, &QAction::triggered, [this]() { importData1D(); });
 
    m_renameDataAction->setText("Rename");
    m_renameDataAction->setIcon(QIcon()); // #baTODO: Icon needed?
    m_renameDataAction->setIconText("Rename");
    m_renameDataAction->setToolTip("Rename data");
    connect(m_renameDataAction, &QAction::triggered, this,
            &RealDataSelectorWidget::renameCurrentItem);
 
    m_removeDataAction->setText("Remove");
    m_removeDataAction->setIcon(QIcon(":/images/delete.svg"));
    m_removeDataAction->setIconText("Remove");
    m_removeDataAction->setToolTip("Remove selected data");
    connect(m_removeDataAction, &QAction::triggered, this,
            &RealDataSelectorWidget::removeCurrentItem);
 
    // #baimport ++ following line necessary for tree as well? relevant for RealItems at all?
    // m_itemTree->setAttribute(Qt::WA_MacShowFocusRect, false);
    m_itemTree->setItemsExpandable(false);
    m_itemTree->setRootIsDecorated(false);
    m_itemTree->setHeaderHidden(true);
    m_itemTree->setContextMenuPolicy(Qt::CustomContextMenu);
    m_itemTree->setModel(m_itemTreeModel);
 
    auto* splitter = new QSplitter;
    splitter->setOrientation(Qt::Vertical);
    splitter->addWidget(m_itemTree);
    splitter->addWidget(m_propertiesWidget);
    splitter->setChildrenCollapsible(true);
 
    auto* mainLayout = new QVBoxLayout;
    mainLayout->setMargin(0);
    mainLayout->setSpacing(0);
    mainLayout->setContentsMargins(0, 0, 0, 0);
    mainLayout->addWidget(splitter);
 
    setLayout(mainLayout);
 
    connect(m_itemTree, &QTreeView::customContextMenuRequested, this,
            &RealDataSelectorWidget::onContextMenuRequest);
 
    connect(m_document, &ProjectDocument::modified, this,
            &RealDataSelectorWidget::updateFunctionalities);
 
    connect(m_itemTreeModel, &QAbstractItemModel::modelReset,
            [this]() { m_itemTree->expandAll(); });
 
    connect(m_itemTreeModel, &QAbstractItemModel::rowsInserted,
            [this]() { m_itemTree->expandAll(); });
 
    connect(m_itemTree->selectionModel(), &QItemSelectionModel::selectionChanged, this,
            &RealDataSelectorWidget::onSelectionChanged, Qt::UniqueConnection);
 
    m_itemTree->expandAll();
    updateActionEnabling();
    updateFunctionalities();
 
    // ensure a current item when widget is shown
    setCurrentItem(m_itemTreeModel->topMostItem());
    if (currentItem())
        emit selectionChanged(currentItem());
 
    ItemViewOverlayButtons::install(
        m_itemTree, [=](const QModelIndex& i, bool h) { return getOverlayActions(i, h); });
}

References currentItem(), getOverlayActions(), importData1D(), importData2D(), ItemViewOverlayButtons::install(), m_document, m_import1dDataAction, m_import2dDataAction, m_itemTree, m_itemTreeModel, m_propertiesWidget, m_removeDataAction, m_renameDataAction, ProjectDocument::modified(), onContextMenuRequest(), onSelectionChanged(), removeCurrentItem(), renameCurrentItem(), selectionChanged(), setCurrentItem(), RealDataTreeModel::topMostItem(), updateActionEnabling(), and updateFunctionalities().

Here is the call graph for this function:

Member Function Documentation

currentIndex()

QModelIndex RealDataSelectorWidget::currentIndex ( )

private

Definition at line 157 of file RealDataSelectorWidget.cpp.

{
    return m_itemTree->selectionModel()->currentIndex();
}

References m_itemTree.

Referenced by currentItem(), and renameCurrentItem().

currentItem()

RealDataItem * RealDataSelectorWidget::currentItem

(

)

Definition at line 144 of file RealDataSelectorWidget.cpp.

{
    return m_itemTreeModel->itemForIndex(currentIndex());
}

References currentIndex(), RealDataTreeModel::itemForIndex(), and m_itemTreeModel.

Referenced by ImportDataView::ImportDataView(), RealDataSelectorWidget(), onSelectionChanged(), removeCurrentItem(), and updateActionEnabling().

Here is the call graph for this function:

getOverlayActions()

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

private

Definition at line 162 of file RealDataSelectorWidget.cpp.

{
    if (m_itemTreeModel->isHeadline(index)) {
        if (asHover)
            return {};
 
        return (index == m_itemTreeModel->indexOfHeadline(1))
                   ? QList<QAction*>({m_import1dDataAction})
                   : QList<QAction*>({m_import2dDataAction});
    }
 
    // -- index belongs to item
    if (!asHover)
        return {};
 
    auto* item = m_itemTreeModel->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 data");
    connect(removeAction, &QAction::triggered, [=]() { m_itemTreeModel->removeItem(item); });
 
    return {removeAction};
}

References RealDataTreeModel::indexOfHeadline(), RealDataTreeModel::isHeadline(), RealDataTreeModel::itemForIndex(), m_import1dDataAction, m_import2dDataAction, m_itemTreeModel, and RealDataTreeModel::removeItem().

Referenced by RealDataSelectorWidget().

Here is the call graph for this function:

importData1D()

void RealDataSelectorWidget::importData1D ( )

private

Definition at line 217 of file RealDataSelectorWidget.cpp.

{
    QMap<QString, AbstractDataLoader1D*> loaderOfFilter;
    QString filters;
    for (auto* loader : DataLoaders1D::instance().loaders()) {
        const QString filter =
            loader->name() + " (*.txt *.csv *.dat)"; // #baimport - take file filters from loader
        loaderOfFilter[filter] = loader;
 
        if (!filters.isEmpty())
            filters += ";;";
        filters += filter;
    }
    filters += ";;Other (*.*)";
 
    QString selectedFilter = ProjectManager::instance()->recentlyUsedImportFilter1D();
    const QString dirname = ProjectManager::instance()->userImportDir();
 
    const QStringList fileNames = QFileDialog::getOpenFileNames(
        Q_NULLPTR, "Open Intensity Files", dirname, filters, &selectedFilter,
        appSettings->useNativeFileDialog() ? QFileDialog::Options()
                                           : QFileDialog::DontUseNativeDialog);
 
    if (fileNames.isEmpty())
        return;
 
    ProjectManager::instance()->setImportDirFromFilePath(fileNames[0]);
    ProjectManager::instance()->setRecentlyUsedImportFilter1D(selectedFilter);
 
    const AbstractDataLoader* selectedLoader = loaderOfFilter.value(selectedFilter, nullptr);
    for (const auto& fileName : fileNames) {
        RealDataItem* realDataItem = m_itemTreeModel->insertSpecularDataItem();
        realDataItem->setDataName(QFileInfo(fileName).baseName());
        realDataItem->setNativeFileName(fileName);
 
        const QString errorText =
            GUI::View::ImportDataUtils::Import1dData(realDataItem, selectedLoader);
        if (errorText.isEmpty())
            setCurrentItem(realDataItem);
        else {
            m_itemTreeModel->removeItem(realDataItem);
            GUI::View::Helpers::warning(this, "File import",
                                        QString("The file '%1' could not be imported.")
                                            .arg(QDir::toNativeSeparators(fileName)),
                                        errorText);
        }
    }
}

References appSettings, GUI::Util::Path::baseName(), GUI::View::ImportDataUtils::Import1dData(), RealDataTreeModel::insertSpecularDataItem(), DataLoaders1D::instance(), ProjectManager::instance(), m_itemTreeModel, ProjectManager::recentlyUsedImportFilter1D(), RealDataTreeModel::removeItem(), setCurrentItem(), RealDataItem::setDataName(), ProjectManager::setImportDirFromFilePath(), RealDataItem::setNativeFileName(), ProjectManager::setRecentlyUsedImportFilter1D(), ApplicationSettings::useNativeFileDialog(), ProjectManager::userImportDir(), and GUI::View::Helpers::warning().

Referenced by RealDataSelectorWidget().

Here is the call graph for this function:

importData2D()

void RealDataSelectorWidget::importData2D ( )

private

Definition at line 266 of file RealDataSelectorWidget.cpp.

{
    QMap<QString, IOFactory::LoaderSelector> loaderOfFilter;
    QString filters;
 
    const auto addFilter = [&](IOFactory::LoaderSelector loaderSelector, const QString& filter) {
        if (!filters.isEmpty())
            filters += ";;";
        filters += filter;
        loaderOfFilter[filter] = loaderSelector;
    };
    addFilter(IOFactory::tiff, "TIFF (*.tif *.tiff *.tif.gz)");
    addFilter(IOFactory::nicos, "Nicos/SANSDRaw (*.001)");
    addFilter(IOFactory::bornagain, "BornAgain (*.int.gz)");
    addFilter(IOFactory::automatic, "CSV (*.txt *.csv *.dat)");
    addFilter(IOFactory::automatic, "All (*.*)");
 
    QString selectedFilter = ProjectManager::instance()->recentlyUsedImportFilter2D();
 
    const QString dirname = ProjectManager::instance()->userImportDir();
    const QStringList fileNames = QFileDialog::getOpenFileNames(
        Q_NULLPTR, "Open Intensity Files", dirname, filters, &selectedFilter,
        appSettings->useNativeFileDialog() ? QFileDialog::Options()
                                           : QFileDialog::DontUseNativeDialog);
    if (fileNames.isEmpty())
        return;
 
    ProjectManager::instance()->setImportDirFromFilePath(fileNames[0]);
    ProjectManager::instance()->setRecentlyUsedImportFilter2D(selectedFilter);
 
    const auto selectedLoader = loaderOfFilter.value(selectedFilter, IOFactory::automatic);
 
    for (const auto& fileName : fileNames) {
        std::unique_ptr<Datafield> data =
            GUI::View::ImportDataUtils::Import2dData(fileName, selectedLoader);
        if (!data)
            continue;
        RealDataItem* realDataItem = m_itemTreeModel->insertIntensityDataItem();
        realDataItem->setDataName(QFileInfo(fileName).baseName());
 
        try {
            if (data->rank() != 2)
                throw Error("The content could not be interpreted correctly as 2-dimensional.");
 
            realDataItem->setDatafield(data.release());
            setCurrentItem(realDataItem);
        } catch (std::exception& ex) {
            m_itemTreeModel->removeItem(realDataItem);
 
            const QString message = QString("Error while trying to read file\n\n'%1'\n\n%2")
                                        .arg(fileName)
                                        .arg(QString::fromStdString(std::string(ex.what())));
            GUI::View::Helpers::warning(this, "File import", message);
        }
    }
}

References appSettings, GUI::Util::Path::baseName(), Error, GUI::View::ImportDataUtils::Import2dData(), RealDataTreeModel::insertIntensityDataItem(), ProjectManager::instance(), m_itemTreeModel, ProjectManager::recentlyUsedImportFilter2D(), RealDataTreeModel::removeItem(), setCurrentItem(), RealDataItem::setDatafield(), RealDataItem::setDataName(), ProjectManager::setImportDirFromFilePath(), ProjectManager::setRecentlyUsedImportFilter2D(), ApplicationSettings::useNativeFileDialog(), ProjectManager::userImportDir(), and GUI::View::Helpers::warning().

Referenced by RealDataSelectorWidget().

Here is the call graph for this function:

minimumSizeHint()

QSize RealDataSelectorWidget::minimumSizeHint ( ) const

override

Definition at line 139 of file RealDataSelectorWidget.cpp.

{
    return QSize(128, 200);
}

onContextMenuRequest()

void RealDataSelectorWidget::onContextMenuRequest ( const QPoint &  point )

private

Definition at line 198 of file RealDataSelectorWidget.cpp.

{
    auto* realDataItemAtPoint = m_itemTreeModel->itemForIndex(m_itemTree->indexAt(point));
    updateActionEnabling(realDataItemAtPoint);
 
    QMenu menu;
    menu.setToolTipsVisible(true);
 
    if (realDataItemAtPoint != nullptr) {
        menu.addAction(m_renameDataAction);
        menu.addAction(m_removeDataAction);
        menu.addSeparator();
    }
 
    menu.addAction(m_import2dDataAction);
    menu.addAction(m_import1dDataAction);
    menu.exec(m_itemTree->mapToGlobal(point));
}

References RealDataTreeModel::itemForIndex(), m_import1dDataAction, m_import2dDataAction, m_itemTree, m_itemTreeModel, m_removeDataAction, m_renameDataAction, and updateActionEnabling().

Referenced by RealDataSelectorWidget().

Here is the call graph for this function:

onSelectionChanged()

void RealDataSelectorWidget::onSelectionChanged ( )

private

Definition at line 191 of file RealDataSelectorWidget.cpp.

{
    updateActionEnabling();
    m_propertiesWidget->setItem(currentItem());
    emit selectionChanged(currentItem());
}

References currentItem(), m_propertiesWidget, selectionChanged(), RealDataPropertiesWidget::setItem(), and updateActionEnabling().

Referenced by RealDataSelectorWidget().

Here is the call graph for this function:

removeCurrentItem()

void RealDataSelectorWidget::removeCurrentItem ( )

private

Definition at line 334 of file RealDataSelectorWidget.cpp.

{
    m_itemTreeModel->removeItem(currentItem());
}

References currentItem(), m_itemTreeModel, and RealDataTreeModel::removeItem().

Referenced by RealDataSelectorWidget().

Here is the call graph for this function:

renameCurrentItem()

void RealDataSelectorWidget::renameCurrentItem ( )

private

Definition at line 323 of file RealDataSelectorWidget.cpp.

{
    if (currentIndex().isValid()) {
        // First delete any existing index widget. This is necessary if overlay buttons are used,
        // because these buttons use the indexWidget() functionality, which itself uses the same
        // internals as an item editor
        m_itemTree->setIndexWidget(currentIndex(), nullptr);
        m_itemTree->edit(currentIndex());
    }
}

References currentIndex(), and m_itemTree.

Referenced by RealDataSelectorWidget().

Here is the call graph for this function:

selectionChanged

void RealDataSelectorWidget::selectionChanged ( RealDataItem *  )

signal

Referenced by ImportDataView::ImportDataView(), RealDataSelectorWidget(), and onSelectionChanged().

setCurrentItem()

void RealDataSelectorWidget::setCurrentItem

(

RealDataItem *

item

)

Definition at line 149 of file RealDataSelectorWidget.cpp.

{
    m_itemTree->selectionModel()->clearSelection();
    QModelIndex index = m_itemTreeModel->indexForItem(item);
    if (index.isValid())
        m_itemTree->selectionModel()->setCurrentIndex(index, QItemSelectionModel::SelectCurrent);
}

References RealDataTreeModel::indexForItem(), m_itemTree, and m_itemTreeModel.

Referenced by RealDataSelectorWidget(), importData1D(), and importData2D().

Here is the call graph for this function:

sizeHint()

QSize RealDataSelectorWidget::sizeHint ( ) const

override

Definition at line 134 of file RealDataSelectorWidget.cpp.

{
    return QSize(200, 400);
}

updateActionEnabling() [1/2]

void RealDataSelectorWidget::updateActionEnabling ( )

private

Definition at line 339 of file RealDataSelectorWidget.cpp.

{
    updateActionEnabling(currentItem());
}

References currentItem().

Referenced by RealDataSelectorWidget(), onContextMenuRequest(), and onSelectionChanged().

Here is the call graph for this function:

updateActionEnabling() [2/2]

void RealDataSelectorWidget::updateActionEnabling ( const RealDataItem *  item ) const

private

Definition at line 344 of file RealDataSelectorWidget.cpp.

{
    m_import2dDataAction->setEnabled(true);
    m_import1dDataAction->setEnabled(true);
 
    m_removeDataAction->setEnabled(item != nullptr);
    m_renameDataAction->setEnabled(item != nullptr);
}

References m_import1dDataAction, m_import2dDataAction, m_removeDataAction, and m_renameDataAction.

updateFunctionalities()

void RealDataSelectorWidget::updateFunctionalities ( )

private

Definition at line 353 of file RealDataSelectorWidget.cpp.

{
    QSet<int> visibleRanks;
    if (m_document->functionalities().testFlag(ProjectDocument::Specular))
        visibleRanks << 1;
    if (m_document->functionalities().testFlag(ProjectDocument::Gisas)
        || m_document->functionalities().testFlag(ProjectDocument::Offspec)
        || m_document->functionalities().testFlag(ProjectDocument::DepthProbe))
        visibleRanks << 2;
 
    m_itemTreeModel->setVisibleRanks(visibleRanks);
}

References ProjectDocument::DepthProbe, ProjectDocument::functionalities(), ProjectDocument::Gisas, m_document, m_itemTreeModel, ProjectDocument::Offspec, RealDataTreeModel::setVisibleRanks(), and ProjectDocument::Specular.

Referenced by RealDataSelectorWidget().

Here is the call graph for this function:

Member Data Documentation

m_document

ProjectDocument* RealDataSelectorWidget::m_document

private

Definition at line 72 of file RealDataSelectorWidget.h.

Referenced by RealDataSelectorWidget(), and updateFunctionalities().

m_import1dDataAction

QAction* RealDataSelectorWidget::m_import1dDataAction

Definition at line 75 of file RealDataSelectorWidget.h.

Referenced by RealDataSelectorWidget(), getOverlayActions(), onContextMenuRequest(), updateActionEnabling(), and ImportDataView::updateFunctionalityNarrowing().

m_import2dDataAction

QAction* RealDataSelectorWidget::m_import2dDataAction

Definition at line 76 of file RealDataSelectorWidget.h.

Referenced by RealDataSelectorWidget(), getOverlayActions(), onContextMenuRequest(), updateActionEnabling(), and ImportDataView::updateFunctionalityNarrowing().

m_itemTree

QTreeView* RealDataSelectorWidget::m_itemTree

private

Definition at line 68 of file RealDataSelectorWidget.h.

Referenced by RealDataSelectorWidget(), currentIndex(), onContextMenuRequest(), renameCurrentItem(), and setCurrentItem().

m_itemTreeModel

RealDataTreeModel* RealDataSelectorWidget::m_itemTreeModel

private

Definition at line 69 of file RealDataSelectorWidget.h.

Referenced by RealDataSelectorWidget(), currentItem(), getOverlayActions(), importData1D(), importData2D(), onContextMenuRequest(), removeCurrentItem(), setCurrentItem(), and updateFunctionalities().

m_propertiesWidget

RealDataPropertiesWidget* RealDataSelectorWidget::m_propertiesWidget

private

Definition at line 70 of file RealDataSelectorWidget.h.

Referenced by RealDataSelectorWidget(), and onSelectionChanged().

m_removeDataAction

QAction* RealDataSelectorWidget::m_removeDataAction

Definition at line 78 of file RealDataSelectorWidget.h.

Referenced by RealDataSelectorWidget(), onContextMenuRequest(), and updateActionEnabling().

m_renameDataAction

QAction* RealDataSelectorWidget::m_renameDataAction

Definition at line 77 of file RealDataSelectorWidget.h.

Referenced by RealDataSelectorWidget(), onContextMenuRequest(), and updateActionEnabling().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Import/RealDataSelectorWidget.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Import/RealDataSelectorWidget.cpp