InstrumentLibraryEditor::TreeModel Class Reference

Description

A model extension for InstrumentsTreeModel which.

• shows a "NEW" sign in the icon of a newly added instrument.
• creates a HTML text for the Display role

Definition at line 61 of file InstrumentLibraryEditor.h.

Inheritance diagram for InstrumentLibraryEditor::TreeModel:

Collaboration diagram for InstrumentLibraryEditor::TreeModel:

Public Types
enum	InstrumentType {   None = 0x0 , Gisas = 0x1 , Offspec = 0x2 , Specular = 0x4 ,   DepthProbe = 0x8 , All = Gisas | Offspec | Specular | DepthProbe }

Public Member Functions
	TreeModel (QObject *parent, InstrumentCollection *model)
int	columnCount (const QModelIndex &parent=QModelIndex()) const override
QVariant	data (const QModelIndex &index, int role) const override
void	enableEmptyHeadlines (bool b)
Qt::ItemFlags	flags (const QModelIndex &index) const override
QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const override
QModelIndex	indexForItem (InstrumentItem *item) const
QModelIndex	indexOfHeadline (InstrumentType type) const
bool	isHeadline (const QModelIndex &index) const
InstrumentItem *	itemForIndex (const QModelIndex &index) const
QModelIndex	parent (const QModelIndex &index) const override
void	refreshAfterModelChange ()
void	removeItem (InstrumentItem *item)
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
bool	setData (const QModelIndex &index, const QVariant &value, int role) override
void	setNewInstrument (InstrumentItem *addedInstrument)
	Set the instrument which shall have a "NEW" sign in its icon. More...
void	setTypeEnabled (InstrumentType type, bool b)
InstrumentItem *	topMostItem () const
	The topmost visible item. Can be null of course. More...

Static Public Member Functions
static InstrumentType	instrumentType (InstrumentItem *item)

Private Member Functions
void	clear ()
QVector< InstrumentItem * >	instruments (InstrumentType type) const
QList< InstrumentType >	visibleTypes () const

Private Attributes
bool	m_enableEmptyHeadlines
InstrumentCollection *	m_model = nullptr
bool	m_namesAreEditable
InstrumentItem *	m_newInstrument = nullptr
VisibleInstrumentTypes	m_visibleTypes

Member Enumeration Documentation

InstrumentType

enum InstrumentsTreeModel::InstrumentType

inherited

Enumerator
None
Gisas
Offspec
Specular
DepthProbe
All

Definition at line 29 of file InstrumentsTreeModel.h.

                        {
        None = 0x0,
        Gisas = 0x1,
        Offspec = 0x2,
        Specular = 0x4,
        DepthProbe = 0x8,
        All = Gisas | Offspec | Specular | DepthProbe
    };

Constructor & Destructor Documentation

TreeModel()

InstrumentLibraryEditor::TreeModel::TreeModel	(	QObject *	parent,
		InstrumentCollection *	model
	)

Definition at line 269 of file InstrumentLibraryEditor.cpp.

    : InstrumentsTreeModel(parent, model)
    , m_newInstrument(nullptr)
{
}

Member Function Documentation

clear()

void InstrumentsTreeModel::clear ( )

privateinherited

Definition at line 63 of file InstrumentsTreeModel.cpp.

{
    beginResetModel();
    endResetModel();
}

columnCount()

int InstrumentsTreeModel::columnCount ( const QModelIndex &  parent = QModelIndex() ) const

overrideinherited

Definition at line 163 of file InstrumentsTreeModel.cpp.

{
    return 1;
}

data()

QVariant InstrumentLibraryEditor::TreeModel::data ( const QModelIndex &  index, int  role  ) const

override

Definition at line 280 of file InstrumentLibraryEditor.cpp.

{
    if (isHeadline(index))
        return InstrumentsTreeModel::data(index, role);
 
    auto* const item = itemForIndex(index);
 
    if (role == Qt::DisplayRole) {
        auto descr = item->description();
        if (!descr.isEmpty()) {
            descr.prepend("<br><br>");
            // max 4 lines
            while (descr.count("\n") > 3) {
                descr.truncate(descr.lastIndexOf("\n"));
                descr += " [...]";
            }
            descr.replace("\n", "<br>");
        }
        return "<b>" + item->instrumentName() + "</b>" + descr;
    }
 
    if (role == Qt::DecorationRole && (item == m_newInstrument)) {
        if (role == Qt::DecorationRole)
            switch (instrumentType(item)) {
            case Gisas:
                return QIcon(":/images/gisas_instrument_new.svg");
            case Offspec:
                return QIcon(":/images/offspec_instrument_new.svg");
            case Specular:
                return QIcon(":/images/specular_instrument_new.svg");
            case DepthProbe:
                return QIcon(":/images/depth_instrument_new.svg");
            default:
                break;
            }
    }
    return InstrumentsTreeModel::data(index, role);
}

References InstrumentsTreeModel::data().

Here is the call graph for this function:

enableEmptyHeadlines()

void InstrumentsTreeModel::enableEmptyHeadlines ( bool  b )

inherited

Definition at line 32 of file InstrumentsTreeModel.cpp.

{
    if (b != m_enableEmptyHeadlines) {
        beginResetModel();
        m_enableEmptyHeadlines = b;
        endResetModel();
    }
}

References InstrumentsTreeModel::m_enableEmptyHeadlines.

Referenced by InstrumentLibraryEditor::InstrumentLibraryEditor().

flags()

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

overrideinherited

Definition at line 258 of file InstrumentsTreeModel.cpp.

{
    if (isHeadline(index) || !index.isValid())
        return Qt::NoItemFlags;
 
    auto f = QAbstractItemModel::flags(index);
    f |= Qt::ItemIsSelectable | Qt::ItemIsEnabled | Qt::ItemIsDragEnabled;
 
    if (index.column() == 0 && m_namesAreEditable) // col 0 contains name of the data entry
        f |= Qt::ItemIsEditable;
 
    return f;
}

References InstrumentsTreeModel::index(), InstrumentsTreeModel::isHeadline(), and InstrumentsTreeModel::m_namesAreEditable.

Here is the call graph for this function:

index()

QModelIndex InstrumentsTreeModel::index ( int  row, int  column, const QModelIndex &  parent = QModelIndex()  ) const

overrideinherited

Definition at line 132 of file InstrumentsTreeModel.cpp.

{
    if (!hasIndex(row, column, parent))
        return QModelIndex();
 
    if (!parent.isValid())
        return createIndex(row, column, nullptr);
 
    for (auto type : visibleTypes())
        if (parent == indexOfHeadline(type))
            return createIndex(row, column, instruments(type)[row]);
 
    return QModelIndex();
}

References InstrumentsTreeModel::indexOfHeadline(), InstrumentsTreeModel::instruments(), InstrumentsTreeModel::parent(), and InstrumentsTreeModel::visibleTypes().

Referenced by InstrumentsTreeModel::data(), InstrumentsTreeModel::flags(), InstrumentsTreeModel::isHeadline(), InstrumentsTreeModel::itemForIndex(), InstrumentsTreeModel::parent(), InstrumentsTreeModel::removeItem(), and InstrumentsTreeModel::setData().

Here is the call graph for this function:

indexForItem()

QModelIndex InstrumentsTreeModel::indexForItem ( InstrumentItem *  item ) const

inherited

Definition at line 300 of file InstrumentsTreeModel.cpp.

{
    if (item == nullptr)
        return QModelIndex();
 
    for (auto type : visibleTypes())
        if (auto row = instruments(type).indexOf(item); row >= 0)
            return createIndex(row, 0, item);
 
    return QModelIndex();
}

References InstrumentsTreeModel::instruments(), and InstrumentsTreeModel::visibleTypes().

Referenced by InstrumentLibraryEditor::execAdd(), and InstrumentsTreeModel::removeItem().

Here is the call graph for this function:

indexOfHeadline()

QModelIndex InstrumentsTreeModel::indexOfHeadline ( InstrumentType  type ) const

inherited

Definition at line 120 of file InstrumentsTreeModel.cpp.

{
    int row = 0;
    for (auto t : visibleTypes()) {
        if (t == type)
            return createIndex(row, 0, nullptr);
        row++;
    }
 
    return QModelIndex();
}

References InstrumentsTreeModel::visibleTypes().

Referenced by InstrumentsTreeModel::data(), InstrumentsTreeModel::index(), InstrumentsTreeModel::parent(), and InstrumentsTreeModel::rowCount().

Here is the call graph for this function:

instruments()

QVector< InstrumentItem * > InstrumentsTreeModel::instruments ( InstrumentType  type ) const

privateinherited

Definition at line 87 of file InstrumentsTreeModel.cpp.

{
    switch (type) {
    case Gisas:
        return m_model->instrumentItems([](const InstrumentItem* p) {
            return dynamic_cast<const GISASInstrumentItem*>(p) != nullptr;
        });
    case Offspec:
        return m_model->instrumentItems([](const InstrumentItem* p) {
            return dynamic_cast<const OffspecInstrumentItem*>(p) != nullptr;
        });
    case Specular:
        return m_model->instrumentItems([](const InstrumentItem* p) {
            return dynamic_cast<const SpecularInstrumentItem*>(p) != nullptr;
        });
    case DepthProbe:
        return m_model->instrumentItems([](const InstrumentItem* p) {
            return dynamic_cast<const DepthProbeInstrumentItem*>(p) != nullptr;
        });
    default:
        return {};
    }
}

References InstrumentsTreeModel::DepthProbe, InstrumentsTreeModel::Gisas, InstrumentCollection::instrumentItems(), InstrumentsTreeModel::m_model, InstrumentsTreeModel::Offspec, and InstrumentsTreeModel::Specular.

Referenced by InstrumentsTreeModel::index(), InstrumentsTreeModel::indexForItem(), InstrumentsTreeModel::parent(), InstrumentsTreeModel::rowCount(), InstrumentsTreeModel::topMostItem(), and InstrumentsTreeModel::visibleTypes().

Here is the call graph for this function:

instrumentType()

InstrumentsTreeModel::InstrumentType InstrumentsTreeModel::instrumentType ( InstrumentItem *  item )

staticinherited

Definition at line 331 of file InstrumentsTreeModel.cpp.

{
    if (item->is<GISASInstrumentItem>())
        return Gisas;
 
    if (item->is<OffspecInstrumentItem>())
        return Offspec;
 
    if (item->is<SpecularInstrumentItem>())
        return Specular;
 
    if (item->is<DepthProbeInstrumentItem>())
        return DepthProbe;
 
    ASSERT(false);
    return None;
}

References InstrumentsTreeModel::DepthProbe, InstrumentsTreeModel::Gisas, InstrumentItem::is(), InstrumentsTreeModel::None, InstrumentsTreeModel::Offspec, and InstrumentsTreeModel::Specular.

Referenced by InstrumentsTreeModel::data(), and InstrumentLibraryEditor::execAdd().

Here is the call graph for this function:

isHeadline()

bool InstrumentsTreeModel::isHeadline ( const QModelIndex &  index ) const

inherited

Definition at line 323 of file InstrumentsTreeModel.cpp.

{
    if (!index.isValid())
        return false;
 
    return index.internalPointer() == nullptr;
}

References InstrumentsTreeModel::index().

Referenced by InstrumentsTreeModel::data(), InstrumentsTreeModel::flags(), and InstrumentLibraryEditor::getOverlayActions().

Here is the call graph for this function:

itemForIndex()

InstrumentItem * InstrumentsTreeModel::itemForIndex ( const QModelIndex &  index ) const

inherited

Definition at line 292 of file InstrumentsTreeModel.cpp.

{
    if (!index.isValid())
        return nullptr;
 
    return reinterpret_cast<InstrumentItem*>(index.internalPointer());
}

References InstrumentsTreeModel::index().

Referenced by InstrumentLibraryEditor::createWidgetsForCurrentInstrument(), InstrumentsTreeModel::data(), InstrumentLibraryEditor::getOverlayActions(), InstrumentLibraryEditor::onCurrentChangedForChoose(), InstrumentLibraryEditor::onInstrumentChangedByEditor(), InstrumentLibraryEditor::onItemDoubleClickedForChoose(), InstrumentsTreeModel::parent(), and InstrumentsTreeModel::setData().

Here is the call graph for this function:

parent()

QModelIndex InstrumentsTreeModel::parent ( const QModelIndex &  index ) const

overrideinherited

Definition at line 147 of file InstrumentsTreeModel.cpp.

{
    if (!index.isValid())
        return QModelIndex();
 
    if (index.internalPointer() == nullptr) // index is headline => no parent
        return QModelIndex();
 
    auto* item = itemForIndex(index);
    for (auto type : visibleTypes())
        if (instruments(type).contains(item))
            return indexOfHeadline(type);
 
    return QModelIndex();
}

References InstrumentsTreeModel::index(), InstrumentsTreeModel::indexOfHeadline(), InstrumentsTreeModel::instruments(), InstrumentsTreeModel::itemForIndex(), and InstrumentsTreeModel::visibleTypes().

Referenced by InstrumentsTreeModel::index(), and InstrumentsTreeModel::rowCount().

Here is the call graph for this function:

refreshAfterModelChange()

void InstrumentsTreeModel::refreshAfterModelChange ( )

inherited

Definition at line 50 of file InstrumentsTreeModel.cpp.

{
    //     for (auto rank : m_visibleRanks) {
    //         if (!m_items[rank - 1].isEmpty()) {
    //             beginRemoveRows(indexOfHeadline(rank), 0, m_items[rank - 1].size() - 1);
    //             m_items[rank - 1] = m_model->InstrumentCollection(rank);
    //             endRemoveRows();
    //         }
    //     }
    //
    //     updateSubscriptions();
}

removeItem()

void InstrumentsTreeModel::removeItem ( InstrumentItem *  item )

inherited

Definition at line 312 of file InstrumentsTreeModel.cpp.

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

References InstrumentsTreeModel::index(), InstrumentsTreeModel::indexForItem(), InstrumentsTreeModel::m_model, and InstrumentCollection::removeInstrument().

Referenced by InstrumentLibraryEditor::getOverlayActions().

Here is the call graph for this function:

rowCount()

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

overrideinherited

Definition at line 168 of file InstrumentsTreeModel.cpp.

{
    if (!parent.isValid())
        return visibleTypes().size();
 
    // parent is a headline
    for (auto type : visibleTypes())
        if (parent == indexOfHeadline(type))
            return instruments(type).size();
 
    return 0;
}

References InstrumentsTreeModel::indexOfHeadline(), InstrumentsTreeModel::instruments(), InstrumentsTreeModel::parent(), and InstrumentsTreeModel::visibleTypes().

Here is the call graph for this function:

setData()

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

overrideinherited

Definition at line 272 of file InstrumentsTreeModel.cpp.

{
    if (!index.isValid())
        return false;
 
    if (role == Qt::EditRole && index.column() == 0) {
        itemForIndex(index)->setInstrumentName(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 InstrumentsTreeModel::index(), InstrumentsTreeModel::itemForIndex(), InstrumentItem::setDescription(), and InstrumentItem::setInstrumentName().

Referenced by InstrumentLibraryEditor::onInstrumentDescriptionEdited(), and InstrumentLibraryEditor::onInstrumentNameEdited().

Here is the call graph for this function:

setNewInstrument()

void InstrumentLibraryEditor::TreeModel::setNewInstrument

(

InstrumentItem *

addedInstrument

)

Set the instrument which shall have a "NEW" sign in its icon.

Definition at line 275 of file InstrumentLibraryEditor.cpp.

{
    m_newInstrument = addedInstrument;
}

Referenced by InstrumentLibraryEditor::execAdd().

setTypeEnabled()

void InstrumentsTreeModel::setTypeEnabled ( InstrumentType  type, bool  b  )

inherited

Definition at line 41 of file InstrumentsTreeModel.cpp.

{
    if (m_visibleTypes.testFlag(type) != b) {
        beginResetModel();
        m_visibleTypes.setFlag(type, b);
        endResetModel();
    }
}

References InstrumentsTreeModel::m_visibleTypes.

Referenced by InstrumentLibraryEditor::execAdd(), InstrumentLibraryEditor::setDepthProbeEnabled(), InstrumentLibraryEditor::setGisasEnabled(), InstrumentLibraryEditor::setOffspecEnabled(), and InstrumentLibraryEditor::setSpecularEnabled().

topMostItem()

InstrumentItem * InstrumentsTreeModel::topMostItem ( ) const

inherited

The topmost visible item. Can be null of course.

Definition at line 111 of file InstrumentsTreeModel.cpp.

{
    for (auto t : visibleTypes())
        if (auto instr = instruments(t); !instr.isEmpty())
            return instr.first();
 
    return nullptr;
}

References InstrumentsTreeModel::instruments(), and InstrumentsTreeModel::visibleTypes().

Here is the call graph for this function:

visibleTypes()

QList< InstrumentsTreeModel::InstrumentType > InstrumentsTreeModel::visibleTypes ( ) const

privateinherited

Definition at line 69 of file InstrumentsTreeModel.cpp.

{
    QList<InstrumentsTreeModel::InstrumentType> result;
 
    const auto forType = [&](InstrumentType type) {
        if (m_visibleTypes.testFlag(type)
            && (m_enableEmptyHeadlines || !instruments(type).isEmpty()))
            result << type;
    };
 
    forType(Gisas);
    forType(Offspec);
    forType(Specular);
    forType(DepthProbe);
 
    return result;
}

References InstrumentsTreeModel::DepthProbe, InstrumentsTreeModel::Gisas, InstrumentsTreeModel::instruments(), InstrumentsTreeModel::m_enableEmptyHeadlines, InstrumentsTreeModel::m_visibleTypes, InstrumentsTreeModel::Offspec, and InstrumentsTreeModel::Specular.

Referenced by InstrumentsTreeModel::index(), InstrumentsTreeModel::indexForItem(), InstrumentsTreeModel::indexOfHeadline(), InstrumentsTreeModel::parent(), InstrumentsTreeModel::rowCount(), and InstrumentsTreeModel::topMostItem().

Here is the call graph for this function:

Member Data Documentation

m_enableEmptyHeadlines

bool InstrumentsTreeModel::m_enableEmptyHeadlines

privateinherited

Definition at line 74 of file InstrumentsTreeModel.h.

Referenced by InstrumentsTreeModel::enableEmptyHeadlines(), and InstrumentsTreeModel::visibleTypes().

m_model

InstrumentCollection* InstrumentsTreeModel::m_model = nullptr

privateinherited

Definition at line 71 of file InstrumentsTreeModel.h.

Referenced by InstrumentsTreeModel::instruments(), and InstrumentsTreeModel::removeItem().

m_namesAreEditable

bool InstrumentsTreeModel::m_namesAreEditable

privateinherited

Definition at line 73 of file InstrumentsTreeModel.h.

Referenced by InstrumentsTreeModel::flags().

m_newInstrument

InstrumentItem* InstrumentLibraryEditor::TreeModel::m_newInstrument = nullptr

private

Definition at line 71 of file InstrumentLibraryEditor.h.

m_visibleTypes

VisibleInstrumentTypes InstrumentsTreeModel::m_visibleTypes

privateinherited

Definition at line 72 of file InstrumentsTreeModel.h.

Referenced by InstrumentsTreeModel::setTypeEnabled(), and InstrumentsTreeModel::visibleTypes().

---

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