kis_abstract_canvas_widget.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2007 Boudewijn Rempt <boud@valdyas.org>, (C)
 * SPDX-FileCopyrightText: 2015 Michael Abrahams <miabraha@gmail.com>
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 */
#ifndef _KIS_ABSTRACT_CANVAS_WIDGET_
#define _KIS_ABSTRACT_CANVAS_WIDGET_
 
class QWidget;
class QRect;
class QPainter;
class QRect;
 
class KoToolProxy;
 
#include <kis_canvas_decoration.h>
 
class KisDisplayFilter;
class QBitArray;
class KoColorSpace;
class KisDisplayConfig;
 
#include "kis_types.h"
#include "kis_ui_types.h"
#include "KisWraparoundAxis.h"
 
class KisAbstractCanvasWidget
{
public:
    enum class BitDepthMode {
        Depth8Bit = 0,
        Depth10Bit
    };
 
public:
 
    KisAbstractCanvasWidget() {}
 
    virtual ~KisAbstractCanvasWidget() {}
 
    virtual QWidget * widget() = 0;
 
    virtual KoToolProxy * toolProxy() const = 0;
 
    virtual void drawDecorations(QPainter & gc, const QRect &updateWidgetRect) const = 0;
 
    virtual void addDecoration(KisCanvasDecorationSP deco) = 0;
    virtual void removeDecoration(const QString& id) = 0;
 
    virtual KisCanvasDecorationSP decoration(const QString& id) const = 0;
 
    virtual void setDecorations(const QList<KisCanvasDecorationSP> &) = 0;
 
    virtual QList<KisCanvasDecorationSP> decorations() const = 0;
 
    virtual void setDisplayFilter(QSharedPointer<KisDisplayFilter> displayFilter) = 0;
 
    virtual void notifyImageColorSpaceChanged(const KoColorSpace *cs) = 0;
 
    virtual void setWrapAroundViewingMode(bool value) = 0;
    virtual bool wrapAroundViewingMode() const = 0;
 
    virtual void setWrapAroundViewingModeAxis(WrapAroundAxis value) = 0;
    virtual WrapAroundAxis wrapAroundViewingModeAxis() const = 0;
 
    // Called from KisCanvas2::channelSelectionChanged
    virtual void channelSelectionChanged(const QBitArray &channelFlags) = 0;
 
    virtual void setDisplayConfig(const KisDisplayConfig &config) = 0;
 
    // Called from KisCanvas2::finishResizingImage
    virtual void finishResizingImage(qint32 w, qint32 h) = 0;
 
    // Called from KisCanvas2::startUpdateProjection
    virtual KisUpdateInfoSP startUpdateCanvasProjection(const QRect & rc) = 0;
 
    // Called from KisCanvas2::updateCanvasProjection
    virtual QRect updateCanvasProjection(KisUpdateInfoSP info) = 0;
    virtual QVector<QRect> updateCanvasProjection(const QVector<KisUpdateInfoSP> &infoObjects) = 0;
 
    virtual void updateCanvasImage(const QRect &imageUpdateRect) = 0;
    virtual void updateCanvasDecorations(const QRect &decoUpdateRect) = 0;
 
    virtual bool isBusy() const = 0;
 
    virtual void setLodResetInProgress(bool value) = 0;
 
    virtual BitDepthMode currentBitDepthMode() const = 0;
 
    virtual QString currentBitDepthUserReport() const = 0;
};
 
#endif // _KIS_ABSTRACT_CANVAS_WIDGET_