KisCanvasWidgetBase Class Reference

#include <kis_canvas_widget_base.h>

Inheritance diagram for KisCanvasWidgetBase:

Classes
struct	Private

Public Member Functions
void	addDecoration (KisCanvasDecorationSP deco) override
QColor	borderColor () const
KisCoordinatesConverter *	coordinatesConverter () const
BitDepthMode	currentBitDepthMode () const override
QString	currentBitDepthUserReport () const override
KisCanvasDecorationSP	decoration (const QString &id) const override
QList< KisCanvasDecorationSP >	decorations () const override
void	drawDecorations (QPainter &gc, const QRect &updateWidgetRect) const override
	KisCanvasWidgetBase (KisCanvas2 *canvas, KisCoordinatesConverter *coordinatesConverter)
void	notifyDecorationsWindowMinimized (bool minimized)
void	removeDecoration (const QString &id) override
void	setDecorations (const QList< KisCanvasDecorationSP > &) override
void	setWrapAroundViewingMode (bool value) override
void	setWrapAroundViewingModeAxis (WrapAroundAxis value) override
KoToolProxy *	toolProxy () const override
QVector< QRect >	updateCanvasProjection (const QVector< KisUpdateInfoSP > &infoObjects) override
virtual QVector< QRect >	updateCanvasProjection (const QVector< KisUpdateInfoSP > &infoObjects)=0
virtual QRect	updateCanvasProjection (KisUpdateInfoSP info)=0
	~KisCanvasWidgetBase () override
Public Member Functions inherited from KisAbstractCanvasWidget
virtual void	channelSelectionChanged (const QBitArray &channelFlags)=0
virtual void	finishResizingImage (qint32 w, qint32 h)=0
virtual bool	isBusy () const =0
	KisAbstractCanvasWidget ()
virtual void	notifyImageColorSpaceChanged (const KoColorSpace *cs)=0
	set/update the color space of the attached image
virtual void	setDisplayConfig (const KisDisplayConfig &config)=0
virtual void	setDisplayFilter (QSharedPointer< KisDisplayFilter > displayFilter)=0
	set the specified display filter on the canvas
virtual void	setLodResetInProgress (bool value)=0
virtual KisUpdateInfoSP	startUpdateCanvasProjection (const QRect &rc)=0
virtual void	updateCanvasDecorations (const QRect &decoUpdateRect)=0
virtual void	updateCanvasImage (const QRect &imageUpdateRect)=0
virtual QWidget *	widget ()=0
virtual bool	wrapAroundViewingMode () const =0
virtual WrapAroundAxis	wrapAroundViewingModeAxis () const =0
virtual	~KisAbstractCanvasWidget ()

Static Public Member Functions
static QImage	createCheckersImage (qint32 checkSize=-1)

Protected Member Functions
virtual bool	callFocusNextPrevChild (bool next)=0
	To be implemented by the derived canvas.
KisCanvas2 *	canvas () const
void	notifyConfigChanged ()
void	processFocusInEvent (QFocusEvent *event)
void	processFocusOutEvent (QFocusEvent *event)
void	processInputMethodEvent (QInputMethodEvent *event)
QVariant	processInputMethodQuery (Qt::InputMethodQuery query) const

Private Attributes
Private *const	m_d

Additional Inherited Members
Public Types inherited from KisAbstractCanvasWidget
enum class	BitDepthMode { Depth8Bit = 0 , Depth10Bit }

Detailed Description

Definition at line 27 of file kis_canvas_widget_base.h.

Constructor & Destructor Documentation

KisCanvasWidgetBase()

KisCanvasWidgetBase::KisCanvasWidgetBase	(	KisCanvas2 *	canvas,
		KisCoordinatesConverter *	coordinatesConverter )

Definition at line 56 of file kis_canvas_widget_base.cpp.

    : m_d(new Private(canvas, coordinatesConverter))
{
    m_d->blockMouseEvent.setSingleShot(true);
}

References KisCanvasWidgetBase::Private::blockMouseEvent, and m_d.

~KisCanvasWidgetBase()

KisCanvasWidgetBase::~KisCanvasWidgetBase ( )

override

Clear all the attached decoration. Otherwise they might decide to process some events or signals after the canvas has been destroyed

Definition at line 62 of file kis_canvas_widget_base.cpp.

{
    //5qDeleteAll(m_d->decorations);
    m_d->decorations.clear();
 
    delete m_d;
}

Member Function Documentation

addDecoration()

void KisCanvasWidgetBase::addDecoration ( KisCanvasDecorationSP deco )

overridevirtual

Implements KisAbstractCanvasWidget.

Definition at line 122 of file kis_canvas_widget_base.cpp.

{
    m_d->decorations.push_back(deco);
    std::stable_sort(m_d->decorations.begin(), m_d->decorations.end(), KisCanvasDecoration::comparePriority);
}

References KisCanvasDecoration::comparePriority(), KisCanvasWidgetBase::Private::decorations, and m_d.

borderColor()

QColor KisCanvasWidgetBase::borderColor

(

)

const

Returns the color of the border, i.e. the part of the canvas outside the image contents.

Definition at line 200 of file kis_canvas_widget_base.cpp.

{
    return m_d->borderColor;
}

References KisCanvasWidgetBase::Private::borderColor, and m_d.

callFocusNextPrevChild()

virtual bool KisCanvasWidgetBase::callFocusNextPrevChild ( bool next )

protectedpure virtual

To be implemented by the derived canvas.

Implemented in KisQPainterCanvas, and KisOpenGLCanvas2.

canvas()

KisCanvas2 * KisCanvasWidgetBase::canvas ( ) const

protected

Definition at line 205 of file kis_canvas_widget_base.cpp.

{
    return m_d->canvas;
}

References KisCanvasWidgetBase::Private::canvas, and m_d.

coordinatesConverter()

KisCoordinatesConverter * KisCanvasWidgetBase::coordinatesConverter

(

)

const

Definition at line 210 of file kis_canvas_widget_base.cpp.

{
    return m_d->coordinatesConverter;
}

References KisCanvasWidgetBase::Private::coordinatesConverter, and m_d.

createCheckersImage()

QImage KisCanvasWidgetBase::createCheckersImage ( qint32 checkSize = -1 )

static

Returns one check of the background checkerboard pattern.

Definition at line 174 of file kis_canvas_widget_base.cpp.

{
    KisConfig cfg(true);
 
    if(checkSize < 0)
        checkSize = cfg.checkSize();
 
    QColor checkColor1 = cfg.checkersColor1();
    QColor checkColor2 = cfg.checkersColor2();
 
    QImage tile(checkSize * 2, checkSize * 2, QImage::Format_RGB32);
    QPainter pt(&tile);
    pt.fillRect(tile.rect(), checkColor2);
    pt.fillRect(0, 0, checkSize, checkSize, checkColor1);
    pt.fillRect(checkSize, checkSize, checkSize, checkSize, checkColor1);
    pt.end();
 
    return tile;
}

References KisConfig::checkersColor1(), KisConfig::checkersColor2(), and KisConfig::checkSize().

currentBitDepthMode()

KisAbstractCanvasWidget::BitDepthMode KisCanvasWidgetBase::currentBitDepthMode ( ) const

overridevirtual

Implements KisAbstractCanvasWidget.

Reimplemented in KisOpenGLCanvas2.

Definition at line 251 of file kis_canvas_widget_base.cpp.

{
    return BitDepthMode::Depth8Bit;
}

References KisAbstractCanvasWidget::Depth8Bit.

currentBitDepthUserReport()

QString KisCanvasWidgetBase::currentBitDepthUserReport ( ) const

overridevirtual

Implements KisAbstractCanvasWidget.

Reimplemented in KisOpenGLCanvas2.

Definition at line 256 of file kis_canvas_widget_base.cpp.

{
    return QString("Canvas bit depth management is not supported\n");
}

decoration()

KisCanvasDecorationSP KisCanvasWidgetBase::decoration ( const QString & id ) const

overridevirtual

Implements KisAbstractCanvasWidget.

Definition at line 138 of file kis_canvas_widget_base.cpp.

{
    Q_FOREACH (KisCanvasDecorationSP deco, m_d->decorations) {
        if (deco->id() == id) {
            return deco;
        }
    }
    return 0;
}

References KisCanvasWidgetBase::Private::decorations, and m_d.

decorations()

QList< KisCanvasDecorationSP > KisCanvasWidgetBase::decorations ( ) const

overridevirtual

Implements KisAbstractCanvasWidget.

Definition at line 154 of file kis_canvas_widget_base.cpp.

{
    return m_d->decorations;
}

References KisCanvasWidgetBase::Private::decorations, and m_d.

drawDecorations()

void KisCanvasWidgetBase::drawDecorations ( QPainter & gc, const QRect & updateWidgetRect ) const

overridevirtual

Draw the specified decorations on the view.

Implements KisAbstractCanvasWidget.

Definition at line 75 of file kis_canvas_widget_base.cpp.

{
    if (!m_d->canvas) {
        dbgFile<<"canvas doesn't exist, in canvas widget base!";
        return;
    }
    gc.save();
 
    // Setup the painter to take care of the offset; all that the
    // classes that do painting need to keep track of is resolution
    gc.setRenderHint(QPainter::Antialiasing);
    gc.setRenderHint(QPainter::TextAntialiasing);
 
    // This option does not do anything anymore with Qt4.6, so don't re-enable it since it seems to break display
    // https://lists.qt-project.org/pipermail/qt-interest-old/2009-December/017078.html
    // gc.setRenderHint(QPainter::Antialiasing);
 
    gc.setRenderHint(QPainter::SmoothPixmapTransform);
 
    {
        KisQPainterStateSaver paintShapesState(&gc);
        gc.setTransform(m_d->coordinatesConverter->documentToWidgetTransform());
 
        // Paint the shapes (other than the layers)
        m_d->canvas->globalShapeManager()->paint(gc);
 
    }
 
    // ask the decorations to paint themselves
    // decorations are painted in "widget" coordinate system
    Q_FOREACH (KisCanvasDecorationSP deco, m_d->decorations) {
        if (deco->visible()) {
            deco->paint(gc, m_d->coordinatesConverter->widgetToDocument(updateWidgetRect), m_d->coordinatesConverter,m_d->canvas);
        }
    }
 
    {
        KisQPainterStateSaver paintDecorationsState(&gc);
        gc.setTransform(m_d->coordinatesConverter->flakeToWidgetTransform());
 
        // - some tools do not restore gc, but that is not important here
        toolProxy()->paint(gc, *m_d->viewConverter);
    }
 
    gc.restore();
}

References KisCanvasWidgetBase::Private::canvas, KisCanvasWidgetBase::Private::coordinatesConverter, dbgFile, KisCanvasWidgetBase::Private::decorations, KisCoordinatesConverter::documentToWidgetTransform(), KisCoordinatesConverter::flakeToWidgetTransform(), KisCanvas2::globalShapeManager(), m_d, KoShapeManager::paint(), KoToolProxy::paint(), toolProxy(), KisCanvasWidgetBase::Private::viewConverter, and KisCoordinatesConverter::widgetToDocument().

notifyConfigChanged()

void KisCanvasWidgetBase::notifyConfigChanged ( )

protected

Definition at line 194 of file kis_canvas_widget_base.cpp.

{
    KisConfig cfg(true);
    m_d->borderColor = cfg.canvasBorderColor();
}

References KisCanvasWidgetBase::Private::borderColor, KisConfig::canvasBorderColor(), and m_d.

notifyDecorationsWindowMinimized()

void KisCanvasWidgetBase::notifyDecorationsWindowMinimized

(

bool

minimized

)

Definition at line 158 of file kis_canvas_widget_base.cpp.

{
    Q_FOREACH (KisCanvasDecorationSP deco, m_d->decorations) {
        deco->notifyWindowMinimized(minimized);
    }
}

References KisCanvasWidgetBase::Private::decorations, and m_d.

processFocusInEvent()

void KisCanvasWidgetBase::processFocusInEvent ( QFocusEvent * event )

protected

Definition at line 241 of file kis_canvas_widget_base.cpp.

{
    m_d->toolProxy->focusInEvent(event);
}

References KoToolProxy::focusInEvent(), m_d, and KisCanvasWidgetBase::Private::toolProxy.

processFocusOutEvent()

void KisCanvasWidgetBase::processFocusOutEvent ( QFocusEvent * event )

protected

Definition at line 246 of file kis_canvas_widget_base.cpp.

{
    m_d->toolProxy->focusOutEvent(event);
}

References KoToolProxy::focusOutEvent(), m_d, and KisCanvasWidgetBase::Private::toolProxy.

processInputMethodEvent()

void KisCanvasWidgetBase::processInputMethodEvent ( QInputMethodEvent * event )

protected

Definition at line 236 of file kis_canvas_widget_base.cpp.

{
    m_d->toolProxy->inputMethodEvent(event);
}

References KoToolProxy::inputMethodEvent(), m_d, and KisCanvasWidgetBase::Private::toolProxy.

processInputMethodQuery()

QVariant KisCanvasWidgetBase::processInputMethodQuery ( Qt::InputMethodQuery query ) const

protected

Event handlers to be called by derived canvas event handlers. All common event processing is carried out by these functions.

Definition at line 231 of file kis_canvas_widget_base.cpp.

{
    return m_d->toolProxy->inputMethodQuery(query);
}

References KoToolProxy::inputMethodQuery(), m_d, and KisCanvasWidgetBase::Private::toolProxy.

removeDecoration()

void KisCanvasWidgetBase::removeDecoration ( const QString & id )

overridevirtual

Implements KisAbstractCanvasWidget.

Definition at line 128 of file kis_canvas_widget_base.cpp.

{
    for (auto it = m_d->decorations.begin(); it != m_d->decorations.end(); ++it) {
        if ((*it)->id() == id) {
            it = m_d->decorations.erase(it);
            break;
        }
    }
}

References KisCanvasWidgetBase::Private::decorations, and m_d.

setDecorations()

void KisCanvasWidgetBase::setDecorations ( const QList< KisCanvasDecorationSP > & decorations )

overridevirtual

Implements KisAbstractCanvasWidget.

Definition at line 148 of file kis_canvas_widget_base.cpp.

{
    m_d->decorations=decorations;
    std::stable_sort(m_d->decorations.begin(), m_d->decorations.end(), KisCanvasDecoration::comparePriority);
}

References KisCanvasDecoration::comparePriority(), KisCanvasWidgetBase::Private::decorations, decorations(), and m_d.

setWrapAroundViewingMode()

void KisCanvasWidgetBase::setWrapAroundViewingMode ( bool value )

overridevirtual

Implements KisAbstractCanvasWidget.

Reimplemented in KisQPainterCanvas, and KisOpenGLCanvas2.

Definition at line 164 of file kis_canvas_widget_base.cpp.

{
    Q_UNUSED(value);
}

References value().

setWrapAroundViewingModeAxis()

void KisCanvasWidgetBase::setWrapAroundViewingModeAxis ( WrapAroundAxis value )

overridevirtual

Implements KisAbstractCanvasWidget.

Reimplemented in KisQPainterCanvas, and KisOpenGLCanvas2.

Definition at line 169 of file kis_canvas_widget_base.cpp.

{
    Q_UNUSED(value);
}

References value().

toolProxy()

KoToolProxy * KisCanvasWidgetBase::toolProxy ( ) const

overridevirtual

Implements KisAbstractCanvasWidget.

Definition at line 226 of file kis_canvas_widget_base.cpp.

{
    return m_d->toolProxy;
}

References m_d, and KisCanvasWidgetBase::Private::toolProxy.

updateCanvasProjection() [1/3]

QVector< QRect > KisCanvasWidgetBase::updateCanvasProjection ( const QVector< KisUpdateInfoSP > & infoObjects )

overridevirtual

Implements KisAbstractCanvasWidget.

Reimplemented in KisQPainterCanvas, KisOpenGLCanvas2, and KisQPainterCanvas.

Definition at line 215 of file kis_canvas_widget_base.cpp.

{
    QVector<QRect> dirtyViewRects;
 
    Q_FOREACH (KisUpdateInfoSP info, infoObjects) {
        dirtyViewRects << this->updateCanvasProjection(info);
    }
 
    return dirtyViewRects;
}

References updateCanvasProjection().

updateCanvasProjection() [2/3]

virtual QVector< QRect > KisAbstractCanvasWidget::updateCanvasProjection ( const QVector< KisUpdateInfoSP > & infoObjects )

virtual

Implements KisAbstractCanvasWidget.

Reimplemented in KisQPainterCanvas, KisOpenGLCanvas2, and KisQPainterCanvas.

updateCanvasProjection() [3/3]

virtual QRect KisAbstractCanvasWidget::updateCanvasProjection ( KisUpdateInfoSP info )

virtual

Implements KisAbstractCanvasWidget.

Reimplemented in KisQPainterCanvas, KisOpenGLCanvas2, and KisQPainterCanvas.

Member Data Documentation

m_d

Private* const KisCanvasWidgetBase::m_d

private

Definition at line 94 of file kis_canvas_widget_base.h.

---

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

• libs/ui/canvas/kis_canvas_widget_base.h
• libs/ui/canvas/kis_canvas_widget_base.cpp