krita/ui

kis_canvas_decoration.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2008 Cyrille Berger <cberger@cberger.net>
00003  *
00004  *  This program is free software; you can redistribute it and/or modify
00005  *  it under the terms of the GNU General Public License as published by
00006  *  the Free Software Foundation; either version 2 of the License, or
00007  *  (at your option) any later version.
00008  *
00009  *  This program is distributed in the hope that it will be useful,
00010  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00011  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012  *  GNU General Public License for more details.
00013  *
00014  *  You should have received a copy of the GNU General Public License
00015  *  along with this program; if not, write to the Free Software
00016  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00017  */
00018 
00019 #ifndef _KIS_CANVAS_DECORATION_H_
00020 #define _KIS_CANVAS_DECORATION_H_
00021 
00022 #include <QObject>
00023 #include <krita_export.h>
00024 
00025 class QPoint;
00026 class QRect;
00027 class QPainter;
00028 class KoViewConverter;
00029 class KisView2;
00030 
00035 class KRITAUI_EXPORT KisCanvasDecoration : public QObject
00036 {
00037     Q_OBJECT
00038 public:
00039     KisCanvasDecoration(const QString& id, const QString& name, KisView2 * parent);
00040     ~KisCanvasDecoration();
00041     const QString& id() const;
00042     const QString& name() const;
00046     bool visible() const;
00052     void paint(QPainter& gc, const QPoint & documentOffset, const QRect& area, const KoViewConverter &converter);
00053 public slots:
00057     void setVisible(bool v);
00061     void toggleVisibility();
00062 protected:
00063     virtual void drawDecoration(QPainter& gc, const QPoint & documentOffset, const QRect& area, const KoViewConverter &converter) = 0;
00067     KisView2* view() const;
00068 private:
00069     struct Private;
00070     Private* const d;
00071 };
00072 
00073 #endif