KoToolBase.cpp

Go to the documentation of this file.

/* This file is part of the KDE project
 * SPDX-FileCopyrightText: 2006, 2010 Thomas Zander <zander@kde.org>
 * SPDX-FileCopyrightText: 2011 Jan Hambrecht <jaham@gmx.net>
 *
 * SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
#include <QDebug>
 
#include <QAction>
 
#include "KoToolBase.h"
#include "KoToolBase_p.h"
#include "KoToolFactoryBase.h"
#include "KoCanvasBase.h"
#include "KoPointerEvent.h"
#include "KoDocumentResourceManager.h"
#include "KoCanvasResourceProvider.h"
#include "KoViewConverter.h"
#include "KoShapeController.h"
#include "KoShapeControllerBase.h"
#include "KoToolSelection.h"
#include "KoCanvasController.h"
#include "KoToolProxy.h"
#include <kis_icon_utils.h>
#include "KoDerivedResourceConverter.h"
#include "KoAbstractCanvasResourceInterface.h"
#include <KisScopedPerformanceLogger.h>
 
#include <klocalizedstring.h>
#include <kactioncollection.h>
#include <QWidget>
#include <QFile>
#include <QDomDocument>
#include <QDomElement>
#include <QApplication>
 
#include <QKeyEvent>
#include <QInputMethodEvent>
#include <QFocusEvent>
 
KoToolBase::KoToolBase(KoCanvasBase *canvas)
    : d_ptr(new KoToolBasePrivate(this, canvas))
{
    Q_D(KoToolBase);
    d->connectSignals();
}
 
KoToolBase::KoToolBase(KoToolBasePrivate &dd)
    : d_ptr(&dd)
{
    Q_D(KoToolBase);
    d->connectSignals();
}
 
KoToolBase::~KoToolBase()
{
    delete d_ptr;
}
 
 
bool KoToolBase::isActivated() const
{
    Q_D(const KoToolBase);
    return d->isActivated;
}
 
KoPointerEvent *KoToolBase::lastDeliveredPointerEvent() const
{
    Q_D(const KoToolBase);
 
    if (!d->canvas) return 0;
    if (!d->canvas->toolProxy()) return 0;
 
    return d->canvas->toolProxy()->lastDeliveredPointerEvent();
}
 
void KoToolBase::activate(const QSet<KoShape *> &shapes)
{
    Q_UNUSED(shapes);
 
    Q_D(KoToolBase);
    d->isActivated = true;
}
 
void KoToolBase::deactivate()
{
    Q_D(KoToolBase);
    d->isActivated = false;
}
 
void KoToolBase::canvasResourceChanged(int key, const QVariant & res)
{
    Q_UNUSED(key);
    Q_UNUSED(res);
}
 
void KoToolBase::documentResourceChanged(int key, const QVariant &res)
{
    Q_UNUSED(key);
    Q_UNUSED(res);
}
 
bool KoToolBase::wantsAutoScroll() const
{
    return true;
}
 
void KoToolBase::mouseDoubleClickEvent(KoPointerEvent *event)
{
    event->ignore();
}
 
void KoToolBase::mouseTripleClickEvent(KoPointerEvent *event)
{
    event->ignore();
}
 
void KoToolBase::keyPressEvent(QKeyEvent *e)
{
    e->ignore();
}
 
void KoToolBase::keyReleaseEvent(QKeyEvent *e)
{
    e->ignore();
}
 
 
void KoToolBase::explicitUserStrokeEndRequest()
{
}
 
QVariant KoToolBase::inputMethodQuery(Qt::InputMethodQuery query) const
{
    Q_D(const KoToolBase);
    if (d->canvas->canvasWidget() == 0)
        return QVariant();
 
    switch (query) {
    case Qt::ImEnabled:
        return isInTextMode();
    case Qt::ImCursorRectangle:
        return QRect(d->canvas->canvasWidget()->width() / 2, 0, 1, d->canvas->canvasWidget()->height());
    case Qt::ImFont:
        return d->canvas->canvasWidget()->font();
    default:
        return QVariant();
    }
}
 
void KoToolBase::inputMethodEvent(QInputMethodEvent * event)
{
    if (! event->commitString().isEmpty()) {
        QKeyEvent ke(QEvent::KeyPress, -1, QFlags<Qt::KeyboardModifier>(), event->commitString());
        keyPressEvent(&ke);
    }
    event->accept();
}
 
void KoToolBase::focusInEvent(QFocusEvent *event)
{
    event->ignore();
}
 
void KoToolBase::focusOutEvent(QFocusEvent *event)
{
    event->ignore();
}
 
void KoToolBase::customPressEvent(KoPointerEvent * event)
{
    event->ignore();
}
 
void KoToolBase::customReleaseEvent(KoPointerEvent * event)
{
    event->ignore();
}
 
void KoToolBase::customMoveEvent(KoPointerEvent * event)
{
    event->ignore();
}
 
void KoToolBase::useCursor(const QCursor &cursor)
{
    Q_D(KoToolBase);
    d->currentCursor = cursor;
    Q_EMIT cursorChanged(d->currentCursor);
}
 
QList<QPointer<QWidget> > KoToolBase::optionWidgets()
{
    Q_D(KoToolBase);
    if (!d->optionWidgetsCreated) {
        KisScopedPerformanceLogger perfLog(QStringLiteral("KoToolBase::optionWidgets(%1)").arg(toolId()));
        d->optionWidgets = createOptionWidgets();
        d->optionWidgetsCreated = true;
    }
    return d->optionWidgets;
}
 
QAction *KoToolBase::action(const QString &name) const
{
    Q_D(const KoToolBase);
    if (d->canvas && d->canvas->canvasController() && d->canvas->canvasController()) {
        return d->canvas->canvasController()->actionCollection()->action(name);
    }
    return 0;
}
 
QWidget * KoToolBase::createOptionWidget()
{
    return 0;
}
 
QList<QPointer<QWidget> >  KoToolBase::createOptionWidgets()
{
    QList<QPointer<QWidget> > ow;
    if (QWidget *widget = createOptionWidget()) {
        if (widget->objectName().isEmpty()) {
            widget->setObjectName(toolId());
        }
        ow.append(widget);
    }
    return ow;
}
 
void KoToolBase::setFactory(KoToolFactoryBase *factory)
{
    Q_D(KoToolBase);
    d->factory = factory;
}
 
KoToolFactoryBase* KoToolBase::factory() const
{
    Q_D(const KoToolBase);
    return d->factory;
}
 
QString KoToolBase::toolId() const
{
    Q_D(const KoToolBase);
    return d->factory ? d->factory->id() : 0;
}
 
QCursor KoToolBase::cursor() const
{
    Q_D(const KoToolBase);
    return d->currentCursor;
}
 
void KoToolBase::deleteSelection()
{
}
 
void KoToolBase::cut()
{
    copy();
    deleteSelection();
}
 
KoCanvasBase * KoToolBase::canvas() const
{
    Q_D(const KoToolBase);
    return d->canvas;
}
 
void KoToolBase::setStatusText(const QString &statusText)
{
    Q_EMIT statusTextChanged(statusText);
}
 
int KoToolBase::handleRadius() const
{
    Q_D(const KoToolBase);
    if (d->canvas
            && d->canvas->resourceManager()
       )
    {
        return d->canvas->resourceManager()->handleRadius();
    }
    else {
        return 3;
    }
}
 
qreal KoToolBase::handleDocRadius() const
{
    Q_D(const KoToolBase);
    const KoViewConverter * converter = d->canvas->viewConverter();
    const QPointF doc = converter->viewToDocument(QPointF(handleRadius(), handleRadius()));
    return qMax(doc.x(), doc.y());
}
 
int KoToolBase::decorationThickness() const
{
    Q_D(const KoToolBase);
    if (d->canvas
            && d->canvas->resourceManager()
       )
    {
        return d->canvas->resourceManager()->decorationThickness();
    }
    else {
        return 1;
    }
}
 
int KoToolBase::grabSensitivity() const
{
    Q_D(const KoToolBase);
    if(d->canvas->shapeController()->resourceManager())
    {
        return d->canvas->shapeController()->resourceManager()->grabSensitivity();
    } else {
        return 3;
    }
}
 
QRectF KoToolBase::handleGrabRect(const QPointF &position) const
{
    Q_D(const KoToolBase);
    const KoViewConverter * converter = d->canvas->viewConverter();
    uint handleSize = 2*grabSensitivity();
    QRectF r = converter->viewToDocument(QRectF(0, 0, handleSize, handleSize));
    r.moveCenter(position);
    return r;
}
 
QRectF KoToolBase::handlePaintRect(const QPointF &position) const
{
    Q_D(const KoToolBase);
    const KoViewConverter * converter = d->canvas->viewConverter();
    uint handleSize = 2*handleRadius();
    QRectF r = converter->viewToDocument(QRectF(0, 0, handleSize, handleSize));
    r.moveCenter(position);
    return r;
}
 
void KoToolBase::setTextMode(bool value)
{
    Q_D(KoToolBase);
    d->isInTextMode = value;
    qApp->inputMethod()->update(Qt::ImEnabled);
    Q_EMIT textModeChanged(d->isInTextMode);
}
 
bool KoToolBase::paste()
{
    return false;
}
 
bool KoToolBase::selectAll()
{
    return false;
}
 
void KoToolBase::deselect()
{
}
 
void KoToolBase::copy() const
{
}
 
void KoToolBase::dragMoveEvent(QDragMoveEvent *event, const QPointF &point)
{
    Q_UNUSED(event);
    Q_UNUSED(point);
}
 
void KoToolBase::dragLeaveEvent(QDragLeaveEvent *event)
{
    Q_UNUSED(event);
}
 
void KoToolBase::dropEvent(QDropEvent *event, const QPointF &point)
{
    Q_UNUSED(event);
    Q_UNUSED(point);
}
 
bool KoToolBase::hasSelection()
{
    KoToolSelection *sel = selection();
    return (sel && sel->hasSelection());
}
 
KoToolSelection *KoToolBase::selection()
{
    return 0;
}
 
void KoToolBase::repaintDecorations()
{
    Q_D(KoToolBase);
 
    QRectF dirtyRect = d->lastDecorationsRect;
    d->lastDecorationsRect = decorationsRect();
    dirtyRect |= d->lastDecorationsRect;
 
    if (!dirtyRect.isEmpty()) {
        canvas()->updateCanvas(dirtyRect);
    }
}
 
QRectF KoToolBase::decorationsRect() const
{
    return QRectF();
}
 
bool KoToolBase::isInTextMode() const
{
    Q_D(const KoToolBase);
    return d->isInTextMode;
}
 
void KoToolBase::requestUndoDuringStroke()
{
    requestStrokeCancellation();
}
 
 
void KoToolBase::requestRedoDuringStroke()
{
}
 
void KoToolBase::requestStrokeCancellation()
{
}
 
void KoToolBase::requestStrokeEnd()
{
}
 
bool KoToolBase::maskSyntheticEvents() const
{
    Q_D(const KoToolBase);
    return d->maskSyntheticEvents;
}
 
void KoToolBase::setMaskSyntheticEvents(bool value)
{
    Q_D(KoToolBase);
    d->maskSyntheticEvents = value;
}
 
bool KoToolBase::isOpacityPresetMode() const
{
    Q_D(const KoToolBase);
    return d->isOpacityPresetMode;
}
 
void KoToolBase::setIsOpacityPresetMode(bool value)
{
    Q_D(KoToolBase);
    d->isOpacityPresetMode = value;
}
 
void KoToolBase::setConverter(KoDerivedResourceConverterSP converter) {
    Q_D(KoToolBase);
    d->toolCanvasResources.converters[converter->key()] = converter;
}
 
void KoToolBase::setAbstractResource(KoAbstractCanvasResourceInterfaceSP abstractResource) {
    Q_D(KoToolBase);
    d->toolCanvasResources.abstractResources[abstractResource->key()] = abstractResource;
}
 
QHash<int, KoAbstractCanvasResourceInterfaceSP> KoToolBase::toolAbstractResources()
{
    Q_D(KoToolBase);
    return d->toolCanvasResources.abstractResources;
}
 
QHash<int, KoDerivedResourceConverterSP> KoToolBase::toolConverters()
{
    Q_D(KoToolBase);
    return d->toolCanvasResources.converters;
}
 
void KoToolBase::updateOptionsWidgetIcons()
{
    Q_D(KoToolBase);
    if (d->optionWidgetsCreated) {
        QObjectList objects;
        Q_FOREACH (QPointer<QWidget> widget, d->optionWidgets) {
            objects.append(widget);
        }
        while (!objects.isEmpty()) {
            QObject* object = objects.takeFirst();
            objects.append(object->children());
            KisIconUtils::updateIconCommon(object);
        }
    }
}