plasma-framework/widgets/label.h

184 lines
4.9 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_LABEL_H
#define PLASMA_LABEL_H
#include <QtGui/QGraphicsProxyWidget>
#include <plasma/plasma_export.h>
#include <plasma/dataengine.h>
class QLabel;
namespace Plasma
{
class LabelPrivate;
/**
* @class Label plasma/widgets/label.h <Plasma/Widgets/Label>
*
* @short Provides a plasma-themed QLabel.
*/
class PLASMA_EXPORT Label : 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(Qt::Alignment alignment READ alignment WRITE setAlignment)
Q_PROPERTY(bool hasScaledContents READ hasScaledContents WRITE setScaledContents)
Q_PROPERTY(bool textSelectable READ textSelectable WRITE setTextSelectable)
Q_PROPERTY(bool wordWrap READ wordWrap WRITE setWordWrap)
Q_PROPERTY(QString styleSheet READ styleSheet WRITE setStyleSheet)
Q_PROPERTY(QLabel *nativeWidget READ nativeWidget)
public:
/**
* Constructs a label with word wrap on by default
*
* @arg parent the parent of this widget
*/
explicit Label(QGraphicsWidget *parent = 0);
~Label();
/**
* Sets the display text for this Label
*
* @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 alignment for the text
*
* @arg the desired alignment
*/
void setAlignment(Qt::Alignment alignment);
/**
* @return the alignment for the text used in the labels
*/
Qt::Alignment alignment() const;
/**
* Scale or not the contents of the label to the label size
*
* @arg scale
*/
void setScaledContents(bool scaled);
/**
* @return true if the contents are scaled to the label size
*/
bool hasScaledContents() const;
/**
* Set if the text on the label can be selected with the mouse
*
* @arg enable true if we want to manage text selection with the mouse
* @since 4.4
*/
void setTextSelectable(bool enable);
/**
* @return true if the text is selectable with the mouse
* @since 4.4
*/
bool textSelectable() const;
/**
* Sets if the text of the label can wrap in multiple lines
*
* @arg wrap multiple lines or not
* @since 4.5
*/
void setWordWrap(bool wrap);
/**
* @return true if the label text can wrap in multiple lines if too long
* @since 4.5
*/
bool wordWrap() const;
/**
* Sets the stylesheet used to control the visual display of this Label
*
* @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 Label
*/
QLabel *nativeWidget() const;
Q_SIGNALS:
void linkActivated(const QString &link);
void linkHovered(const QString &link);
public Q_SLOTS:
void dataUpdated(const QString &sourceName, const Plasma::DataEngine::Data &data);
protected:
void resizeEvent(QGraphicsSceneResizeEvent *event);
void mousePressEvent(QGraphicsSceneMouseEvent *event);
void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
void paint(QPainter *painter,
const QStyleOptionGraphicsItem *option,
QWidget *widget);
void changeEvent(QEvent *event);
bool event(QEvent *event);
void contextMenuEvent(QGraphicsSceneContextMenuEvent *event);
private:
Q_PRIVATE_SLOT(d, void setPalette())
Q_PRIVATE_SLOT(d, void setPixmap())
LabelPrivate * const d;
};
} // namespace Plasma
#endif // multiple inclusion guard