2008-02-06 17:51:07 +01:00
|
|
|
/*
|
|
|
|
* 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_SVGPANEL_H
|
|
|
|
#define PLASMA_SVGPANEL_H
|
|
|
|
|
|
|
|
#include <QtCore/QObject>
|
2008-03-02 03:18:10 +01:00
|
|
|
#include <QtGui/QPixmap>
|
2008-02-06 17:51:07 +01:00
|
|
|
|
|
|
|
#include <plasma/plasma_export.h>
|
|
|
|
|
2008-02-06 20:12:21 +01:00
|
|
|
#include <plasma/plasma.h>
|
2008-02-06 17:51:07 +01:00
|
|
|
#include <plasma/svg.h>
|
|
|
|
|
|
|
|
class QPainter;
|
|
|
|
class QPoint;
|
|
|
|
class QPointF;
|
|
|
|
class QRect;
|
|
|
|
class QRectF;
|
|
|
|
class QSize;
|
|
|
|
class QSizeF;
|
|
|
|
class QMatrix;
|
|
|
|
|
|
|
|
namespace Plasma
|
|
|
|
{
|
|
|
|
|
|
|
|
class PLASMA_EXPORT SvgPanel : public QObject
|
|
|
|
{
|
|
|
|
Q_OBJECT
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* These flags represents what borders should be drawn
|
|
|
|
*/
|
2008-02-06 20:24:48 +01:00
|
|
|
enum BorderFlag { DrawTopBorder = 1,
|
|
|
|
DrawBottomBorder = 2,
|
|
|
|
DrawLeftBorder = 4,
|
|
|
|
DrawRightBorder = 8,
|
|
|
|
ContentAtOrigin = 16,
|
|
|
|
DrawAllBorders = DrawTopBorder | DrawBottomBorder |
|
|
|
|
DrawLeftBorder | DrawRightBorder
|
2008-02-06 17:51:07 +01:00
|
|
|
};
|
|
|
|
Q_DECLARE_FLAGS(BorderFlags, BorderFlag)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructs a new SvgPanel that paints the proper named subelements
|
|
|
|
* as borders
|
|
|
|
*
|
|
|
|
* The size is initialized to be the SVG's native size.
|
|
|
|
*
|
|
|
|
* @arg imagePath the image to show. If a relative path is passed, then
|
|
|
|
* Plasma::Theme is used to load the SVG.
|
|
|
|
* @arg parent options QObject to parent this to
|
|
|
|
*
|
|
|
|
* @related Plasma::Theme
|
|
|
|
*/
|
|
|
|
explicit SvgPanel(const QString& imagePath = QString(), QObject* parent = 0);
|
|
|
|
~SvgPanel();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Loads a new Svg
|
|
|
|
* @arg imagePath the new file
|
|
|
|
*/
|
|
|
|
void setFile(const QString& imagePath);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Convenience method to get the svg filepath and name of svg.
|
|
|
|
* @return the svg's filepath including name of the svg.
|
|
|
|
*/
|
|
|
|
QString file() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets what borders should be painted
|
|
|
|
* @arg flags borders we want to paint
|
|
|
|
*/
|
|
|
|
void setBorderFlags(const BorderFlags flags);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Convenience method to get the border flags
|
|
|
|
* @return what borders are painted
|
|
|
|
*/
|
|
|
|
BorderFlags borderFlags() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Resize the panel maintaining the same border size
|
|
|
|
* @arg size the new size of the panel
|
|
|
|
*/
|
|
|
|
void resize(const QSizeF& size);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the margin size given the margin edge we want
|
|
|
|
* @arg edge the margin edge we want, top, bottom, left or right
|
|
|
|
* @return the margin size
|
|
|
|
*/
|
2008-02-06 20:12:21 +01:00
|
|
|
qreal marginSize(const Plasma::MarginEdge edge) const;
|
2008-02-06 17:51:07 +01:00
|
|
|
|
2008-02-15 10:04:12 +01:00
|
|
|
/**
|
|
|
|
* Sets the position of the SvgPanel
|
|
|
|
* @arg pos where it should be positioned at
|
|
|
|
*/
|
|
|
|
void setPos( const QPointF& pos );
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the position of the SvgPanel
|
|
|
|
* @return the position
|
|
|
|
*/
|
|
|
|
QPointF pos() const;
|
|
|
|
|
2008-02-06 17:51:07 +01:00
|
|
|
/**
|
|
|
|
* Paints the loaded SVG with the elements that represents the border
|
|
|
|
* @arg painter the QPainter to use
|
|
|
|
* @arg rect the exposed rect to draw into
|
|
|
|
*/
|
|
|
|
Q_INVOKABLE void paint(QPainter* painter, const QRectF& rect);
|
|
|
|
|
2008-02-06 21:53:14 +01:00
|
|
|
Q_SIGNALS:
|
|
|
|
void repaintNeeded();
|
|
|
|
|
2008-02-06 17:51:07 +01:00
|
|
|
private slots:
|
|
|
|
//update sizes of the svg elements
|
|
|
|
void updateSizes();
|
|
|
|
|
|
|
|
private:
|
2008-02-06 19:49:14 +01:00
|
|
|
class Private;
|
|
|
|
Private * const d;
|
2008-02-06 17:51:07 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
} // Plasma namespace
|
2008-02-06 20:24:48 +01:00
|
|
|
|
|
|
|
Q_DECLARE_OPERATORS_FOR_FLAGS(Plasma::SvgPanel::BorderFlags)
|
|
|
|
|
2008-02-06 17:51:07 +01:00
|
|
|
#endif // multiple inclusion guard
|