StoryboardCommentModel Class Reference

#include <CommentModel.h>

Inheritance diagram for StoryboardCommentModel:

Signals
void	sigCommentListChanged ()
	Emitted whenever m_items is changed. it is used to keep the StoryboardItemList in KisDocument in sync with m_items.

Public Member Functions
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) 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
QVector< StoryboardComment >	getData ()
	returns a list of comments
bool	insertRows (int position, int rows, const QModelIndex &index=QModelIndex()) override
QMimeData *	mimeData (const QModelIndexList &indexes) const override
QStringList	mimeTypes () const override
bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild) override
bool	removeRows (int position, int rows, const QModelIndex &index=QModelIndex()) override
void	resetData (QVector< StoryboardComment > list)
	resets m_commentList to list.
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override
	StoryboardCommentModel (QObject *parent=0)
Qt::DropActions	supportedDragActions () const override
Qt::DropActions	supportedDropActions () const override

Private Attributes
QVector< StoryboardComment >	m_commentList

Friends
class	StoryboardModel

Detailed Description

Definition at line 24 of file CommentModel.h.

Constructor & Destructor Documentation

StoryboardCommentModel()

StoryboardCommentModel::StoryboardCommentModel

(

QObject *

parent = 0

)

Definition at line 16 of file CommentModel.cpp.

        : QAbstractListModel(parent) 
{
    //initialize variables
}

Member Function Documentation

data()

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

override

Definition at line 28 of file CommentModel.cpp.

{
    
    if (!index.isValid()) {
        return QVariant();
    }
    if (index.row() >= m_commentList.size()) {
        return QVariant();
    }
    if (role == Qt::DisplayRole || role == Qt::EditRole) {
        return m_commentList.at(index.row()).name;
    }
    if (role == Qt::DecorationRole) {
        if (m_commentList.at(index.row()).visibility) {
            return KisIconUtils::loadIcon("visible");
        }
        else {
            return KisIconUtils::loadIcon("novisible");
        }
    }
    return QVariant();
    
}

References KisIconUtils::loadIcon(), and m_commentList.

dropMimeData()

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

override

Definition at line 194 of file CommentModel.cpp.

{
    if (action == Qt::IgnoreAction) {
        return false;
    }
    if (action == Qt::MoveAction && data->hasFormat("application/x-krita-storyboard")) {
        QByteArray bytes = data->data("application/x-krita-storyboard");
        QDataStream stream(&bytes, QIODevice::ReadOnly);
 
        if (parent.isValid()) {
            return false;
        }
        int sourceRow;
        QModelIndexList moveRowIndexes;
        while (!stream.atEnd()) {
            stream >> sourceRow;
            QModelIndex index = createIndex(sourceRow, 0);
            moveRowIndexes.append(index);
        }
        moveRows(QModelIndex(), moveRowIndexes.at(0).row(), moveRowIndexes.count(), parent, row);
 
        //returning true deletes the source row
        return false;
    }
    return false;
}

References data(), and moveRows().

flags()

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

override

Definition at line 93 of file CommentModel.cpp.

{
    if (!index.isValid()) {
        return Qt::ItemIsDropEnabled;
    }
    return Qt::ItemIsDragEnabled | Qt::ItemIsSelectable |
           Qt::ItemIsEditable | Qt::ItemIsEnabled ;
}

getData()

QVector< StoryboardComment > StoryboardCommentModel::getData

(

)

returns a list of comments

Returns

m_commentList

Definition at line 240 of file CommentModel.cpp.

{
    return m_commentList;
}

References m_commentList.

insertRows()

bool StoryboardCommentModel::insertRows ( int position, int rows, const QModelIndex & index = QModelIndex() )

override

Definition at line 102 of file CommentModel.cpp.

{
    beginInsertRows(QModelIndex(), position, position+rows-1);
 
    for (int row = 0; row < rows; ++row) {
        StoryboardComment newcomment;
        newcomment.name = "Comment";
        newcomment.visibility = true;
 
        if (position < 0 || position > m_commentList.size()) {
            return false;
        }
        m_commentList.insert(position, newcomment);
    }
 
    endInsertRows();
    Q_EMIT sigCommentListChanged();
    return true;
}

References m_commentList, StoryboardComment::name, sigCommentListChanged(), and StoryboardComment::visibility.

mimeData()

QMimeData * StoryboardCommentModel::mimeData ( const QModelIndexList & indexes ) const

override

Definition at line 175 of file CommentModel.cpp.

{
    QMimeData *mimeData = new QMimeData();
    QByteArray encodeData;
 
    QDataStream stream(&encodeData, QIODevice::WriteOnly);
 
    //take the row number of the index where drag started
    foreach (QModelIndex index, indexes) {
        if (index.isValid()) {
            int row = index.row();
            stream << row;
        }
    }
 
    mimeData->setData("application/x-krita-storyboard", encodeData); //default mimetype
    return mimeData;
}

References encodeData(), and mimeData().

mimeTypes()

QStringList StoryboardCommentModel::mimeTypes ( ) const

override

Definition at line 168 of file CommentModel.cpp.

{
    QStringList types;
    types << QLatin1String("application/x-krita-storyboard");
    return types;
}

moveRows()

bool StoryboardCommentModel::moveRows ( const QModelIndex & sourceParent, int sourceRow, int count, const QModelIndex & destinationParent, int destinationChild )

override

Definition at line 140 of file CommentModel.cpp.

{
    if (destinationChild == sourceRow || destinationChild == sourceRow + 1) {
        return false;
    }
    if (destinationChild > sourceRow + count - 1) {
        //we adjust for the upward shift, see qt doc for why this is needed
        beginMoveRows(sourceParent, sourceRow, sourceRow + count - 1, destinationParent, destinationChild + count - 1);
        destinationChild = destinationChild - count;
    }
    else {
        beginMoveRows(sourceParent, sourceRow, sourceRow + count - 1, destinationParent, destinationChild);
    }
    for (int row = 0; row < count; row++) {
        if (sourceRow < 0 || sourceRow >= m_commentList.size()) {
            return false;
        }
        if (destinationChild + row < 0 || destinationChild + row >= m_commentList.size()) {
            return false;
        }
        m_commentList.move(sourceRow, destinationChild + row);
    }
    endMoveRows();
    Q_EMIT sigCommentListChanged();
    return true;
}

References m_commentList, and sigCommentListChanged().

removeRows()

bool StoryboardCommentModel::removeRows ( int position, int rows, const QModelIndex & index = QModelIndex() )

override

Definition at line 122 of file CommentModel.cpp.

{
    if (rows <= 0) {
        return false;
    }
    beginRemoveRows(QModelIndex(), position, position+rows-1);
 
    for (int row = 0; row < rows; ++row) {
        if (position < 0 || position >= m_commentList.size()) {
            return false;
        }
        m_commentList.removeAt(position);
    }
    endRemoveRows();
    Q_EMIT sigCommentListChanged();
    return true;
}

References m_commentList, and sigCommentListChanged().

resetData()

void StoryboardCommentModel::resetData

(

QVector< StoryboardComment >

list

)

resets m_commentList to list.

Parameters

list	The new list.

Definition at line 232 of file CommentModel.cpp.

{
    beginResetModel();
    m_commentList = list;
    Q_EMIT dataChanged(QModelIndex(), QModelIndex());
    endResetModel();
}

References m_commentList.

rowCount()

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

override

Definition at line 22 of file CommentModel.cpp.

{
    if (parent.isValid()) return 0;
   return m_commentList.count();
}

References m_commentList.

setData()

bool StoryboardCommentModel::setData ( const QModelIndex & index, const QVariant & value, int role = Qt::EditRole )

override

Definition at line 52 of file CommentModel.cpp.

{
    if (index.isValid() && (role == Qt::EditRole || role == Qt::DisplayRole)) {
        // POST KRITA/5.0 TODO -- we should be storing this as a map, not an array!
        // We only want 1 comment field per comment track title. A data change would
        // be appropriate here.
        QStringList nameList;
        Q_FOREACH(const StoryboardComment& comment, m_commentList) {
            nameList << comment.name;
        }
 
 
        QString desiredName = value.toString();
        int splitPoint = desiredName.length();
        while (desiredName.at(splitPoint - 1).isDigit()) {
            splitPoint--;
        }
 
        const QString prefix = desiredName.left(splitPoint);
        int existingNames = prefix.mid(splitPoint).toInt();
 
        while(nameList.contains(desiredName)) {
            existingNames++;
            desiredName = prefix + QString::number(existingNames);
        }
 
        m_commentList[index.row()].name = desiredName;
        Q_EMIT dataChanged(index, index);
        Q_EMIT sigCommentListChanged();
        return true;
    }
    
    if (index.isValid() && role == Qt::DecorationRole) {
        m_commentList[index.row()].visibility = !m_commentList[index.row()].visibility;
        Q_EMIT dataChanged(index, index);
        Q_EMIT sigCommentListChanged();
        return true;
    }
    return false;
}

References m_commentList, StoryboardComment::name, sigCommentListChanged(), and value().

sigCommentListChanged

void StoryboardCommentModel::sigCommentListChanged ( )

signal

Emitted whenever m_items is changed. it is used to keep the StoryboardItemList in KisDocument in sync with m_items.

supportedDragActions()

Qt::DropActions StoryboardCommentModel::supportedDragActions ( ) const

override

Definition at line 227 of file CommentModel.cpp.

{
    return Qt::CopyAction | Qt::MoveAction;
}

supportedDropActions()

Qt::DropActions StoryboardCommentModel::supportedDropActions ( ) const

override

Definition at line 222 of file CommentModel.cpp.

{
    return Qt::CopyAction | Qt::MoveAction;
}

Friends And Related Symbol Documentation

StoryboardModel

friend class StoryboardModel

friend

Definition at line 72 of file CommentModel.h.

Member Data Documentation

m_commentList

QVector<StoryboardComment> StoryboardCommentModel::m_commentList

private

Definition at line 71 of file CommentModel.h.

---

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

• plugins/dockers/storyboarddocker/CommentModel.h
• plugins/dockers/storyboarddocker/CommentModel.cpp