frame.h

Go to the documentation of this file.

/*
 *   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_FRAME_H
#define PLASMA_FRAME_H

#include <QtGui/QGraphicsWidget>

#include <plasma/plasma_export.h>
#include <plasma/framesvg.h>

class QFrame;

namespace Plasma
{

class FramePrivate;

class PLASMA_EXPORT Frame : public QGraphicsWidget
{
    Q_OBJECT
    Q_PROPERTY(Shadow frameShadow READ frameShadow WRITE setFrameShadow)
    Q_PROPERTY(QString text READ text WRITE setText)
    Q_PROPERTY(QString image READ image WRITE setImage)
    Q_PROPERTY(QString styleSheet READ styleSheet WRITE setStyleSheet)
    Q_ENUMS(Shadow)

public:
    enum Shadow {
        Plain = 1,
        Raised = 2,
        Sunken = 3
    };

    explicit Frame(QGraphicsWidget *parent = 0);
    ~Frame();

    void setFrameShadow(Shadow shadow);

    Shadow frameShadow() const;

    void setEnabledBorders(const FrameSvg::EnabledBorders borders);

    FrameSvg::EnabledBorders enabledBorders() const;

    void setText(QString text);

    QString text() const;

    void setImage(const QString &path);

    QString image() const;

    void setStyleSheet(const QString &stylesheet);

    QString styleSheet() const;

    QWidget *nativeWidget() const;

protected:
    void paint(QPainter *painter,
               const QStyleOptionGraphicsItem *option,
               QWidget *widget = 0);

    void resizeEvent(QGraphicsSceneResizeEvent *event);
    QSizeF sizeHint(Qt::SizeHint which, const QSizeF & constraint) const;
    void changeEvent(QEvent *event);

private:
    FramePrivate * const d;

    Q_PRIVATE_SLOT(d, void syncBorders())
    Q_PRIVATE_SLOT(d, void setPalette())
};

} // namespace Plasma

#endif // multiple inclusion guard