SessionModel Class Reference

Description

Base class for a GUI data collection. A collection is e.g. all real data (RealDataModel). Every model is implementing a Qt item model, therefore the "model" in the class name. Each model is populated by objects derived from SessionItem.

Purpose of a model is to

• Keep the root item of the contained data (which then keeps the tree of all items in this model)
• adding/removing items
• iteration over contained items
• load/store the items in the project file as XML
• use Qt mechanisms for GUI representation in different views
• notification of data changes to any listener

Definition at line 42 of file SessionModel.h.

Inheritance diagram for SessionModel:

Collaboration diagram for SessionModel:

Public Member Functions
	SessionModel (QString model_tag, QObject *parent=nullptr)
	~SessionModel () override
QVector< QString >	acceptableDefaultItemTypes (const QModelIndex &parent) const
bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const override
virtual void	clear ()
int	columnCount (const QModelIndex &parent) const override
SessionItem *	copy (const SessionItem *item_to_copy, SessionItem *new_parent=nullptr, const QString &tag="")
	Copy given item to the new_parent at given row. Item intended for copying can belong to another model and it will remain intact. Returns pointer to the new child. More...
template<typename T >
T *	copyItem (const T *item_to_copy, SessionItem *new_parent=nullptr, const QString &tag="")
void	createRootItem ()
QVariant	data (const QModelIndex &index, int role) const override
bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
Qt::ItemFlags	flags (const QModelIndex &index) const override
QString	getModelTag () const
QVariant	headerData (int section, Qt::Orientation orientation, int role) const override
QModelIndex	index (int row, int column, const QModelIndex &parent) const override
QModelIndex	indexOfItem (SessionItem *item) const
virtual void	initFrom (SessionModel *model, SessionItem *parent)
template<typename T >
T *	insertItem (const QModelIndex &parent, int row=-1, QString tag="")
template<typename T >
T *	insertItem (SessionItem *parent=nullptr, int row=-1, QString tag="")
SessionItem *	insertNewItem (QString model_type, const QModelIndex &parent_item, int row=-1, QString tag="")
SessionItem *	insertNewItem (QString model_type, SessionItem *parent_item=nullptr, int row=-1, QString tag="")
SessionItem *	itemForIndex (const QModelIndex &index) const
QMimeData *	mimeData (const QModelIndexList &indices) const override
QStringList	mimeTypes () const override
SessionItem *	moveItem (SessionItem *item, SessionItem *new_parent=nullptr, int row=-1, const QString &tag="")
	Move given parameterized item to the new_parent at given row. If new_parent is not defined, use root_item as a new parent. More...
virtual QVector< SessionItem * >	nonXMLItems () const
QModelIndex	parent (const QModelIndex &child) const override
virtual void	readFrom (QXmlStreamReader *reader, MessageService *messageService=nullptr)
void	removeItem (SessionItem *item)
bool	removeRows (int row, int count, const QModelIndex &parent) override
SessionItem *	rootItem () const
int	rowCount (const QModelIndex &parent) const override
bool	setData (const QModelIndex &index, const QVariant &value, int role) override
void	setDraggedItemType (const QString &type)
Qt::DropActions	supportedDragActions () const override
Qt::DropActions	supportedDropActions () const override
template<typename T = SessionItem>
T *	topItem () const
	Returns first item in list of topItems. More...
template<typename T = SessionItem>
QVector< T * >	topItems () const
template<typename T = SessionItem>
QVector< T * >	topItems (std::function< bool(const T &)> accept) const
virtual void	writeTo (QXmlStreamWriter *writer)

Protected Member Functions
void	setRootItem (SessionItem *root)

Private Attributes
QString	m_dragged_item_type
QString	m_model_tag
SessionItem *	m_root_item

Friends
class	SessionItem

Constructor & Destructor Documentation

SessionModel()

SessionModel::SessionModel ( QString  model_tag, QObject *  parent = nullptr  )

explicit

Definition at line 49 of file SessionModel.cpp.

    : QAbstractItemModel(parent)
    , m_model_tag(std::move(model_tag))
{
    createRootItem();
}

References createRootItem().

Here is the call graph for this function:

~SessionModel()

SessionModel::~SessionModel ( )

override

Definition at line 64 of file SessionModel.cpp.

{
    delete m_root_item;
}

References m_root_item.

Member Function Documentation

acceptableDefaultItemTypes()

QVector< QString > SessionModel::acceptableDefaultItemTypes

(

const QModelIndex &

parent

)

const

Definition at line 310 of file SessionModel.cpp.

{
    QVector<QString> result;
    if (SessionItem* parent_item = itemForIndex(parent))
        result = parent_item->acceptableDefaultItemTypes();
 
    return result;
}

References itemForIndex(), and parent().

Referenced by canDropMimeData(), and flags().

Here is the call graph for this function:

canDropMimeData()

bool SessionModel::canDropMimeData ( const QMimeData *  data, Qt::DropAction  action, int  row, int  column, const QModelIndex &  parent  ) const

override

Definition at line 213 of file SessionModel.cpp.

{
    Q_UNUSED(row);
 
    if (action == Qt::IgnoreAction)
        return true;
    if (action != Qt::MoveAction || column > 0 || !data
        || !data->hasFormat(GUI::Session::XML::ItemMimeType))
        return false;
    if (!parent.isValid())
        return true;
    QVector<QString> acceptable_child_items = acceptableDefaultItemTypes(parent);
    QByteArray xml_data = qUncompress(data->data(GUI::Session::XML::ItemMimeType));
    QXmlStreamReader reader(xml_data);
    while (!reader.atEnd()) {
        reader.readNext();
        if (reader.isStartElement()) {
            if (reader.name() == GUI::Session::XML::ItemTag) {
                const QString model_type =
                    reader.attributes().value(GUI::Session::XML::ModelTypeAttribute).toString();
                return acceptable_child_items.contains(model_type);
            }
        }
    }
    return false;
}

References acceptableDefaultItemTypes(), data(), GUI::Session::XML::ItemMimeType, GUI::Session::XML::ItemTag(), GUI::Session::XML::ModelTypeAttribute(), and parent().

Referenced by dropMimeData().

Here is the call graph for this function:

clear()

void SessionModel::clear ( )

virtual

Reimplemented in JobModel, and MaskItems.

Definition at line 319 of file SessionModel.cpp.

{
    beginResetModel();
    delete m_root_item;
    createRootItem();
    endResetModel();
}

References createRootItem(), and m_root_item.

Referenced by MaskItems::clear(), JobModel::clear(), ApplicationModels::readFrom(), and readFrom().

Here is the call graph for this function:

columnCount()

int SessionModel::columnCount ( const QModelIndex &  parent ) const

override

Definition at line 134 of file SessionModel.cpp.

{
    if (parent.isValid() && parent.column() != 0)
        return 0;
    return SessionFlags::MAX_COLUMNS;
}

References SessionFlags::MAX_COLUMNS, and parent().

Referenced by data(), and index().

Here is the call graph for this function:

copy()

SessionItem * SessionModel::copy	(	const SessionItem *	item_to_copy,
		SessionItem *	new_parent = nullptr,
		const QString &	tag = ""
	)

Copy given item to the new_parent at given row. Item intended for copying can belong to another model and it will remain intact. Returns pointer to the new child.

Definition at line 395 of file SessionModel.cpp.

{
    if (!new_parent)
        new_parent = m_root_item;
 
    const QString tagName = tag.isEmpty() ? new_parent->defaultTag() : tag;
 
    QByteArray xml_data;
    QXmlStreamWriter writer(&xml_data);
    GUI::Session::XML::writeItemAndChildItems(&writer, item_to_copy);
 
    QXmlStreamReader reader(xml_data);
    GUI::Session::XML::readItems(&reader, new_parent, tagName);
 
    return new_parent->getItems(tagName).back();
}

References SessionItem::defaultTag(), SessionItem::getItems(), m_root_item, GUI::Session::XML::readItems(), and GUI::Session::XML::writeItemAndChildItems().

Referenced by copyItem().

Here is the call graph for this function:

copyItem()

template<typename T >

T * SessionModel::copyItem	(	const T *	item_to_copy,
		SessionItem *	new_parent = nullptr,
		const QString &	tag = ""
	)

Definition at line 149 of file SessionModel.h.

{
    return static_cast<T*>(copy(item_to_copy, new_parent, tag));
}

References copy().

Referenced by MaskItems::copy(), and JobItem::copyRealDataIntoJob().

Here is the call graph for this function:

createRootItem()

void SessionModel::createRootItem

(

)

Definition at line 56 of file SessionModel.cpp.

{
    m_root_item = new SessionItem("ROOT_ITEM");
    m_root_item->setModel(this);
    m_root_item->registerTag("rootTag");
    m_root_item->setDefaultTag("rootTag");
}

References m_root_item, SessionItem::registerTag(), SessionItem, and SessionItem::setModel().

Referenced by SessionModel(), and clear().

Here is the call graph for this function:

data()

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

override

Definition at line 88 of file SessionModel.cpp.

{
    ASSERT(m_root_item);
    if (!index.isValid() || index.column() < 0 || index.column() >= columnCount(QModelIndex()))
        return {};
    if (SessionItem* item = itemForIndex(index)) {
        if (role == Qt::DisplayRole || role == Qt::EditRole) {
            if (index.column() == SessionFlags::ITEM_VALUE)
                return item->value();
            if (index.column() == SessionFlags::ITEM_NAME)
                return item->itemName();
        } else if (role == Qt::ToolTipRole)
            return toolTipRole(*item, index.column());
        else if (role == Qt::ForegroundRole)
            return item->isEnabled() ? QVariant() : QColor(Qt::gray);
        else if (role == Qt::CheckStateRole && index.column() == SessionFlags::ITEM_VALUE) {
            if (item->value().type() == QVariant::Bool)
                return item->value().toBool() ? Qt::Checked : Qt::Unchecked;
        } else
            return item->roleProperty(role);
    }
    return {};
}

References columnCount(), index(), SessionFlags::ITEM_NAME, SessionFlags::ITEM_VALUE, itemForIndex(), SessionItem::itemName(), m_root_item, and SessionItem::value().

Referenced by canDropMimeData(), and dropMimeData().

Here is the call graph for this function:

dropMimeData()

bool SessionModel::dropMimeData ( const QMimeData *  data, Qt::DropAction  action, int  row, int  column, const QModelIndex &  parent  )

override

Definition at line 241 of file SessionModel.cpp.

{
    if (action == Qt::IgnoreAction)
        return true;
    if (action != Qt::MoveAction || column > 0 || !data
        || !data->hasFormat(GUI::Session::XML::ItemMimeType))
        return false;
    if (!canDropMimeData(data, action, row, column, parent))
        return false;
    if (SessionItem* item = itemForIndex(parent)) {
        QByteArray xml_data = qUncompress(data->data(GUI::Session::XML::ItemMimeType));
        QXmlStreamReader reader(xml_data);
        if (row == -1)
            row = item->numberOfChildren();
        beginInsertRows(parent, row, row);
        // this code block is currently not in use. The row parameter of the reader is removed
        // SessionReader::readItems(&reader, item, row);
        endInsertRows();
        return true;
    }
    return false;
}

References canDropMimeData(), data(), itemForIndex(), GUI::Session::XML::ItemMimeType, SessionItem::numberOfChildren(), and parent().

Here is the call graph for this function:

flags()

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

override

Definition at line 71 of file SessionModel.cpp.

{
    Qt::ItemFlags result_flags = QAbstractItemModel::flags(index);
    if (index.isValid()) {
        result_flags |= Qt::ItemIsSelectable | Qt::ItemIsEnabled | Qt::ItemIsDragEnabled;
        SessionItem* item = itemForIndex(index);
        if (index.column() == SessionFlags::ITEM_VALUE && item->value().isValid()
            && item->isEditable() && item->isEnabled())
            result_flags |= Qt::ItemIsEditable;
        QVector<QString> acceptable_child_items = acceptableDefaultItemTypes(index);
        if (acceptable_child_items.contains(m_dragged_item_type))
            result_flags |= Qt::ItemIsDropEnabled;
    } else
        result_flags |= Qt::ItemIsDropEnabled;
    return result_flags;
}

References acceptableDefaultItemTypes(), index(), SessionItem::isEditable(), SessionItem::isEnabled(), SessionFlags::ITEM_VALUE, itemForIndex(), m_dragged_item_type, and SessionItem::value().

Here is the call graph for this function:

getModelTag()

QString SessionModel::getModelTag ( ) const

inline

Definition at line 202 of file SessionModel.h.

{
    return m_model_tag;
}

References m_model_tag.

Referenced by ApplicationModels::readFrom(), GUI::Session::XML::readItems(), and GUI::Session::XML::writeModel().

headerData()

QVariant SessionModel::headerData ( int  section, Qt::Orientation  orientation, int  role  ) const

override

Definition at line 112 of file SessionModel.cpp.

{
    if (orientation != Qt::Horizontal || role != Qt::DisplayRole)
        return {};
    switch (section) {
    case SessionFlags::ITEM_NAME:
        return "Name";
    case SessionFlags::ITEM_VALUE:
        return "Value";
    default:
        return {};
    }
}

References SessionFlags::ITEM_NAME, and SessionFlags::ITEM_VALUE.

index()

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

override

Definition at line 141 of file SessionModel.cpp.

{
    ASSERT(m_root_item);
    if (row < 0 || column < 0 || column >= columnCount(QModelIndex())
        || (parent.isValid() && parent.column() != 0))
        return QModelIndex();
 
    SessionItem* parent_item = itemForIndex(parent);
 
    if (SessionItem* item = parent_item->childAt(row))
        return createIndex(row, column, item);
    return QModelIndex();
}

References SessionItem::childAt(), columnCount(), itemForIndex(), m_root_item, and parent().

Referenced by MaskResultsPresenter::createMaskPresentation(), data(), MaskGraphicsScene::deleteViews(), flags(), MaskItems::insertMask(), GUI::Model::Path::isValidItem(), itemForIndex(), ModelMapper::onBeginRemoveRows(), ModelMapper::onRowRemoved(), MaskGraphicsScene::onRowsAboutToBeRemoved(), ItemStackWidget::onRowsAboutToBeRemoved(), ModelMapper::onRowsInserted(), removeItem(), setData(), MaskGraphicsScene::setItemName(), MaskGraphicsScene::setZValues(), topItems(), and MaskGraphicsScene::updateViews().

Here is the call graph for this function:

indexOfItem()

QModelIndex SessionModel::indexOfItem

(

SessionItem *

item

)

const

Definition at line 265 of file SessionModel.cpp.

{
    if (!item || item == m_root_item || !item->parentItem())
        return QModelIndex();
    SessionItem* parent_item = item->parentItem();
    int row = parent_item->rowOfChild(item);
    return createIndex(row, 0, item);
}

References m_root_item, SessionItem::parentItem(), and SessionItem::rowOfChild().

Referenced by MaskGraphicsScene::cancelCurrentDrawing(), MaskEditorActions::changeMaskStackingOrder(), SessionItem::emitDataChanged(), SessionItem::index(), MaskGraphicsScene::onSceneSelectionChanged(), MaskGraphicsScene::onSessionSelectionChanged(), MaskGraphicsScene::processLineItem(), MaskGraphicsScene::processPolygonItem(), and removeItem().

Here is the call graph for this function:

initFrom()

void SessionModel::initFrom ( SessionModel *  model, SessionItem *  parent  )

virtual

Definition at line 413 of file SessionModel.cpp.

{
    QByteArray byte_array;
    QXmlStreamWriter writer(&byte_array);
    writer.setAutoFormatting(true);
 
    model->writeTo(&writer);
 
    QXmlStreamReader reader(byte_array);
 
    while (!reader.atEnd()) {
        reader.readNext();
        if (reader.isStartElement())
            readFrom(&reader);
    }
}

References readFrom(), and writeTo().

Here is the call graph for this function:

insertItem() [1/2]

template<typename T >

T * SessionModel::insertItem	(	const QModelIndex &	parent,
		int	row = -1,
		QString	tag = ""
	)

Definition at line 143 of file SessionModel.h.

{
    return insertItem<T>(itemForIndex(parent), row, tag);
}

References itemForIndex(), and parent().

Here is the call graph for this function:

insertItem() [2/2]

template<typename T >

T * SessionModel::insertItem	(	SessionItem *	parent = nullptr,
		int	row = -1,
		QString	tag = ""
	)

Definition at line 137 of file SessionModel.h.

{
    return dynamic_cast<T*>(insertNewItem(T().modelType(), parent, row, tag));
}

References insertNewItem(), SessionItem::modelType(), and parent().

Referenced by IntensityDataFFTPresenter::IntensityDataFFTPresenter(), FitParameterItem::addLink(), JobItem::createDataViewItem(), FitComparison1DViewController::createDiffViewItem(), FitParameterContainerItem::createFitParameter(), FitSuiteItem::createFitParametersContainer(), JobItem::createFitSuiteItem(), FitSuiteItem::createMinimizerContainer(), Data1DViewItem::createPropertyContainerItem(), JobItem::createRealDataItem(), IntensityDataItem::getOrCreateMaskContainerItem(), IntensityDataItem::getOrCreateProjectionContainerItem(), RealDataItem::initDataItem(), ProjectionsEditorCanvas::onEnteringColorMap(), MaskGraphicsScene::processHorizontalLineItem(), MaskGraphicsScene::processMaskAllItem(), MaskGraphicsScene::processPolygonItem(), MaskGraphicsScene::processVerticalLineItem(), and JobItem::setDataType().

Here is the call graph for this function:

insertNewItem() [1/2]

SessionItem * SessionModel::insertNewItem	(	QString	model_type,
		const QModelIndex &	parent_item,
		int	row = -1,
		QString	tag = ""
	)

Definition at line 297 of file SessionModel.cpp.

{
    return insertNewItem(model_type, itemForIndex(parent_item), row, tag);
}

References insertNewItem(), and itemForIndex().

Here is the call graph for this function:

insertNewItem() [2/2]

SessionItem * SessionModel::insertNewItem	(	QString	model_type,
		SessionItem *	parent_item = nullptr,
		int	row = -1,
		QString	tag = ""
	)

Definition at line 274 of file SessionModel.cpp.

{
    ASSERT(m_root_item);
    if (!parent_item)
        parent_item = m_root_item;
    if (row > parent_item->numberOfChildren())
        return nullptr;
    if (parent_item != m_root_item) {
        if (tag.isEmpty())
            tag = parent_item->defaultTag();
        if (!parent_item->sessionItemTags()->isValid(tag, model_type))
            return nullptr;
    }
 
    SessionItem* new_item = GUI::Model::ItemFactory::CreateItem(model_type);
    ASSERT(new_item);
 
    parent_item->insertChild(row, new_item, tag);
 
    return new_item;
}

References GUI::Model::ItemFactory::CreateItem(), SessionItem::defaultTag(), SessionItem::insertChild(), SessionItemTags::isValid(), m_root_item, SessionItem::numberOfChildren(), and SessionItem::sessionItemTags().

Referenced by insertItem(), insertNewItem(), and MaskGraphicsScene::processRectangleShapeItem().

Here is the call graph for this function:

itemForIndex()

SessionItem * SessionModel::itemForIndex

(

const QModelIndex &

index

)

const

Definition at line 327 of file SessionModel.cpp.

{
    if (index.isValid())
        if (auto* item = static_cast<SessionItem*>(index.internalPointer()))
            return item;
 
    return m_root_item;
}

References index(), and m_root_item.

Referenced by acceptableDefaultItemTypes(), MaskEditorActions::changeMaskStackingOrder(), MaskResultsPresenter::createMaskPresentation(), data(), DataProperties::dataItem(), MaskGraphicsScene::deleteViews(), dropMimeData(), flags(), index(), insertItem(), insertNewItem(), MaskEditorActions::isSendToBackPossible(), GUI::Model::Path::isValidItem(), MaskEditorPropertyPanel::maskItemForIndex(), mimeData(), ModelMapper::onBeginRemoveRows(), ModelMapper::onDataChanged(), ModelMapper::onRowRemoved(), ItemStackWidget::onRowsAboutToBeRemoved(), ModelMapper::onRowsInserted(), FitParameterModel::onSourceDataChanged(), MaskEditorActions::onToggleMaskValueAction(), parent(), removeRows(), rowCount(), setData(), MaskGraphicsScene::setItemName(), MaskEditor::setMaskContext(), MaskGraphicsScene::setMaskContext(), MaskGraphicsScene::setZValues(), SessionDecorationModel::textColor(), topItems(), MaskGraphicsScene::updateScene(), and MaskGraphicsScene::updateViews().

Here is the call graph for this function:

mimeData()

QMimeData * SessionModel::mimeData ( const QModelIndexList &  indices ) const

override

Definition at line 197 of file SessionModel.cpp.

{
    if (indices.count() != 2)
        return nullptr;
 
    if (SessionItem* item = itemForIndex(indices.at(0))) {
        auto* mime_data = new QMimeData;
        QByteArray xml_data;
        QXmlStreamWriter writer(&xml_data);
        GUI::Session::XML::writeItemAndChildItems(&writer, item);
        mime_data->setData(GUI::Session::XML::ItemMimeType, qCompress(xml_data, MaxCompression));
        return mime_data;
    }
    return nullptr;
}

References itemForIndex(), GUI::Session::XML::ItemMimeType, and GUI::Session::XML::writeItemAndChildItems().

Here is the call graph for this function:

mimeTypes()

QStringList SessionModel::mimeTypes ( ) const

override

Definition at line 192 of file SessionModel.cpp.

{
    return QStringList() << GUI::Session::XML::ItemMimeType;
}

References GUI::Session::XML::ItemMimeType.

moveItem()

SessionItem * SessionModel::moveItem	(	SessionItem *	item,
		SessionItem *	new_parent = nullptr,
		int	row = -1,
		const QString &	tag = ""
	)

Move given parameterized item to the new_parent at given row. If new_parent is not defined, use root_item as a new parent.

Definition at line 360 of file SessionModel.cpp.

{
    if (!new_parent)
        new_parent = m_root_item;
 
    const QString tagName = tag.isEmpty() ? new_parent->defaultTag() : tag;
 
    if (!new_parent->sessionItemTags()->isValid(tagName, item->modelType()))
        return nullptr;
 
    if (item->parentItem() == new_parent) {
        // take care of indexes when moving item within same parent
        int previousIndex = item->parentItem()->getItems(tagName).indexOf(item);
        if (row == previousIndex)
            return item;
        if (previousIndex >= 0 && row > previousIndex)
            row--;
    }
 
    if (new_parent->sessionItemTags()->maximumReached(tagName)) {
        SessionItem* prev = new_parent->takeItem(0, tagName);
        m_root_item->insertChild(-1, prev);
    }
 
    // removing item from previous parent and inserting to the new one
    item->parentItem()->takeRow(item->parentItem()->rowOfChild(item));
    new_parent->insertChild(row, item, tagName);
 
    return item;
}

References SessionItem::defaultTag(), SessionItem::getItems(), SessionItem::insertChild(), SessionItemTags::isValid(), m_root_item, SessionItemTags::maximumReached(), SessionItem::modelType(), SessionItem::parentItem(), SessionItem::rowOfChild(), SessionItem::sessionItemTags(), SessionItem::takeItem(), and SessionItem::takeRow().

Referenced by MaskEditorActions::changeMaskStackingOrder().

Here is the call graph for this function:

nonXMLItems()

QVector< SessionItem * > SessionModel::nonXMLItems ( ) const

virtual

Reimplemented in RealDataModel, and JobModel.

Definition at line 436 of file SessionModel.cpp.

{
    return QVector<SessionItem*>();
}

parent()

QModelIndex SessionModel::parent ( const QModelIndex &  child ) const

override

Definition at line 155 of file SessionModel.cpp.

{
    if (!child.isValid())
        return QModelIndex();
 
    if (SessionItem* child_item = itemForIndex(child)) {
        if (SessionItem* parent_item = child_item->parentItem()) {
            if (parent_item == m_root_item)
                return QModelIndex();
            return createIndex(parent_item->parentRow(), 0, parent_item);
        }
    }
    return QModelIndex();
}

References itemForIndex(), m_root_item, and SessionItem::parentItem().

Referenced by acceptableDefaultItemTypes(), canDropMimeData(), columnCount(), dropMimeData(), index(), insertItem(), RealDataModel::onRowsChange(), removeRows(), and rowCount().

Here is the call graph for this function:

readFrom()

void SessionModel::readFrom ( QXmlStreamReader *  reader, MessageService *  messageService = nullptr  )

virtual

Reimplemented in RealDataModel, and JobModel.

Definition at line 336 of file SessionModel.cpp.

{
    ASSERT(reader);
 
    if (reader->name() != m_model_tag)
        throw Error("SessionModel::readFrom() -> Format error in p1");
 
    beginResetModel();
    clear();
 
    GUI::Session::XML::readItems(reader, m_root_item, QString(), messageService);
    if (reader->hasError())
        throw Error(reader->errorString());
    endResetModel();
}

References clear(), Error, m_model_tag, m_root_item, and GUI::Session::XML::readItems().

Referenced by initFrom(), JobModel::readFrom(), and RealDataModel::readFrom().

Here is the call graph for this function:

removeItem()

void SessionModel::removeItem

(

SessionItem *

item

)

Definition at line 303 of file SessionModel.cpp.

{
    QModelIndex index = indexOfItem(item);
    if (index.isValid())
        removeRows(index.row(), 1, index.parent());
}

References index(), indexOfItem(), and removeRows().

Here is the call graph for this function:

removeRows()

bool SessionModel::removeRows ( int  row, int  count, const QModelIndex &  parent  )

override

Definition at line 183 of file SessionModel.cpp.

{
    ASSERT(m_root_item);
    SessionItem* item = parent.isValid() ? itemForIndex(parent) : m_root_item;
    for (int i = 0; i < count; ++i)
        delete item->takeRow(row);
    return true;
}

References itemForIndex(), m_root_item, parent(), and SessionItem::takeRow().

Referenced by MaskGraphicsScene::cancelCurrentDrawing(), MaskContainerItem::clear(), ProjectionsEditorActions::onDeleteAction(), MaskEditorActions::onDeleteMaskAction(), removeItem(), and JobModel::removeJob().

Here is the call graph for this function:

rootItem()

SessionItem * SessionModel::rootItem

(

)

const

Definition at line 430 of file SessionModel.cpp.

{
    ASSERT(m_root_item);
    return m_root_item;
}

References m_root_item.

Referenced by ModelMapper::nestlingDepth().

rowCount()

int SessionModel::rowCount ( const QModelIndex &  parent ) const

override

Definition at line 126 of file SessionModel.cpp.

{
    if (parent.isValid() && parent.column() != 0)
        return 0;
    SessionItem* parent_item = itemForIndex(parent);
    return parent_item ? parent_item->numberOfChildren() : 0;
}

References itemForIndex(), SessionItem::numberOfChildren(), and parent().

Referenced by MaskResultsPresenter::createMaskPresentation(), MaskGraphicsScene::deleteViews(), GUI::Model::Path::isValidItem(), MaskGraphicsScene::setItemName(), MaskGraphicsScene::setZValues(), topItems(), and MaskGraphicsScene::updateViews().

Here is the call graph for this function:

setData()

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

override

Definition at line 170 of file SessionModel.cpp.

{
    if (!index.isValid())
        return false;
 
    QModelIndex dataIndex = index;
    if (SessionItem* item = itemForIndex(dataIndex))
        if (item->setRoleProperty(role, value))
            return true;
 
    return false;
}

References index(), itemForIndex(), and SessionItem::setRoleProperty().

Here is the call graph for this function:

setDraggedItemType()

void SessionModel::setDraggedItemType ( const QString &  type )

inline

Definition at line 207 of file SessionModel.h.

{
    m_dragged_item_type = type;
}

References m_dragged_item_type.

setRootItem()

void SessionModel::setRootItem ( SessionItem *  root )

inlineprotected

Definition at line 128 of file SessionModel.h.

{ m_root_item = root; }

References m_root_item.

supportedDragActions()

Qt::DropActions SessionModel::supportedDragActions ( ) const

inlineoverride

Definition at line 192 of file SessionModel.h.

{
    return Qt::MoveAction;
}

supportedDropActions()

Qt::DropActions SessionModel::supportedDropActions ( ) const

inlineoverride

Definition at line 197 of file SessionModel.h.

{
    return Qt::MoveAction;
}

topItem()

template<typename T >

T * SessionModel::topItem

Returns first item in list of topItems.

Definition at line 155 of file SessionModel.h.

{
    auto items = topItems<T>();
    return items.isEmpty() ? nullptr : items.front();
}

References SessionItem::items().

Here is the call graph for this function:

topItems() [1/2]

template<typename T >

QVector< T * > SessionModel::topItems

Definition at line 162 of file SessionModel.h.

{
    QVector<T*> result;
 
    QModelIndex parentIndex;
    for (int i_row = 0; i_row < rowCount(parentIndex); ++i_row) {
        QModelIndex itemIndex = index(i_row, 0, parentIndex);
        if (auto item = dynamic_cast<T*>(itemForIndex(itemIndex)))
            result.push_back(item);
    }
 
    return result;
}

References index(), SessionItem::item(), itemForIndex(), and rowCount().

Here is the call graph for this function:

topItems() [2/2]

template<typename T >

QVector< T * > SessionModel::topItems

(

std::function< bool(const T &)>

accept

)

const

Definition at line 177 of file SessionModel.h.

{
    QVector<T*> result;
 
    QModelIndex parentIndex;
    for (int i_row = 0; i_row < rowCount(parentIndex); ++i_row) {
        QModelIndex itemIndex = index(i_row, 0, parentIndex);
        if (auto item = dynamic_cast<T*>(itemForIndex(itemIndex)))
            if (accept(*item))
                result.push_back(item);
    }
 
    return result;
}

References index(), SessionItem::item(), itemForIndex(), and rowCount().

Here is the call graph for this function:

writeTo()

void SessionModel::writeTo ( QXmlStreamWriter *  writer )

virtual

Definition at line 352 of file SessionModel.cpp.

{
    GUI::Session::XML::writeModel(writer, m_root_item);
}

References m_root_item, and GUI::Session::XML::writeModel().

Referenced by initFrom(), and ApplicationModels::writeTo().

Here is the call graph for this function:

Friends And Related Function Documentation

SessionItem

friend class SessionItem

friend

Definition at line 44 of file SessionModel.h.

Referenced by createRootItem().

Member Data Documentation

m_dragged_item_type

QString SessionModel::m_dragged_item_type

private

Definition at line 132 of file SessionModel.h.

Referenced by flags(), and setDraggedItemType().

m_model_tag

QString SessionModel::m_model_tag

private

Definition at line 133 of file SessionModel.h.

Referenced by getModelTag(), and readFrom().

m_root_item

SessionItem* SessionModel::m_root_item

private

Definition at line 131 of file SessionModel.h.

Referenced by ~SessionModel(), clear(), copy(), createRootItem(), data(), index(), indexOfItem(), insertNewItem(), itemForIndex(), moveItem(), parent(), readFrom(), removeRows(), rootItem(), setRootItem(), and writeTo().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Model/SessionModel.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Model/SessionModel.cpp