SampleListView Class Reference

Description

List view to select one sample (left side of layer-oriented sample editor)

Definition at line 25 of file SampleListView.h.

Inheritance diagram for SampleListView:

Collaboration diagram for SampleListView:

Public Slots
void	onSampleModified ()

Signals
void	currentSampleChanged (MultiLayerItem *current)

Public Member Functions
	SampleListView (QWidget *parent, ProjectDocument *document)
QAction *	chooseFromLibraryAction ()
MultiLayerItem *	currentSample ()
QAction *	importSampleAction ()
QAction *	newSampleAction ()
void	selectFirstSample ()
	Select first sample, if any sample exists. More...
void	setCurrentSample (MultiLayerItem *sample)
QSize	sizeHint () const override

Private Member Functions
void	createNewSample ()
QAction *	createRemoveAction (QObject *parent, MultiLayerItem *item)
void	createSampleFromLibrary (const QString &classname, const QString &title, const QString &description)
QList< QAction * >	getOverlayActions (const QModelIndex &index, bool asHover)
void	importSampleFromPython ()
void	onCurrentChanged (const QModelIndex &index)
void	removeSample (MultiLayerItem *item)
void	showContextMenu (const QPoint &pos)

Private Attributes
QAction *	m_chooseFromLibraryAction
ProjectDocument *	m_document
QAction *	m_importSampleAction
SampleListModel *	m_model
QAction *	m_newSampleAction

Constructor & Destructor Documentation

SampleListView()

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

Definition at line 64 of file SampleListView.cpp.

    : QListView(parent)
    , m_document(document)
{
    m_model = new SampleListModel(this, document->sampleItems());
 
    setContextMenuPolicy(Qt::CustomContextMenu);
    setModel(m_model);
    setVerticalScrollMode(QAbstractItemView::ScrollPerPixel);
 
    ItemViewOverlayButtons::install(
        this, [=](const QModelIndex& i, bool h) { return getOverlayActions(i, h); });
    setItemDelegate(new ItemDelegateForSampleTree(this));
 
    connect(selectionModel(), &QItemSelectionModel::currentChanged, this,
            &SampleListView::onCurrentChanged);
 
    connect(this, &QWidget::customContextMenuRequested, this, &SampleListView::showContextMenu);
 
    m_newSampleAction = new QAction(this);
    m_newSampleAction->setText("Create new sample");
    m_newSampleAction->setIcon(QIcon(":/images/shape-square-plus.svg"));
    m_newSampleAction->setIconText("New");
    m_newSampleAction->setToolTip("Create new sample");
    connect(m_newSampleAction, &QAction::triggered, this, &SampleListView::createNewSample);
 
    m_importSampleAction = new QAction(this);
    m_importSampleAction->setText("Import sample from python script (experimental)");
    m_importSampleAction->setIcon(QIcon(":/images/import.svg"));
    m_importSampleAction->setIconText("Import");
    m_importSampleAction->setToolTip(
        "Import sample from Python script.\n The script should contain a function "
        "returning a valid multi-layer.");
 
#ifdef Q_OS_MAC
    if (BaseUtils::System::getenv("PYTHONHOME").empty())
        m_importSampleAction->setEnabled(false);
#endif
 
#ifdef BORNAGAIN_PYTHON
    connect(m_importSampleAction, &QAction::triggered, this,
            &SampleListView::importSampleFromPython);
#else
    m_importSampleAction->setVisible(false);
#endif
 
    m_chooseFromLibraryAction = new QAction(this);
    m_chooseFromLibraryAction->setText("Choose from sample examples");
    m_chooseFromLibraryAction->setIcon(QIcon(":/images/library.svg"));
    m_chooseFromLibraryAction->setIconText("Examples");
    m_chooseFromLibraryAction->setToolTip("Choose from sample examples");
 
    auto* menu = new QMenu(this);
    m_chooseFromLibraryAction->setMenu(menu);
 
    for (const auto& exampleName : GUI::ExamplesFactory::exampleNames()) {
        QString title, description;
        std::tie(title, description) = GUI::ExamplesFactory::exampleInfo(exampleName);
        auto icon = QIcon(":/SampleDesignerToolbox/images/sample_layers2.png");
        auto* action = menu->addAction(icon, title);
        action->setToolTip(description);
        connect(action, &QAction::triggered,
                [=]() { createSampleFromLibrary(exampleName, title, description); });
    }
}

References createNewSample(), createSampleFromLibrary(), GUI::ExamplesFactory::exampleInfo(), GUI::ExamplesFactory::exampleNames(), getOverlayActions(), importSampleFromPython(), ItemViewOverlayButtons::install(), m_chooseFromLibraryAction, m_importSampleAction, m_model, m_newSampleAction, onCurrentChanged(), ProjectDocument::sampleItems(), and showContextMenu().

Here is the call graph for this function:

Member Function Documentation

chooseFromLibraryAction()

QAction * SampleListView::chooseFromLibraryAction

(

)

Definition at line 157 of file SampleListView.cpp.

{
    return m_chooseFromLibraryAction;
}

References m_chooseFromLibraryAction.

Referenced by SampleView::SampleView().

createNewSample()

void SampleListView::createNewSample ( )

private

Definition at line 176 of file SampleListView.cpp.

{
    const QModelIndex newIndex = m_model->createSample();
    setCurrentIndex(newIndex);
    m_document->setModified();
}

References SampleListModel::createSample(), m_document, m_model, and ProjectDocument::setModified().

Referenced by SampleListView().

Here is the call graph for this function:

createRemoveAction()

QAction * SampleListView::createRemoveAction ( QObject *  parent, MultiLayerItem *  item  )

private

Definition at line 227 of file SampleListView.cpp.

{
    auto* removeAction = new QAction(parent);
    removeAction->setText("Remove");
    removeAction->setIcon(QIcon(":/images/delete.svg"));
    removeAction->setIconText("Remove");
    removeAction->setToolTip("Remove this sample");
    connect(removeAction, &QAction::triggered, [=]() { removeSample(item); });
 
    return removeAction;
}

References removeSample().

Referenced by getOverlayActions(), and showContextMenu().

Here is the call graph for this function:

createSampleFromLibrary()

void SampleListView::createSampleFromLibrary ( const QString &  classname, const QString &  title, const QString &  description  )

private

Definition at line 183 of file SampleListView.cpp.

{
    const QModelIndex newIndex = m_model->createSampleFromExamples(classname, title, description);
    if (newIndex.isValid()) {
        setCurrentIndex(newIndex);
        m_document->setModified();
    }
}

References SampleListModel::createSampleFromExamples(), m_document, m_model, and ProjectDocument::setModified().

Referenced by SampleListView().

Here is the call graph for this function:

currentSample()

MultiLayerItem * SampleListView::currentSample

(

)

Definition at line 135 of file SampleListView.cpp.

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

References SampleListModel::itemForIndex(), and m_model.

Referenced by SampleView::onRequestViewInRealSpace(), and SampleView::showEvent().

Here is the call graph for this function:

currentSampleChanged

void SampleListView::currentSampleChanged ( MultiLayerItem *  current )

signal

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

getOverlayActions()

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

private

Definition at line 204 of file SampleListView.cpp.

{
    if (!asHover)
        return {};
 
    auto* item = m_model->itemForIndex(index);
    if (item == nullptr)
        return {};
 
    return {createRemoveAction(this, item)};
}

References createRemoveAction(), SampleListModel::itemForIndex(), and m_model.

Referenced by SampleListView().

Here is the call graph for this function:

importSampleAction()

QAction * SampleListView::importSampleAction

(

)

Definition at line 152 of file SampleListView.cpp.

{
    return m_importSampleAction;
}

References m_importSampleAction.

Referenced by SampleView::SampleView().

importSampleFromPython()

void SampleListView::importSampleFromPython ( )

private

Definition at line 193 of file SampleListView.cpp.

{
#ifdef BORNAGAIN_PYTHON
    const QModelIndex newIndex = m_model->createSampleFromPython();
    if (newIndex.isValid()) {
        setCurrentIndex(newIndex);
        m_document->setModified();
    }
#endif
}

References SampleListModel::createSampleFromPython(), m_document, m_model, and ProjectDocument::setModified().

Referenced by SampleListView().

Here is the call graph for this function:

newSampleAction()

QAction * SampleListView::newSampleAction

(

)

Definition at line 147 of file SampleListView.cpp.

{
    return m_newSampleAction;
}

References m_newSampleAction.

Referenced by SampleView::SampleView().

onCurrentChanged()

void SampleListView::onCurrentChanged ( const QModelIndex &  index )

private

Definition at line 216 of file SampleListView.cpp.

{
    emit currentSampleChanged(m_model->itemForIndex(index));
}

References currentSampleChanged(), SampleListModel::itemForIndex(), and m_model.

Referenced by SampleListView().

Here is the call graph for this function:

onSampleModified

void SampleListView::onSampleModified ( )

slot

Definition at line 169 of file SampleListView.cpp.

{
    // if length of description changes height of TreeItem, the position of the overlay buttons
    // has to be updated -> schedule a re-layout
    scheduleDelayedItemsLayout();
}

Referenced by SampleView::SampleView().

removeSample()

void SampleListView::removeSample ( MultiLayerItem *  item )

private

Definition at line 221 of file SampleListView.cpp.

{
    m_model->removeSample(item);
    m_document->setModified();
}

References m_document, m_model, SampleListModel::removeSample(), and ProjectDocument::setModified().

Referenced by createRemoveAction().

Here is the call graph for this function:

selectFirstSample()

void SampleListView::selectFirstSample

(

)

Select first sample, if any sample exists.

Definition at line 140 of file SampleListView.cpp.

{
    if (m_document->sampleItems()->sampleItems().isEmpty())
        return;
    setCurrentSample(m_document->sampleItems()->sampleItems()[0]);
}

References m_document, ProjectDocument::sampleItems(), MultiLayerItems::sampleItems(), and setCurrentSample().

Referenced by SampleView::showEvent().

Here is the call graph for this function:

setCurrentSample()

void SampleListView::setCurrentSample

(

MultiLayerItem *

sample

)

Definition at line 130 of file SampleListView.cpp.

{
    setCurrentIndex(m_model->indexForItem(sample));
}

References SampleListModel::indexForItem(), and m_model.

Referenced by selectFirstSample().

Here is the call graph for this function:

showContextMenu()

void SampleListView::showContextMenu ( const QPoint &  pos )

private

Definition at line 239 of file SampleListView.cpp.

{
    auto* sampleAtPoint = m_model->itemForIndex(indexAt(pos));
 
    QMenu menu;
    menu.setToolTipsVisible(true);
 
    if (sampleAtPoint != nullptr) {
        menu.addAction(createRemoveAction(&menu, sampleAtPoint));
        menu.addSeparator();
    }
 
    menu.addAction(m_newSampleAction);
    menu.addAction(m_chooseFromLibraryAction);
    menu.exec(mapToGlobal(pos));
}

References createRemoveAction(), SampleListModel::itemForIndex(), m_chooseFromLibraryAction, m_model, and m_newSampleAction.

Referenced by SampleListView().

Here is the call graph for this function:

sizeHint()

QSize SampleListView::sizeHint ( ) const

override

Definition at line 162 of file SampleListView.cpp.

{
    QSize s = QListView::sizeHint();
    s.setWidth(std::max(300, s.width()));
    return s;
}

Member Data Documentation

m_chooseFromLibraryAction

QAction* SampleListView::m_chooseFromLibraryAction

private

Definition at line 66 of file SampleListView.h.

Referenced by SampleListView(), chooseFromLibraryAction(), and showContextMenu().

m_document

ProjectDocument* SampleListView::m_document

private

Definition at line 63 of file SampleListView.h.

Referenced by createNewSample(), createSampleFromLibrary(), importSampleFromPython(), removeSample(), and selectFirstSample().

m_importSampleAction

QAction* SampleListView::m_importSampleAction

private

Definition at line 65 of file SampleListView.h.

Referenced by SampleListView(), and importSampleAction().

m_model

SampleListModel* SampleListView::m_model

private

Definition at line 62 of file SampleListView.h.

Referenced by SampleListView(), createNewSample(), createSampleFromLibrary(), currentSample(), getOverlayActions(), importSampleFromPython(), onCurrentChanged(), removeSample(), setCurrentSample(), and showContextMenu().

m_newSampleAction

QAction* SampleListView::m_newSampleAction

private

Definition at line 64 of file SampleListView.h.

Referenced by SampleListView(), newSampleAction(), and showContextMenu().

---

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

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