krita

KisTool Class Reference

Inheritance diagram for KisTool:

KisCanvasObserver KisToolNonPaint KisToolPaint KisToolDummy KisToolFreehand KisToolShape List of all members.

Detailed Description

Definition at line 61 of file kis_tool.h.


Public Slots

virtual void activate ()=0
virtual void deactivate ()=0

Public Member Functions

 KisTool (const QString &name)
virtual ~KisTool ()
virtual void paint (KisCanvasPainter &gc)=0
virtual void paint (KisCanvasPainter &gc, const QRect &rc)=0
virtual void setup (KActionCollection *collection)=0
virtual void enter (QEvent *e)=0
virtual void leave (QEvent *e)=0
virtual void buttonPress (KisButtonPressEvent *e)=0
virtual void move (KisMoveEvent *e)=0
virtual void buttonRelease (KisButtonReleaseEvent *e)=0
virtual void doubleClick (KisDoubleClickEvent *e)=0
virtual void keyPress (QKeyEvent *e)=0
virtual void keyRelease (QKeyEvent *e)=0
virtual QCursor cursor ()=0
virtual void setCursor (const QCursor &cursor)=0
virtual QWidget * createOptionWidget (QWidget *parent)
virtual QWidget * optionWidget ()
KRadioAction * action () const
virtual bool wantsAutoScroll () const
virtual Q_UINT32 priority ()
virtual enumToolType toolType ()
virtual QString icon ()
virtual QString quickHelp () const

Protected Attributes

KRadioAction * m_action
bool m_ownAction

Member Function Documentation

virtual void KisTool::activate (  )  [pure virtual, slot]

This slot is called when the tool is selected in the toolbox.

Implemented in KisToolNonPaint, and KisToolPaint.

QWidget * KisTool::createOptionWidget ( QWidget *  parent  )  [virtual]

This function is called to create the configuration widget of the tool.

Parameters:
parent the parent of the widget

Reimplemented in KisToolDummy, KisToolPaint, and KisToolShape.

Definition at line 56 of file kis_tool.cc.

virtual void KisTool::deactivate (  )  [pure virtual, slot]

deactivate is called when the tool gets deactivated because another tool is selected.

Tools can then clean up after themselves.

Implemented in KisToolNonPaint, and KisToolPaint.

QWidget * KisTool::optionWidget (  )  [virtual]

Returns:
the current configuration widget.

Reimplemented in KisToolDummy, and KisToolPaint.

Definition at line 65 of file kis_tool.cc.

virtual void KisTool::setup ( KActionCollection *  collection  )  [pure virtual]

This function is called after the creation of a tool to create the KAction corresponding to the tool.

The code should look like :

Implemented in KisToolDummy.

virtual bool KisTool::wantsAutoScroll (  )  const [inline, virtual]

Return true if this tool wants auto canvas-scrolling to work when this tool is active.

Definition at line 110 of file kis_tool.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys