plasma-framework/widgets/template.h

102 lines
2.5 KiB
C
Raw Normal View History

/*
* Copyright 2008 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_<NAME>_H
#define PLASMA_<NAME>_H
#include <QtGui/QGraphicsProxyWidget>
#include <plasma/plasma_export.h>
class <Native>;
namespace Plasma
{
class <Name>Private;
class PLASMA_EXPORT <Name> : public QGraphicsProxyWidget
{
Q_OBJECT
Q_PROPERTY(QGraphicsWidget* parentWidget READ parentWidget)
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_PROPERTY(<Native>* nativeWidget READ nativeWidget)
public:
explicit <Name>(QGraphicsWidget *parent = 0);
~<Name>();
/**
* Sets the display text for this <Name>
*
* @arg text the text to display; should be translated.
*/
void setText(const QString &text);
/**
* @return the display text
*/
QString text() const;
/**
* Sets the path to an image to display.
*
* @arg path the path to the image; if a relative path, then a themed image will be loaded.
*/
void setImage(const QString &path);
/**
* @return the image path being displayed currently, or an empty string if none.
*/
QString image() const;
/**
* Sets the stylesheet used to control the visual display of this <Name>
*
* @arg stylesheet a CSS string
*/
void setStyleSheet(const QString &stylesheet);
/**
* @return the stylesheet currently used with this widget
*/
QString styleSheet();
/**
* @return the native widget wrapped by this <Name>
*/
<Native>* nativeWidget() const;
Q_SIGNALS:
protected:
void resizeEvent(QGraphicsSceneResizeEvent *event);
private:
<Name>Private * const d;
};
} // namespace Plasma
#endif // multiple inclusion guard