svg.h

Go to the documentation of this file.

/*
 *   Copyright 2006-2007 Aaron Seigo <aseigo@kde.org>
 *
 *   This program 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, or
 *   (at your option) any later version.
 *
 *   This program 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 General Public License for more details
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef PLASMA_SVG_H
#define PLASMA_SVG_H

#include <QtCore/QObject>
#include <QtGui/QPixmap>

#include <plasma/plasma_export.h>

class QPainter;
class QPoint;
class QPointF;
class QRect;
class QRectF;
class QSize;
class QSizeF;
class QMatrix;

namespace Plasma
{

class FrameSvgPrivate;
class SvgPrivate;
class Theme;

class PLASMA_EXPORT Svg : public QObject
{
    Q_OBJECT
    Q_ENUMS(ContentType)
    Q_PROPERTY(QSize size READ size WRITE resize NOTIFY sizeChanged)
    Q_PROPERTY(bool multipleImages READ containsMultipleImages WRITE setContainsMultipleImages)
    Q_PROPERTY(QString imagePath READ imagePath WRITE setImagePath)
    Q_PROPERTY(bool usingRenderingCache READ isUsingRenderingCache WRITE setUsingRenderingCache)

    public:
        explicit Svg(QObject *parent = 0);
        ~Svg();

        Q_INVOKABLE QPixmap pixmap(const QString &elementID = QString());

        Q_INVOKABLE void paint(QPainter *painter, const QPointF &point,
                               const QString &elementID = QString());

        Q_INVOKABLE void paint(QPainter *painter, int x, int y,
                               const QString &elementID = QString());

        Q_INVOKABLE void paint(QPainter *painter, const QRectF &rect,
                               const QString &elementID = QString());

        Q_INVOKABLE void paint(QPainter *painter, int x, int y, int width,
                               int height, const QString &elementID = QString());

        QSize size() const;

        Q_INVOKABLE void resize(qreal width, qreal height);

        Q_INVOKABLE void resize(const QSizeF &size);

        Q_INVOKABLE void resize();

        Q_INVOKABLE QSize elementSize(const QString &elementId) const;

        Q_INVOKABLE QRectF elementRect(const QString &elementId) const;

        Q_INVOKABLE bool hasElement(const QString &elementId) const;

        Q_INVOKABLE QString elementAtPoint(const QPoint &point) const;

        Q_INVOKABLE bool isValid() const;

        void setContainsMultipleImages(bool multiple);

        bool containsMultipleImages() const;

        void setImagePath(const QString &svgFilePath);

        QString imagePath() const;

        void setUsingRenderingCache(bool useCache);

        bool isUsingRenderingCache() const;

        void setTheme(Plasma::Theme *theme);

        Theme *theme() const;

    Q_SIGNALS:
        void repaintNeeded();
        void sizeChanged();

    private:
        SvgPrivate *const d;

        Q_PRIVATE_SLOT(d, void themeChanged())
        Q_PRIVATE_SLOT(d, void colorsChanged())

        friend class SvgPrivate;
        friend class FrameSvgPrivate;
        friend class FrameSvg;
};

} // Plasma namespace

#endif // multiple inclusion guard