popupapplet.h

Go to the documentation of this file.

/*
 * Copyright 2008 by Montel Laurent <montel@kde.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

#ifndef PLASMA_POPUPAPPLET_H
#define PLASMA_POPUPAPPLET_H

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

class QGraphicsProxyWidget;
class QGraphicsLinearLayout;

namespace Plasma
{

class Dialog;
class IconWidget;
class PopupAppletPrivate;

class PLASMA_EXPORT PopupApplet : public Plasma::Applet
{
    Q_OBJECT
    Q_PROPERTY(Qt::AlignmentFlag popupAlignment READ popupAlignment WRITE setPopupAlignment)

public:
    PopupApplet(QObject *parent, const QVariantList &args);
    ~PopupApplet();

    void setPopupIcon(const QIcon &icon);

    void setPopupIcon(const QString &iconName);

    QIcon popupIcon() const;

    virtual QWidget *widget();
    void setWidget(QWidget * widget);

    virtual QGraphicsWidget *graphicsWidget();
    void setGraphicsWidget(QGraphicsWidget * widget);

    Plasma::PopupPlacement popupPlacement() const;

    void setPopupAlignment(Qt::AlignmentFlag alignment);

    Qt::AlignmentFlag popupAlignment() const;

    void setPassivePopup(bool passive);

    bool isPassivePopup() const;

    bool isPopupShowing() const;

    bool isIconified() const;


public Q_SLOTS:
    void hidePopup();

    void showPopup(uint displayTime = 0);

    void togglePopup();

protected:
    virtual void popupEvent(bool show);

    QSizeF sizeHint(Qt::SizeHint which, const QSizeF & constraint = QSizeF()) const;

    void mousePressEvent(QGraphicsSceneMouseEvent *event);

    void mouseReleaseEvent(QGraphicsSceneMouseEvent *event);

    bool eventFilter(QObject *watched, QEvent *event);

    void dragEnterEvent(QGraphicsSceneDragDropEvent *event);

    void dragLeaveEvent(QGraphicsSceneDragDropEvent *event);

    void dropEvent(QGraphicsSceneDragDropEvent *event);

    void timerEvent(QTimerEvent *event);

private:
    PopupApplet(const QString &packagePath, uint appletId, const QVariantList &args);

    Q_PRIVATE_SLOT(d, void internalTogglePopup())
    Q_PRIVATE_SLOT(d, void hideTimedPopup())
    Q_PRIVATE_SLOT(d, void clearPopupLostFocus())
    Q_PRIVATE_SLOT(d, void dialogSizeChanged())
    Q_PRIVATE_SLOT(d, void dialogStatusChanged(bool))
    Q_PRIVATE_SLOT(d, void updateDialogPosition())
    Q_PRIVATE_SLOT(d, void appletActivated())
    Q_PRIVATE_SLOT(d, void iconSizeChanged(int))
    Q_PRIVATE_SLOT(d, void statusChangeWhileShown(Plasma::ItemStatus status))

    friend class Applet;
    friend class AppletPrivate;
    friend class Extender;
    friend class PopupAppletPrivate;
    PopupAppletPrivate * const d;
};

} // Plasma namespace

#endif /* POPUPAPPLET_H */