plasma-framework/widgets/lineedit.h
Stephen Kelly b1b68adb7d Don't use the QtGui module name in includes.
In Qt5, many of them are moved to QtWidgets, so this is the only
way to be source compatible with both Qt 4 and Qt 5.
2012-02-02 10:35:53 +01:00

151 lines
4.1 KiB
C++

/*
* 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_LINEEDIT_H
#define PLASMA_LINEEDIT_H
#include <QGraphicsProxyWidget>
class KLineEdit;
#include <plasma/plasma_export.h>
namespace Plasma
{
class LineEditPrivate;
/**
* @class LineEdit plasma/widgets/lineedit.h <Plasma/Widgets/LineEdit>
*
* @short Provides a plasma-themed KLineEdit.
*/
class PLASMA_EXPORT LineEdit : public QGraphicsProxyWidget
{
Q_OBJECT
Q_PROPERTY(QGraphicsWidget *parentWidget READ parentWidget)
Q_PROPERTY(QString text READ text WRITE setText NOTIFY textChanged)
Q_PROPERTY(bool clearButtonShown READ isClearButtonShown WRITE setClearButtonShown)
Q_PROPERTY(QString clickMessage READ clickMessage WRITE setClickMessage)
Q_PROPERTY(QString styleSheet READ styleSheet WRITE setStyleSheet)
Q_PROPERTY(KLineEdit *nativeWidget READ nativeWidget WRITE setNativeWidget)
public:
explicit LineEdit(QGraphicsWidget *parent = 0);
~LineEdit();
/**
* Sets the display text for this LineEdit
*
* @param text the text to display; should be translated.
*/
void setText(const QString &text);
/**
* @return the display text
*/
QString text() const;
/**
* Shows a button to clear the text
* @since 4.3
*/
void setClearButtonShown(bool show);
/**
* @return true if the clear button is set to be shown
* @since 4.3
*/
bool isClearButtonShown() const;
/**
* Sets a greyed out message that will go away after the user clicked the line edit
*
* @param message the message
* @since 4.5
*/
void setClickMessage(const QString &message);
/**
* @return the text of a greyed out message that will go away when clicked
* @since 4.5
*/
QString clickMessage() const;
/**
* Sets the stylesheet used to control the visual display of this LineEdit
*
* @param stylesheet a CSS string
*/
void setStyleSheet(const QString &stylesheet);
/**
* @return the stylesheet currently used with this widget
*/
QString styleSheet();
/**
* Sets the line edit wrapped by this LineEdit (widget must inherit KLineEdit), ownership is transferred to the LineEdit
*
* @param nativeWidget line edit that will be wrapped by this LineEdit
* @since KDE4.4
*/
void setNativeWidget(KLineEdit *nativeWidget);
/**
* @return the native widget wrapped by this LineEdit
*/
KLineEdit *nativeWidget() const;
protected:
void hoverEnterEvent(QGraphicsSceneHoverEvent *event);
void hoverLeaveEvent(QGraphicsSceneHoverEvent *event);
void changeEvent(QEvent *event);
void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget);
void mousePressEvent(QGraphicsSceneMouseEvent *event);
void focusInEvent(QFocusEvent *event);
void focusOutEvent(QFocusEvent *event);
Q_SIGNALS:
void editingFinished();
void returnPressed();
void textEdited(const QString &text);
/**
* Emitted when the text changes
* @since 4.4
*/
void textChanged(const QString &text);
/**
* Emitted when the widget receives or loses focus
* @since 4.7
*/
void focusChanged(bool focused);
private:
Q_PRIVATE_SLOT(d, void setPalette())
LineEditPrivate *const d;
};
} // namespace Plasma
#endif // multiple inclusion guard