kstatusnotifieritem.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright 2009 by Marco Martin <notmart@gmail.com>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License (LGPL) as published by the Free Software Foundation;
   either version 2 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KSTATUSNOTIFIERITEM_H
#define KSTATUSNOTIFIERITEM_H

#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtDBus/QDBusArgument>
#include <QtCore/QPoint>

#include "kdeui_export.h"

class KActionCollection;
class KMenu;
class QMovie;


class KStatusNotifierItemPrivate;

class KDEUI_EXPORT KStatusNotifierItem : public QObject
{
    Q_OBJECT

    Q_ENUMS(ItemStatus)
    Q_ENUMS(ItemCategory)
    Q_PROPERTY( ItemCategory category READ category WRITE setCategory )
    Q_PROPERTY( QString title READ title WRITE setTitle )
    Q_PROPERTY( ItemStatus status READ status WRITE setStatus )
    Q_PROPERTY( QString iconName READ iconName WRITE setIconByName )
    Q_PROPERTY( QString overlayIconName READ overlayIconName WRITE setOverlayIconByName )
    Q_PROPERTY( QString attentionIconName READ attentionIconName WRITE setAttentionIconByName )
    Q_PROPERTY( QString toolTipIconName READ toolTipIconName WRITE setToolTipIconByName )
    Q_PROPERTY( QString toolTipTitle READ toolTipTitle WRITE setToolTipTitle )
    Q_PROPERTY( QString toolTipSubTitle READ toolTipSubTitle WRITE setToolTipSubTitle )

    friend class KStatusNotifierItemDBus;
    friend class KStatusNotifierItemPrivate;
public:
    enum ItemStatus {
        Passive = 1,
        Active = 2,
        NeedsAttention = 3
    };

    enum ItemCategory {
        ApplicationStatus = 1,
        Communications = 2,
        SystemServices = 3,
        Hardware = 4,
        Reserved = 129
    };

    explicit KStatusNotifierItem(QObject *parent = 0);

    explicit KStatusNotifierItem(const QString &id, QObject *parent = 0);

    ~KStatusNotifierItem();

    QString id() const;

    void setCategory(const ItemCategory category);

    ItemCategory category() const;

    void setTitle(const QString &title);

    QString title() const;

    void setStatus(const ItemStatus status);

    ItemStatus status() const;

    //Main icon related functions
    void setIconByName(const QString &name);

    QString iconName() const;

    void setIconByPixmap(const QIcon &icon);

    QIcon iconPixmap() const;

    void setOverlayIconByName(const QString &name);

    QString overlayIconName() const;

    void setOverlayIconByPixmap(const QIcon &icon);

    QIcon overlayIconPixmap() const;

    //Requesting attention icon

    void setAttentionIconByName(const QString &name);

    QString attentionIconName() const;

    void setAttentionIconByPixmap(const QIcon &icon);

    QIcon attentionIconPixmap() const;

    void setAttentionMovieByName(const QString &name);

    QString attentionMovieName() const;


    //ToolTip handling
    void setToolTip(const QString &iconName, const QString &title, const QString &subTitle);

    void setToolTip(const QIcon &icon, const QString &title, const QString &subTitle);

    void setToolTipIconByName(const QString &name);

    QString toolTipIconName() const;

    void setToolTipIconByPixmap(const QIcon &icon);

    QIcon toolTipIconPixmap() const;

    void setToolTipTitle(const QString &title);

    QString toolTipTitle() const;

    void setToolTipSubTitle(const QString &subTitle);

    QString toolTipSubTitle() const;

    void setContextMenu(KMenu *menu);

    KMenu *contextMenu() const;

    void setAssociatedWidget(QWidget *parent);

    QWidget *associatedWidget() const;

    KActionCollection *actionCollection() const;

    void setStandardActionsEnabled(bool enabled);

    bool standardActionsEnabled() const;

    void showMessage(const QString &title, const QString &message, const QString &icon, int timeout = 10000);


public Q_SLOTS:

    virtual void activate(const QPoint &pos = QPoint());

Q_SIGNALS:
    void scrollRequested(int delta, Qt::Orientation orientation);

    void activateRequested(bool active, const QPoint &pos);

    void secondaryActivateRequested(const QPoint &pos);

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

private:
    KStatusNotifierItemPrivate *const d;

    Q_PRIVATE_SLOT(d, void serviceChange(const QString& name,
                                         const QString& oldOwner,
                                         const QString& newOwner))
    Q_PRIVATE_SLOT(d, void checkForRegisteredHosts())
    Q_PRIVATE_SLOT(d, void registerToDaemon())
    Q_PRIVATE_SLOT(d, void contextMenuAboutToShow())
    Q_PRIVATE_SLOT(d, void maybeQuit())
    Q_PRIVATE_SLOT(d, void minimizeRestore())
    Q_PRIVATE_SLOT(d, void hideMenu())
    Q_PRIVATE_SLOT(d, void legacyWheelEvent(int))
    Q_PRIVATE_SLOT(d, void legacyActivated(QSystemTrayIcon::ActivationReason))
};

#endif