workspace/plasma/applets/devicenotifier/devicenotifier.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Alexis Ménard <darktears31@gmail.com>           *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA .        *
  18  ***************************************************************************/
  19
  20 #ifndef DEVICENOTIFIER_H
  21 #define DEVICENOTIFIER_H
  22
  23 //Solid
  24 #include <solid/solidnamespace.h>
  25
  26 //Plasma
  27 #include <Plasma/PopupApplet>
  28 #include <Plasma/DataEngine>
  29 #include <Plasma/ToolTipManager>
  30
  31 class QStandardItemModel;
  32 class QGraphicsLinearLayout;
  33 class QGraphicsProxyWidget;
  34 class QTimer;
  35
  36 class KIcon;
  37
  38 namespace Notifier
  39 {
  40     class NotifierDialog;
  41 }
  42
  43 //desktop view
  44 namespace Plasma
  45 {
  46     class IconWidget;
  47 }
  48
  49 /**
  50 * @short Applet used to display hot plug devices
  51 *
  52 */
  53 class DeviceNotifier : public Plasma::PopupApplet
  54 {
  55     Q_OBJECT
  56
  57     public:
  58         /**
  59         * Constructor of the applet
  60         * @param parent the parent of this object
  61         **/
  62         DeviceNotifier(QObject *parent, const QVariantList &args);
  63
  64         /**
  65         * Default destructor
  66         **/
  67         ~DeviceNotifier();
  68
  69         /**
  70         * initialize the applet (called by plasma automatically)
  71         **/
  72         void init();
  73
  74         /**
  75         *  allow to change the icon of the notifier if this applet is in icon mode
  76         **/
  77         void changeNotifierIcon(const QString& name = QString());
  78
  79         /**
  80          * The widget that displays the list of devices.
  81          */
  82         QWidget *widget();
  83
  84     protected:
  85         void popupEvent(bool show);
  86
  87     public slots:
  88         /**
  89          * @internal Sets the tooltip content properly before showing.
  90          */
  91          void toolTipAboutToShow();
  92
  93         /**
  94          * @internal Clears memory when needed.
  95          */
  96          void toolTipHidden();
  97
  98     protected slots:
  99         /**
 100         * slot called when a source/device is added in the hotplug engine
 101         * @param name the name of the new source
 102         **/
 103         void onSourceAdded(const QString &name);
 104
 105         /**
 106         * @internal slot called when a source/device is removed in the hotplug engine
 107         * @param name the name of the removed source
 108         **/
 109         void onSourceRemoved(const QString &name);
 110
 111         /**
 112         * slot called when a source of the hotplug engine is updated
 113         * @param source the name of the source
 114         * @param data the data of the source
 115         **/
 116         void dataUpdated(const QString &source, Plasma::DataEngine::Data data);
 117
 118     private:
 119         /**
 120         * @internal Used to fill the notifier from previous plugged devices
 121         **/
 122         void fillPreviousDevices();
 123
 124         /**
 125          * @internal Used to popup the device view.
 126          */
 127         void notifyDevice(const QString &name);
 128
 129         /**
 130          * @internal Used to remove the last device notification.
 131          */
 132         void removeLastDeviceNotification(const QString &name);
 133
 134         ///the engine used to get hot plug devices
 135         Plasma::DataEngine *m_solidEngine;
 136
 137         ///The engine used to manage devices in the applet (unmount,...)
 138         Plasma::DataEngine *m_solidDeviceEngine;
 139
 140         ///the icon used when the applet is in the taskbar
 141         Plasma::IconWidget *m_icon;
 142
 143         ///default icon of the notifier
 144         QString m_iconName;
 145
 146         ///The dialog where devices are displayed
 147         Notifier::NotifierDialog * m_dialog;
 148
 149         ///the time durin when the dialog will be show
 150         int m_displayTime;
 151
 152         ///the number of items displayed in the dialog
 153         int m_numberItems;
 154
 155         ///the time during when the item will be displayed
 156         int m_itemsValidity;
 157
 158         ///the timer for different use cases
 159         QTimer *m_timer;
 160
 161         ///bool to know if notifications are enabled
 162         bool isNotificationEnabled;
 163
 164         ///last plugged udi
 165         QList<QString> m_lastPlugged;
 166
 167         ///true if fillPreviousDevices is running
 168         bool m_fillingPreviousDevices;
 169 };
 170
 171 #endif