SampleListModel Class Reference

Description

List model for sample selection (used in the left pane of the layer oriented sample editor)

Definition at line 24 of file SampleListModel.h.

Inheritance diagram for SampleListModel:

Collaboration diagram for SampleListModel:

Public Member Functions
	SampleListModel (QObject *parent, MultiLayerItems *model)
QModelIndex	createSample ()
	Create a new sample (sample) and return the index of it. More...
QModelIndex	createSampleFromExamples (const QString &className, const QString &title, const QString &description)
	Create sample from list of built-in examples. More...
QModelIndex	createSampleFromPython ()
	Create sample from an imported python code. More...
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
Qt::ItemFlags	flags (const QModelIndex &index) const override
QModelIndex	indexForItem (MultiLayerItem *item) const
MultiLayerItem *	itemForIndex (const QModelIndex &index) const
void	removeSample (MultiLayerItem *item)
	Remove the given sample. nullptr is allowed. More...
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
bool	setData (const QModelIndex &index, const QVariant &value, int role) override

Private Attributes
MultiLayerItems *	m_sampleItems = nullptr

Constructor & Destructor Documentation

SampleListModel()

SampleListModel::SampleListModel	(	QObject *	parent,
		MultiLayerItems *	model
	)

Definition at line 28 of file SampleListModel.cpp.

    : QAbstractListModel(parent)
    , m_sampleItems(model)
{
}

Member Function Documentation

createSample()

QModelIndex SampleListModel::createSample

(

)

Create a new sample (sample) and return the index of it.

Definition at line 124 of file SampleListModel.cpp.

{
    const QStringList existingNames = m_sampleItems->sampleNames();
 
    const int row = m_sampleItems->sampleItems().size();
    beginInsertRows(QModelIndex(), row, row);
    auto* sample_item = m_sampleItems->addMultiLayer();
    sample_item->setSampleName(GUI::Util::String::suggestName(existingNames, "Sample"));
    sample_item->addStandardMaterials();
    endInsertRows();
    return indexForItem(sample_item);
}

References MultiLayerItems::addMultiLayer(), indexForItem(), m_sampleItems, MultiLayerItems::sampleItems(), MultiLayerItems::sampleNames(), MultiLayerItem::setSampleName(), and GUI::Util::String::suggestName().

Referenced by SampleListView::createNewSample().

Here is the call graph for this function:

createSampleFromExamples()

QModelIndex SampleListModel::createSampleFromExamples	(	const QString &	className,
		const QString &	title,
		const QString &	description
	)

Create sample from list of built-in examples.

Returns invalid index if anything went wrong.

Definition at line 137 of file SampleListModel.cpp.

{
    try {
        auto* sample =
            dynamic_cast<MultiLayerItem*>(GUI::ExamplesFactory::itemizeSample(className));
        if (!sample)
            return {};
        sample->setSampleName(title);
        sample->setDescription(description);
 
        const int row = m_sampleItems->sampleItems().size();
        beginInsertRows(QModelIndex(), row, row);
        m_sampleItems->addMultiLayer(sample);
        endInsertRows();
        return indexForItem(sample);
    } catch (const std::exception& ex) {
        QString message("Exception thrown while trying to build GUI models.\n");
        QString details = QString::fromStdString(ex.what());
        DetailedMessageBox(GUI::Global::mainWindow, "Example builder failure", message, details)
            .exec();
        return {};
    }
}

References MultiLayerItems::addMultiLayer(), indexForItem(), GUI::ExamplesFactory::itemizeSample(), m_sampleItems, GUI::Global::mainWindow, MultiLayerItems::sampleItems(), and MultiLayerItem::setSampleName().

Referenced by SampleListView::createSampleFromLibrary().

Here is the call graph for this function:

createSampleFromPython()

QModelIndex SampleListModel::createSampleFromPython

(

)

Create sample from an imported python code.

Returns invalid index if anything went wrong.

Definition at line 164 of file SampleListModel.cpp.

{
    auto sample = PyImportAssistant::importMultiLayer();
    if (!sample)
        return {}; // any messages already shown to user; no dlg necessary anymore
 
 
    auto* sampleItem = PyImportAssistant::itemizeSample(*sample);
    if (!sampleItem)
        return {}; // any messages already shown to user; no dlg necessary anymore
 
    sampleItem->setDescription("Imported from python code");
 
    const int row = m_sampleItems->sampleItems().size();
    beginInsertRows(QModelIndex(), row, row);
    m_sampleItems->addMultiLayer(sampleItem);
    endInsertRows();
    return indexForItem(sampleItem);
}

References MultiLayerItems::addMultiLayer(), PyImportAssistant::importMultiLayer(), indexForItem(), PyImportAssistant::itemizeSample(), m_sampleItems, and MultiLayerItems::sampleItems().

Referenced by SampleListView::importSampleFromPython().

Here is the call graph for this function:

data()

QVariant SampleListModel::data ( const QModelIndex &  index, int  role = Qt::DisplayRole  ) const

override

Definition at line 42 of file SampleListModel.cpp.

{
    auto* const item = itemForIndex(index);
 
    if (role == Qt::ToolTipRole)
        return item->description();
 
    if (role == Qt::DisplayRole) {
        auto descr = item->description();
        if (!descr.isEmpty()) {
            descr.prepend("<br><br>");
            const int maxDescriptionLines = 8;
            while (descr.count("\n") >= maxDescriptionLines) {
                descr.truncate(descr.lastIndexOf("\n"));
                descr += " [...]";
            }
            descr.replace("\n", "<br>");
        }
        return "<b>" + item->sampleName() + "</b>" + descr;
    }
 
    if (role == Qt::EditRole)
        return item->sampleName();
 
    return QVariant();
}

References itemForIndex().

Here is the call graph for this function:

flags()

Qt::ItemFlags SampleListModel::flags ( const QModelIndex &  index ) const

override

Definition at line 69 of file SampleListModel.cpp.

{
    auto f = QAbstractItemModel::flags(index);
    f |= Qt::ItemIsSelectable | Qt::ItemIsEnabled | Qt::ItemIsDragEnabled;
 
    return f;
}

indexForItem()

QModelIndex SampleListModel::indexForItem

(

MultiLayerItem *

item

)

const

Definition at line 105 of file SampleListModel.cpp.

{
    if (auto row = m_sampleItems->sampleItems().indexOf(item); row >= 0)
        return index(row, 0);
 
    return QModelIndex();
}

References m_sampleItems, and MultiLayerItems::sampleItems().

Referenced by createSample(), createSampleFromExamples(), createSampleFromPython(), removeSample(), and SampleListView::setCurrentSample().

Here is the call graph for this function:

itemForIndex()

MultiLayerItem * SampleListModel::itemForIndex

(

const QModelIndex &

index

)

const

Definition at line 97 of file SampleListModel.cpp.

{
    if (!index.isValid())
        return nullptr;
 
    return m_sampleItems->sampleItems()[index.row()];
}

References m_sampleItems, and MultiLayerItems::sampleItems().

Referenced by SampleListView::currentSample(), data(), SampleListView::getOverlayActions(), SampleListView::onCurrentChanged(), setData(), and SampleListView::showContextMenu().

Here is the call graph for this function:

removeSample()

void SampleListModel::removeSample

(

MultiLayerItem *

item

)

Remove the given sample. nullptr is allowed.

Definition at line 113 of file SampleListModel.cpp.

{
    QModelIndex index = indexForItem(item);
    if (!index.isValid())
        return;
 
    beginRemoveRows(index.parent(), index.row(), index.row());
    m_sampleItems->removeMultiLayer(item);
    endRemoveRows();
}

References indexForItem(), m_sampleItems, and MultiLayerItems::removeMultiLayer().

Referenced by SampleListView::removeSample().

Here is the call graph for this function:

rowCount()

int SampleListModel::rowCount ( const QModelIndex &  parent = QModelIndex() ) const

override

Definition at line 34 of file SampleListModel.cpp.

{
    if (parent.isValid())
        return 0;
 
    return m_sampleItems->sampleItems().size();
}

References m_sampleItems, and MultiLayerItems::sampleItems().

Here is the call graph for this function:

setData()

bool SampleListModel::setData ( const QModelIndex &  index, const QVariant &  value, int  role  )

override

Definition at line 77 of file SampleListModel.cpp.

{
    if (!index.isValid())
        return false;
 
    if (role == Qt::EditRole && index.column() == 0) {
        itemForIndex(index)->setSampleName(value.toString());
        emit dataChanged(index, index);
        return true;
    }
 
    if (role == Qt::ToolTipRole && index.column() == 0) {
        itemForIndex(index)->setDescription(value.toString());
        emit dataChanged(index, index);
        return true;
    }
 
    return false;
}

References itemForIndex(), MultiLayerItem::setDescription(), and MultiLayerItem::setSampleName().

Here is the call graph for this function:

Member Data Documentation

m_sampleItems

MultiLayerItems* SampleListModel::m_sampleItems = nullptr

private

Definition at line 56 of file SampleListModel.h.

Referenced by createSample(), createSampleFromExamples(), createSampleFromPython(), indexForItem(), itemForIndex(), removeSample(), and rowCount().

---

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

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