KisToolProxy Class Reference

#include <kis_tool_proxy.h>

Inheritance diagram for KisToolProxy:

Public Types
enum	ActionState { BEGIN , CONTINUE , END }

Signals
void	toolPrimaryActionActivated (bool activated)
Signals inherited from KoToolProxy
void	selectionChanged (bool hasSelection)
void	toolChanged (const QString &toolId)

Public Member Functions
void	activateToolAction (KisTool::ToolAction action)
bool	alternateActionSupportsHiResEvents (KisTool::AlternateAction action) const
void	deactivateToolAction (KisTool::ToolAction action)
bool	forwardEvent (ActionState state, KisTool::ToolAction action, QEvent *event, QEvent *originalEvent)
void	forwardHoverEvent (QEvent *event)
void	initializeImage (KisImageSP image)
	KisToolProxy (KoCanvasBase *canvas, QObject *parent=0)
bool	primaryActionSupportsHiResEvents () const
void	setActiveTool (KoToolBase *tool) override
	Set the new active tool.
bool	supportsPaintingAssistants () const
Public Member Functions inherited from KoToolProxy
void	copy () const
	Forwarded to the current KoToolBase.
void	cut ()
	Forwarded to the current KoToolBase.
void	deleteSelection ()
	Forwarded to the current KoToolBase.
void	deselect ()
	Forwarded to the current KoToolBase.
void	dragLeaveEvent (QDragLeaveEvent *event)
	Forwarded to the current KoToolBase.
void	dragMoveEvent (QDragMoveEvent *event, const QPointF &point)
	Forwarded to the current KoToolBase.
void	dropEvent (QDropEvent *event, const QPointF &point)
	Forwarded to the current KoToolBase.
void	explicitUserStrokeEndRequest ()
	Forwarded to the current KoToolBase.
void	focusInEvent (QFocusEvent *event)
	Forwarded to the current KoToolBase.
void	focusOutEvent (QFocusEvent *event)
	Forwarded to the current KoToolBase.
bool	hasSelection () const
	returns true if the current tool holds a selection
void	inputMethodEvent (QInputMethodEvent *event)
	Forwarded to the current KoToolBase.
QVariant	inputMethodQuery (Qt::InputMethodQuery query) const
	Forwarded to the current KoToolBase.
void	keyPressEvent (QKeyEvent *event)
	Forwarded to the current KoToolBase.
void	keyReleaseEvent (QKeyEvent *event)
	Forwarded to the current KoToolBase.
	KoToolProxy (KoCanvasBase *canvas, QObject *parent=0)
KoPointerEvent *	lastDeliveredPointerEvent () const
void	mouseDoubleClickEvent (KoPointerEvent *event)
void	mouseDoubleClickEvent (QMouseEvent *event, const QPointF &point)
	Forwarded to the current KoToolBase.
void	mouseMoveEvent (KoPointerEvent *event)
void	mouseMoveEvent (QMouseEvent *event, const QPointF &point)
	Forwarded to the current KoToolBase.
void	mousePressEvent (KoPointerEvent *event)
void	mousePressEvent (QMouseEvent *event, const QPointF &point)
	Forwarded to the current KoToolBase.
void	mouseReleaseEvent (KoPointerEvent *event)
void	mouseReleaseEvent (QMouseEvent *event, const QPointF &point)
	Forwarded to the current KoToolBase.
void	paint (QPainter &painter, const KoViewConverter &converter)
	Forwarded to the current KoToolBase.
bool	paste ()
	Forwarded to the current KoToolBase.
QMenu *	popupActionsMenu ()
	Forwarded to the current KoToolBase.
KisPopupWidgetInterface *	popupWidget ()
	Forwarded to the current KoToolBase.
KoToolProxyPrivate *	priv ()
void	processEvent (QEvent *) const
void	repaintDecorations ()
	Forwarded to the current KoToolBase.
bool	selectAll ()
	Forwarded to the current KoToolBase.
void	tabletEvent (QTabletEvent *event, const QPointF &point)
	Forwarded to the current KoToolBase.
QVector< QKeySequence >	toolPriorityShortcuts () const
void	touchEvent (QTouchEvent *event, const QPointF &point)
	~KoToolProxy () override

Protected Member Functions
QPointF	documentToWidget (const QPointF &documentPoint) const override
QPointF	widgetToDocument (const QPointF &widgetPoint) const override
Protected Member Functions inherited from KoToolProxy
KoCanvasBase *	canvas () const

Private Member Functions
KoPointerEvent	convertEventToPointerEvent (QEvent *event, const QPointF &docPoint, bool *result)
void	forwardToTool (ActionState state, KisTool::ToolAction action, QEvent *event, const QPointF &docPoint)
QPointF	tabletToDocument (const QPointF &globalPos)

Private Attributes
bool	m_isActionActivated
KisTool::ToolAction	m_lastAction

Additional Inherited Members
Protected Slots inherited from KoToolProxy
void	requestRedoDuringStroke ()
	Forwarded to the current KoToolBase.
void	requestStrokeCancellation ()
	Forwarded to the current KoToolBase.
void	requestStrokeEnd ()
	Forwarded to the current KoToolBase.
void	requestUndoDuringStroke ()
	Forwarded to the current KoToolBase.

Detailed Description

Definition at line 15 of file kis_tool_proxy.h.

Member Enumeration Documentation

ActionState

enum KisToolProxy::ActionState

Enumerator
BEGIN	Beginning an action
CONTINUE	Continuing an action
END	Ending an action

Definition at line 19 of file kis_tool_proxy.h.

                     {
        BEGIN,  
        CONTINUE, 
        END 
    };

Constructor & Destructor Documentation

KisToolProxy()

KisToolProxy::KisToolProxy	(	KoCanvasBase *	canvas,
		QObject *	parent = 0 )

Definition at line 14 of file kis_tool_proxy.cpp.

    : KoToolProxy(canvas, parent),
      m_isActionActivated(false),
      m_lastAction(KisTool::Primary)
{
}

Member Function Documentation

activateToolAction()

void KisToolProxy::activateToolAction

(

KisTool::ToolAction

action

)

Definition at line 235 of file kis_tool_proxy.cpp.

{
    KisTool *activeTool = dynamic_cast<KisTool*>(const_cast<KisToolProxy*>(this)->priv()->activeTool);
 
    if (activeTool) {
        if (action == KisTool::Primary) {
            activeTool->activatePrimaryAction();
        } else {
            activeTool->activateAlternateAction(KisTool::actionToAlternateAction(action));
        }
    }
 
    m_isActionActivated = true;
    m_lastAction = action;
}

References KisTool::actionToAlternateAction(), KisTool::activateAlternateAction(), KisTool::activatePrimaryAction(), KoToolProxyPrivate::activeTool, m_isActionActivated, m_lastAction, KisTool::Primary, and KoToolProxy::priv().

alternateActionSupportsHiResEvents()

bool KisToolProxy::alternateActionSupportsHiResEvents

(

KisTool::AlternateAction

action

)

const

Definition at line 216 of file kis_tool_proxy.cpp.

{
    KisTool *activeTool = dynamic_cast<KisTool*>(const_cast<KisToolProxy*>(this)->priv()->activeTool);
    return activeTool && activeTool->alternateActionSupportsHiResEvents(action);
}

References KoToolProxyPrivate::activeTool, KisTool::alternateActionSupportsHiResEvents(), and KoToolProxy::priv().

convertEventToPointerEvent()

KoPointerEvent KisToolProxy::convertEventToPointerEvent ( QEvent * event, const QPointF & docPoint, bool * result )

private

Definition at line 51 of file kis_tool_proxy.cpp.

{
    switch (event->type()) {
    case QEvent::TabletPress:
    case QEvent::TabletRelease:
    case QEvent::TabletMove:
    {
        *result = true;
        QTabletEvent *tabletEvent = static_cast<QTabletEvent*>(event);
        KoPointerEvent ev(tabletEvent, docPoint);
        return ev;
    }
    case QEvent::MouseButtonPress:
    case QEvent::MouseButtonDblClick:
    case QEvent::MouseButtonRelease:
    case QEvent::MouseMove:
    {
        *result = true;
        QMouseEvent *mouseEvent = static_cast<QMouseEvent*>(event);
        return KoPointerEvent(mouseEvent, docPoint);
    }
    case QEvent::TouchBegin:
    case QEvent::TouchUpdate:
    case QEvent::TouchEnd:
    case QEvent::TouchCancel:
    {
        *result = true;
        QTouchEvent *touchEvent = static_cast<QTouchEvent *> (event);
        return KoPointerEvent(touchEvent, docPoint);
    }
    default:
        ;
    }
 
    *result = false;
    QMouseEvent fakeEvent(QEvent::MouseMove, QPoint(),
                          Qt::NoButton, Qt::NoButton,
                          Qt::NoModifier);
 
    return KoPointerEvent(&fakeEvent, QPointF());
}

References KoToolProxy::tabletEvent(), and KoToolProxy::touchEvent().

deactivateToolAction()

void KisToolProxy::deactivateToolAction

(

KisTool::ToolAction

action

)

Definition at line 251 of file kis_tool_proxy.cpp.

{
    KisTool *activeTool = dynamic_cast<KisTool*>(const_cast<KisToolProxy*>(this)->priv()->activeTool);
 
    if (activeTool) {
        if (action == KisTool::Primary) {
            activeTool->deactivatePrimaryAction();
        } else {
            activeTool->deactivateAlternateAction(KisTool::actionToAlternateAction(action));
        }
    }
 
    m_isActionActivated = false;
    m_lastAction = action;
}

References KisTool::actionToAlternateAction(), KoToolProxyPrivate::activeTool, KisTool::deactivateAlternateAction(), KisTool::deactivatePrimaryAction(), m_isActionActivated, m_lastAction, KisTool::Primary, and KoToolProxy::priv().

documentToWidget()

QPointF KisToolProxy::documentToWidget ( const QPointF & documentPoint ) const

overrideprotectedvirtual

Implements KoToolProxy.

Definition at line 43 of file kis_tool_proxy.cpp.

{
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas());
    Q_ASSERT(kritaCanvas);
 
    return kritaCanvas->coordinatesConverter()->documentToWidget(documentPoint);
}

References KoToolProxy::canvas(), KisCanvas2::coordinatesConverter, and KisCoordinatesConverter::documentToWidget().

forwardEvent()

bool KisToolProxy::forwardEvent	(	ActionState	state,
		KisTool::ToolAction	action,
		QEvent *	event,
		QEvent *	originalEvent )

Forwards the event to the active tool and returns true if the event was not ignored. That is by default the event is considered accepted, but the tool can explicitly ignore it.

Parameters

state	beginning, continuing, or ending the action.
action	alternate tool action requested.
event	the event being sent to the tool by the AbstractInputAction.
originalEvent	the original event received by the AbstractInputAction.

Definition at line 118 of file kis_tool_proxy.cpp.

{
    bool retval = true;
 
    QTabletEvent *tabletEvent = dynamic_cast<QTabletEvent*>(event);
    QMouseEvent *mouseEvent = dynamic_cast<QMouseEvent*>(event);
    QTouchEvent *touchEvent = dynamic_cast<QTouchEvent *> (event);
 
    if (tabletEvent) {
        QPointF docPoint = widgetToDocument(tabletEvent->posF());
        tabletEvent->accept();
        this->tabletEvent(tabletEvent, docPoint);
        forwardToTool(state, action, tabletEvent, docPoint);
        retval = tabletEvent->isAccepted();
    }
    else if (mouseEvent) {
        QPointF docPoint = widgetToDocument(mouseEvent->localPos());
        mouseEvent->accept();
        if (mouseEvent->type() == QEvent::MouseButtonPress) {
            mousePressEvent(mouseEvent, docPoint);
        } else if (mouseEvent->type() == QEvent::MouseButtonDblClick) {
            mouseDoubleClickEvent(mouseEvent, docPoint);
        } else if (mouseEvent->type() == QEvent::MouseButtonRelease) {
            mouseReleaseEvent(mouseEvent, docPoint);
        } else if (mouseEvent->type() == QEvent::MouseMove) {
            mouseMoveEvent(mouseEvent, docPoint);
        }
        forwardToTool(state, action, originalEvent, docPoint);
        retval = mouseEvent->isAccepted();
    }
    else if (touchEvent) {
        QPointF docPoint = widgetToDocument(touchEvent->touchPoints().at(0).pos());
        touchEvent->accept();
        this->touchEvent(touchEvent, docPoint);
        forwardToTool(state, action, touchEvent, docPoint);
        retval = touchEvent->isAccepted();
    }
    else if (event && event->type() == QEvent::KeyPress) {
        QKeyEvent* kevent = static_cast<QKeyEvent*>(event);
        keyPressEvent(kevent);
    }
    else if (event && event->type() == QEvent::KeyRelease) {
        QKeyEvent* kevent = static_cast<QKeyEvent*>(event);
        keyReleaseEvent(kevent);
    }
 
    return retval;
}

References forwardToTool(), KoToolProxy::keyPressEvent(), KoToolProxy::keyReleaseEvent(), KoToolProxy::mouseDoubleClickEvent(), KoToolProxy::mouseMoveEvent(), KoToolProxy::mousePressEvent(), KoToolProxy::mouseReleaseEvent(), KoToolProxy::tabletEvent(), KoToolProxy::touchEvent(), and widgetToDocument().

forwardHoverEvent()

void KisToolProxy::forwardHoverEvent

(

QEvent *

event

)

Definition at line 93 of file kis_tool_proxy.cpp.

{
    switch (event->type()) {
    case QEvent::TabletMove: {
        QTabletEvent *tabletEvent = static_cast<QTabletEvent*>(event);
        QPointF docPoint = widgetToDocument(tabletEvent->posF());
        this->tabletEvent(tabletEvent, docPoint);
        return;
    }
 
    case QEvent::MouseMove: {
        QMouseEvent *mouseEvent = static_cast<QMouseEvent*>(event);
        QPointF docPoint = widgetToDocument(mouseEvent->localPos());
        mouseMoveEvent(mouseEvent, docPoint);
        return;
    }
 
    default: {
        qWarning() << "forwardHoverEvent encountered unknown event type:"
            << event->type();
        return;
    }
    }
}

References KoToolProxy::mouseMoveEvent(), KoToolProxy::tabletEvent(), and widgetToDocument().

forwardToTool()

void KisToolProxy::forwardToTool ( ActionState state, KisTool::ToolAction action, QEvent * event, const QPointF & docPoint )

private

Definition at line 167 of file kis_tool_proxy.cpp.

{
    bool eventValid = false;
    KoPointerEvent ev = convertEventToPointerEvent(event, docPoint, &eventValid);
    KisTool *activeTool = dynamic_cast<KisTool*>(priv()->activeTool);
 
    if (!eventValid || !activeTool) return;
 
    switch (state) {
    case BEGIN:
        if (action == KisTool::Primary) {
            if (event->type() == QEvent::MouseButtonDblClick) {
                activeTool->beginPrimaryDoubleClickAction(&ev);
            } else {
                activeTool->beginPrimaryAction(&ev);
            }
        } else {
            if (event->type() == QEvent::MouseButtonDblClick) {
                activeTool->beginAlternateDoubleClickAction(&ev, KisTool::actionToAlternateAction(action));
            } else {
                activeTool->beginAlternateAction(&ev, KisTool::actionToAlternateAction(action));
            }
        }
        Q_EMIT toolPrimaryActionActivated(true);
        break;
    case CONTINUE:
        if (action == KisTool::Primary) {
            activeTool->continuePrimaryAction(&ev);
        } else {
            activeTool->continueAlternateAction(&ev, KisTool::actionToAlternateAction(action));
        }
        break;
    case END:
        if (action == KisTool::Primary) {
            activeTool->endPrimaryAction(&ev);
        } else {
            activeTool->endAlternateAction(&ev, KisTool::actionToAlternateAction(action));
        }
        Q_EMIT toolPrimaryActionActivated(false);
        break;
    }
}

References KisTool::actionToAlternateAction(), KoToolProxyPrivate::activeTool, BEGIN, KisTool::beginAlternateAction(), KisTool::beginAlternateDoubleClickAction(), KisTool::beginPrimaryAction(), KisTool::beginPrimaryDoubleClickAction(), CONTINUE, KisTool::continueAlternateAction(), KisTool::continuePrimaryAction(), convertEventToPointerEvent(), END, KisTool::endAlternateAction(), KisTool::endPrimaryAction(), KisTool::Primary, KoToolProxy::priv(), and toolPrimaryActionActivated().

initializeImage()

void KisToolProxy::initializeImage

(

KisImageSP

image

)

Definition at line 21 of file kis_tool_proxy.cpp.

{
    connect(image, SIGNAL(sigUndoDuringStrokeRequested()), SLOT(requestUndoDuringStroke()), Qt::UniqueConnection);
    connect(image, SIGNAL(sigRedoDuringStrokeRequested()), SLOT(requestRedoDuringStroke()), Qt::UniqueConnection);
    connect(image, SIGNAL(sigStrokeCancellationRequested()), SLOT(requestStrokeCancellation()), Qt::UniqueConnection);
    connect(image, SIGNAL(sigStrokeEndRequested()), SLOT(requestStrokeEnd()), Qt::UniqueConnection);
}

References connect(), KoToolProxy::requestRedoDuringStroke(), KoToolProxy::requestStrokeCancellation(), KoToolProxy::requestStrokeEnd(), and KoToolProxy::requestUndoDuringStroke().

primaryActionSupportsHiResEvents()

bool KisToolProxy::primaryActionSupportsHiResEvents

(

)

const

Definition at line 210 of file kis_tool_proxy.cpp.

{
    KisTool *activeTool = dynamic_cast<KisTool*>(const_cast<KisToolProxy*>(this)->priv()->activeTool);
    return activeTool && activeTool->primaryActionSupportsHiResEvents();
}

References KoToolProxyPrivate::activeTool, KisTool::primaryActionSupportsHiResEvents(), and KoToolProxy::priv().

setActiveTool()

void KisToolProxy::setActiveTool ( KoToolBase * tool )

overridevirtual

Set the new active tool.

Reimplemented from KoToolProxy.

Definition at line 222 of file kis_tool_proxy.cpp.

{
    if (!tool) return;
 
    if (m_isActionActivated) {
        deactivateToolAction(m_lastAction);
        KoToolProxy::setActiveTool(tool);
        activateToolAction(m_lastAction);
    } else {
        KoToolProxy::setActiveTool(tool);
    }
}

References activateToolAction(), deactivateToolAction(), m_isActionActivated, m_lastAction, and KoToolProxy::setActiveTool().

supportsPaintingAssistants()

bool KisToolProxy::supportsPaintingAssistants

(

)

const

Definition at line 267 of file kis_tool_proxy.cpp.

{
    KisTool *activeTool = dynamic_cast<KisTool*>(const_cast<KisToolProxy*>(this)->priv()->activeTool);
    return activeTool && activeTool->supportsPaintingAssistants();
}

References KoToolProxyPrivate::activeTool, KoToolProxy::priv(), and KisTool::supportsPaintingAssistants().

tabletToDocument()

QPointF KisToolProxy::tabletToDocument ( const QPointF & globalPos )

private

Definition at line 29 of file kis_tool_proxy.cpp.

{
    const QPointF pos = globalPos - QPointF(canvas()->canvasWidget()->mapToGlobal(QPoint(0, 0)));
    return widgetToDocument(pos);
}

References KoToolProxy::canvas(), and widgetToDocument().

toolPrimaryActionActivated

void KisToolProxy::toolPrimaryActionActivated ( bool activated )

signal

widgetToDocument()

QPointF KisToolProxy::widgetToDocument ( const QPointF & widgetPoint ) const

overrideprotectedvirtual

Implements KoToolProxy.

Definition at line 35 of file kis_tool_proxy.cpp.

{
    KisCanvas2 *kritaCanvas = dynamic_cast<KisCanvas2*>(canvas());
    Q_ASSERT(kritaCanvas);
 
    return kritaCanvas->coordinatesConverter()->widgetToDocument(widgetPoint);
}

References KoToolProxy::canvas(), KisCanvas2::coordinatesConverter, and KisCoordinatesConverter::widgetToDocument().

Member Data Documentation

m_isActionActivated

bool KisToolProxy::m_isActionActivated

private

Definition at line 63 of file kis_tool_proxy.h.

m_lastAction

KisTool::ToolAction KisToolProxy::m_lastAction

private

Definition at line 64 of file kis_tool_proxy.h.

---

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

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