framesvg.h

Go to the documentation of this file.

/*
 *   Copyright 2008 by Aaron Seigo <aseigo@kde.org>
 *   Copyright 2008 Marco Martin <notmart@gmail.com>
 *
 *   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_FRAMESVG_H
#define PLASMA_FRAMESVG_H

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

#include <plasma/plasma_export.h>

#include <plasma/plasma.h>
#include <plasma/svg.h>

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

namespace Plasma
{

class FrameSvgPrivate;

class PLASMA_EXPORT FrameSvg : public Svg
{
    Q_OBJECT

    Q_FLAGS(EnabledBorders)
    Q_PROPERTY(EnabledBorders enabledBorders READ enabledBorders WRITE setEnabledBorders)

    public:
        enum EnabledBorder {
            NoBorder = 0,
            TopBorder = 1,
            BottomBorder = 2,
            LeftBorder = 4,
            RightBorder = 8,
            AllBorders = TopBorder | BottomBorder | LeftBorder | RightBorder
        };
        Q_DECLARE_FLAGS(EnabledBorders, EnabledBorder)

        
        explicit FrameSvg(QObject *parent = 0);
        ~FrameSvg();

        Q_INVOKABLE void setImagePath(const QString &path);

        void setEnabledBorders(const EnabledBorders borders);

        EnabledBorders enabledBorders() const;

        Q_INVOKABLE void resizeFrame(const QSizeF &size);

        Q_INVOKABLE QSizeF frameSize() const;

        Q_INVOKABLE qreal marginSize(const Plasma::MarginEdge edge) const;

        Q_INVOKABLE void getMargins(qreal &left, qreal &top, qreal &right, qreal &bottom) const;

        Q_INVOKABLE QRectF contentsRect() const;

        Q_INVOKABLE void setElementPrefix(Plasma::Location location);

        Q_INVOKABLE void setElementPrefix(const QString & prefix);

        Q_INVOKABLE bool hasElementPrefix(const QString & prefix) const;

        Q_INVOKABLE bool hasElementPrefix(Plasma::Location location) const;

        Q_INVOKABLE QString prefix();

        Q_INVOKABLE QRegion mask() const;

        QPixmap alphaMask() const;

        Q_INVOKABLE void setCacheAllRenderedFrames(bool cache);

        Q_INVOKABLE bool cacheAllRenderedFrames() const;

        Q_INVOKABLE void clearCache();

        Q_INVOKABLE QPixmap framePixmap();

        Q_INVOKABLE void paintFrame(QPainter *painter, const QRectF &target,
                                    const QRectF &source = QRectF());

        Q_INVOKABLE void paintFrame(QPainter *painter, const QPointF &pos = QPointF(0, 0));

    private:
        FrameSvgPrivate *const d;
        friend class Applet;

        Q_PRIVATE_SLOT(d, void updateSizes())
        Q_PRIVATE_SLOT(d, void updateNeeded())
};

} // Plasma namespace

Q_DECLARE_OPERATORS_FOR_FLAGS(Plasma::FrameSvg::EnabledBorders)

#endif // multiple inclusion guard