vtool.h

/* This file is part of the KDE project
   Copyright (C) 2001, 2002, 2003 The Karbon Developers
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/
 
#ifndef __VTOOL_H__
#define __VTOOL_H__
 
#include <tqobject.h>
#include <tdeaction.h>
#include <tdelocale.h>
#include <KoPoint.h>
#include <koffice_export.h>
class TDERadioAction;
class KarbonPart;
class KarbonView;
class TQEvent;
class TQWidget;
class VPainter;
class VToolController;
 
enum enumToolType
{
    TOOL_SELECT = 0,       // 
    TOOL_FREEHAND = 1,     //
    TOOL_SHAPE = 2,        // Geometric shapes like ellipses and lines
    TOOL_MANIPULATION = 3, //
    TOOL_MISC = 4          //
};

class KARBONBASE_EXPORT VTool : public TQObject
{
    TQ_OBJECT
  
 
public:
    VTool( KarbonView *view, const char* name );
    // Make VTool "abstract":
    
    virtual ~VTool();

    virtual void registerTool( VTool *tool );

    virtual void deactivate() {}

    virtual bool showDialog() const { return false; }

    virtual TQString uiname() { return i18n( "Unnamed Tool" ); }

    virtual TQString contextHelp() { return i18n( "This tool has no description." ); }

    virtual enumToolType toolType() { return TOOL_MISC; }

    virtual TQString statusText() { return ""; }

    virtual uint priority() { return 0; }

    TQString icon() { return m_action->icon(); }

    bool mouseEvent( TQMouseEvent* event, const KoPoint& );

    bool keyEvent( TQEvent* event );

    virtual void refreshUnit() {}

    virtual void setup(TDEActionCollection *) {}

    TDERadioAction *action() const { return m_action; }

    virtual void draw( VPainter* painter ) { Q_UNUSED( painter ); }
 
public slots:
    virtual void activate();
 
protected:
    bool isDragging() const { return m_isDragging; }
 
    virtual void draw( /*VPainter* painter*/ ) {}

    virtual void setCursor() const {}

    virtual void mouseButtonPress() {}

    virtual void rightMouseButtonPress() {}

    virtual void mouseButtonRelease() {}

    virtual void rightMouseButtonRelease() {}

    virtual void mouseButtonDblClick() {}

    virtual void mouseMove() {}

    virtual void mouseDrag() {}

    virtual void mouseDragRelease() {}

    virtual void mouseDragShiftPressed() {}

    virtual void mouseDragCtrlPressed() {}

    virtual void mouseDragShiftReleased() {}

    virtual void mouseDragCtrlReleased() {}

    virtual void arrowKeyReleased( TQt::Key ) {}

    virtual bool keyReleased( TQt::Key ) { return false; }

    virtual void cancel() {}

    virtual void cancelStep() {}

    virtual void accept() {}

//  KarbonPart* part() const { return m_part; }

    KarbonView* view() const;

    const KoPoint& first() const { return m_firstPoint; }

    const KoPoint& last() const { return m_lastPoint; }

    bool shiftPressed() const { return m_shiftPressed; }

    bool ctrlPressed() const { return m_ctrlPressed; }

    bool altPressed() const { return m_altPressed; }

    TDERadioAction *m_action;

    VToolController *toolController() const;
 
private:
    KarbonView *m_view;

    KoPoint m_firstPoint;

    KoPoint m_lastPoint;

    bool m_mouseButtonIsDown;

    bool m_isDragging;

    bool m_shiftPressed;

    bool m_ctrlPressed;

    bool m_altPressed;
};
 
#endif