/* * 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_PUSHBUTTON_H #define PLASMA_PUSHBUTTON_H #include <QtGui/QGraphicsProxyWidget> #include <kicon.h> class KPushButton; #include <plasma/plasma_export.h> namespace Plasma { class PushButtonPrivate; /** * @class PushButton plasma/widgets/pushbutton.h <Plasma/Widgets/PushButton> * * @short Provides a plasma-themed KPushButton. */ class PLASMA_EXPORT PushButton : 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(KPushButton *nativeWidget READ nativeWidget) Q_PROPERTY(QAction *action READ action WRITE setAction) Q_PROPERTY(QIcon icon READ icon WRITE setIcon) Q_PROPERTY(bool checkable READ isCheckable WRITE setCheckable) Q_PROPERTY(bool checked READ isChecked WRITE setChecked) Q_PROPERTY(bool down READ isDown) public: explicit PushButton(QGraphicsWidget *parent = 0); ~PushButton(); /** * Sets the display text for this PushButton * * @param 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. * * @param path the path to the image; if a relative path, then a themed image will be loaded. */ void setImage(const QString &path); /** * Sets the path to an svg image to display and the id of the used svg element, if necessary. * * @param path the path to the image; if a relative path, then a themed image will be loaded. * @param elementid the id of a svg element. * * @since 4.4 */ void setImage(const QString &path, const QString &elementid); /** * @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 PushButton * * @param stylesheet a CSS string */ void setStyleSheet(const QString &stylesheet); /** * @return the stylesheet currently used with this widget */ QString styleSheet(); /** * Associate an action with this IconWidget * this makes the button follow the state of the action, using its icon, text, etc. * when the button is clicked, it will also trigger the action. * * @since 4.3 */ void setAction(QAction *action); /** * @return the currently associated action, if any. * * @since 4.3 */ QAction *action() const; /** * sets the icon for this push button * * @param icon the icon to use * * @since 4.3 */ void setIcon(const QIcon &icon); /** * sets the icon for this push button using a KIcon * * @param icon the icon to use * * @since 4.4 */ void setIcon(const KIcon &icon); /** * @return the icon of this button * * @since 4.3 */ QIcon icon() const; /** * Sets whether or not this button can be toggled on/off * * @since 4.3 */ void setCheckable(bool checkable); /** * @return true if the button is checkable * @see setCheckable * @since 4.4 */ bool isCheckable() const; /** * @return true if the button is checked; requires setIsCheckable(true) to * be called * * @since 4.3 */ bool isChecked() const; /** * @return true if the button is pressed down * @since 4.4 */ bool isDown() const; /** * @return the native widget wrapped by this PushButton */ KPushButton *nativeWidget() const; Q_SIGNALS: /** * Emitted when the button is pressed down; usually the clicked() signal * will suffice, however. * @since 4.4 */ void pressed(); /** * Emitted when the button is released; usually the clicked() signal * will suffice, however. * @since 4.4 */ void released(); /** * Emitted when the button is pressed then released, completing a click */ void clicked(); /** * Emitted when the button changes state from up to down */ void toggled(bool); public Q_SLOTS: /** * Performs a visual click and emits the associated signals * @since 4.6 */ void click(); /** * Sets whether or not this button is checked. Implies setIsCheckable(true). * * @since 4.3 */ void setChecked(bool checked); protected: void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0); void resizeEvent(QGraphicsSceneResizeEvent *event); void hoverEnterEvent(QGraphicsSceneHoverEvent *event); void hoverLeaveEvent(QGraphicsSceneHoverEvent *event); void changeEvent(QEvent *event); QSizeF sizeHint(Qt::SizeHint which, const QSizeF & constraint) const; private: Q_PRIVATE_SLOT(d, void syncBorders()) Q_PRIVATE_SLOT(d, void setPixmap()) Q_PRIVATE_SLOT(d, void pressedChanged()) Q_PRIVATE_SLOT(d, void syncToAction()) Q_PRIVATE_SLOT(d, void clearAction()) Q_PRIVATE_SLOT(d, void setPalette()) friend class PushButtonPrivate; PushButtonPrivate *const d; }; } // namespace Plasma #endif // multiple inclusion guard