KisUndoModel.h

Go to the documentation of this file.

/* This file is part of the KDE project
 * SPDX-FileCopyrightText: 2010 Matus Talcik <matus.talcik@gmail.com>
 *
 * SPDX-License-Identifier: LGPL-2.0-or-later
 */
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef KIS_UNDO_MODEL_H
#define KIS_UNDO_MODEL_H
#include <QAbstractItemModel>
 
#include <kundo2qstack.h>
#include <QItemSelectionModel>
#include <QIcon>
#include <QPointer>
 
#include <kundo2command.h>
 
#include "kis_types.h"
#include "kis_canvas2.h"
#include "KisViewManager.h"
#include "kis_image.h"
#include "kis_paint_device.h"
 
class KisUndoModel : public QAbstractItemModel
{
    Q_OBJECT
public:
    KisUndoModel(QObject *parent = 0);
 
    KUndo2QStack *stack() const;
 
    QModelIndex index(int row, int column,
    const QModelIndex &parent = QModelIndex()) const override;
    QModelIndex parent(const QModelIndex &child) const override;
    int rowCount(const QModelIndex &parent = QModelIndex()) const override;
    int columnCount(const QModelIndex &parent = QModelIndex()) const override;
    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
 
    QModelIndex selectedIndex() const;
    QItemSelectionModel *selectionModel() const;
 
    QString emptyLabel() const;
    void setEmptyLabel(const QString &label);
 
    void setCleanIcon(const QIcon &icon);
    QIcon cleanIcon() const;
 
    void setCanvas(KisCanvas2* canvas);
    bool checkMergedCommand(int index);
 
    // It's a bit weird to have "setDevicePixelRatio"
    //  in a model class, but it's needed for
    //  QImages inside, because there is no
    //  ItemDelegate for the items,
    //  so it's better to initialize QImages already
    //  devicePixelRatio-corrected.
    void setDevicePixelRatio(qreal devicePixelRatio);
 
public Q_SLOTS:
    void setStack(KUndo2QStack *stack);
    void addImage(int idx);
 
private Q_SLOTS:
    void stackChanged();
    void stackDestroyed(QObject *obj);
    void setStackCurrentIndex(const QModelIndex &index);
 
private:
    bool m_blockOutgoingHistoryChange {false};
    KUndo2QStack *m_stack {0};
    QItemSelectionModel *m_sel_model {0};
    QString m_empty_label;
    QIcon m_clean_icon;
    QPointer<KisCanvas2> m_canvas;
    QMap<const KUndo2Command*, QImage> m_imageMap;
    qreal m_devicePixelRatioF {1.0};
};
#endif