libs/flake

KoToolProxy Class Reference

Simple proxy interface that provides a point d'appui for canvas implementations to pass events to the current tool. More...

#include <KoToolProxy.h>

Inheritance diagram for KoToolProxy:
Inheritance graph
[legend]

List of all members.

Signals

void selectionChanged (bool hasSelection)
void toolChanged (const QString &toolId)

Public Member Functions

 KoToolProxy (KoCanvasBase *canvas, QObject *parent=0)
 ~KoToolProxy ()
QHash< QString, KAction * > actions () const
void copy () const
void cut ()
void deleteSelection ()
void inputMethodEvent (QInputMethodEvent *event)
QVariant inputMethodQuery (Qt::InputMethodQuery query, const KoViewConverter &converter) const
void keyPressEvent (QKeyEvent *event)
void keyReleaseEvent (QKeyEvent *event)
void mouseDoubleClickEvent (QMouseEvent *event, const QPointF &point)
void mouseMoveEvent (QMouseEvent *event, const QPointF &point)
void mousePressEvent (QMouseEvent *event, const QPointF &point)
void mouseReleaseEvent (QMouseEvent *event, const QPointF &point)
void paint (QPainter &painter, const KoViewConverter &converter)
bool paste ()
QList< QAction * > popupActionList () const
void repaintDecorations ()
KoToolSelection * selection ()
void setActiveTool (KoTool *tool)
QStringList supportedPasteMimeTypes () const
void tabletEvent (QTabletEvent *event, const QPointF &point)
void wheelEvent (QWheelEvent *event, const QPointF &point)

Protected Member Functions

void setCanvasController (KoCanvasController *controller)

Detailed Description

Simple proxy interface that provides a point d'appui for canvas implementations to pass events to the current tool.

For the paint event it is possible that there more than one tool is asked to paint their decorations because tools can be stacked.

The implementator of KoToolProxy should be solely responsible for knowing which tool is currently in the user's hands.

Definition at line 50 of file KoToolProxy.h.

Constructor & Destructor Documentation

KoToolProxy::KoToolProxy ( KoCanvasBase *  canvas,
QObject *  parent = 0 
) [explicit]

Constructor.

Parameters:
canvas Each canvas has 1 toolProxy. Pass the parent here.
parent a parent QObject for memory management purposes.

Definition at line 158 of file KoToolProxy.cpp.

KoToolProxy::~KoToolProxy (  ) 

Definition at line 167 of file KoToolProxy.cpp.

Member Function Documentation

QHash< QString, KAction * > KoToolProxy::actions (  )  const

Retrieves the entire collection of actions for the active tool or an empty hash if there is no active tool yet.

Definition at line 356 of file KoToolProxy.cpp.

void KoToolProxy::copy (  )  const

Forwarded to the current KoTool.

Definition at line 368 of file KoToolProxy.cpp.

void KoToolProxy::cut (  ) 

Forwarded to the current KoTool.

Definition at line 361 of file KoToolProxy.cpp.

void KoToolProxy::deleteSelection (  ) 

Forwarded to the current KoTool.

Definition at line 397 of file KoToolProxy.cpp.

void KoToolProxy::inputMethodEvent ( QInputMethodEvent *  event  ) 

Forwarded to the current KoTool.

Definition at line 327 of file KoToolProxy.cpp.

QVariant KoToolProxy::inputMethodQuery ( Qt::InputMethodQuery  query,
const KoViewConverter &  converter 
) const

Forwarded to the current KoTool.

Definition at line 320 of file KoToolProxy.cpp.

void KoToolProxy::keyPressEvent ( QKeyEvent *  event  ) 

Forwarded to the current KoTool.

Definition at line 301 of file KoToolProxy.cpp.

void KoToolProxy::keyReleaseEvent ( QKeyEvent *  event  ) 

Forwarded to the current KoTool.

Definition at line 307 of file KoToolProxy.cpp.

void KoToolProxy::mouseDoubleClickEvent ( QMouseEvent *  event,
const QPointF &  point 
)

Forwarded to the current KoTool.

Definition at line 230 of file KoToolProxy.cpp.

void KoToolProxy::mouseMoveEvent ( QMouseEvent *  event,
const QPointF &  point 
)

Forwarded to the current KoTool.

Definition at line 246 of file KoToolProxy.cpp.

void KoToolProxy::mousePressEvent ( QMouseEvent *  event,
const QPointF &  point 
)

Forwarded to the current KoTool.

Definition at line 215 of file KoToolProxy.cpp.

void KoToolProxy::mouseReleaseEvent ( QMouseEvent *  event,
const QPointF &  point 
)

Forwarded to the current KoTool.

Definition at line 265 of file KoToolProxy.cpp.

void KoToolProxy::paint ( QPainter &  painter,
const KoViewConverter &  converter 
)

Forwarded to the current KoTool.

Definition at line 172 of file KoToolProxy.cpp.

bool KoToolProxy::paste (  ) 

Forwarded to the current KoTool.

Definition at line 374 of file KoToolProxy.cpp.

QList< QAction * > KoToolProxy::popupActionList (  )  const

Forwarded to the current KoTool.

Definition at line 390 of file KoToolProxy.cpp.

void KoToolProxy::repaintDecorations (  ) 

Forwarded to the current KoTool.

Definition at line 177 of file KoToolProxy.cpp.

KoToolSelection * KoToolProxy::selection (  ) 

Proxies for KoTool::selection().

Definition at line 332 of file KoToolProxy.cpp.

void KoToolProxy::selectionChanged ( bool  hasSelection  )  [signal]

A tool can have a selection that is copy-able, this signal is emitted when that status changes.

Parameters:
hasSelection is true when the tool holds selected data.
void KoToolProxy::setActiveTool ( KoTool *  tool  ) 

Set the new active tool.

Definition at line 339 of file KoToolProxy.cpp.

void KoToolProxy::setCanvasController ( KoCanvasController *  controller  )  [protected]

the toolManager tells us which KoCanvasController this toolProxy is working for.

Definition at line 351 of file KoToolProxy.cpp.

QStringList KoToolProxy::supportedPasteMimeTypes (  )  const

Forwarded to the current KoTool.

Definition at line 382 of file KoToolProxy.cpp.

void KoToolProxy::tabletEvent ( QTabletEvent *  event,
const QPointF &  point 
)

Forwarded to the current KoTool.

Definition at line 182 of file KoToolProxy.cpp.

void KoToolProxy::toolChanged ( const QString &  toolId  )  [signal]

Emitted every time a tool is changed.

Parameters:
toolId the id of the tool.
See also:
KoTool::toolId()
void KoToolProxy::wheelEvent ( QWheelEvent *  event,
const QPointF &  point 
)

Forwarded to the current KoTool.

Definition at line 313 of file KoToolProxy.cpp.

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