workspace/plasma/applets/devicenotifier/notifierdialog.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 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 NOTIFIERDIALOG_H
  21 #define NOTIFIERDIALOG_H
  22
  23 //Qt
  24 #include <QWidget>
  25 #include <QStringList>
  26
  27 //solid
  28 #include <solid/solidnamespace.h>
  29
  30
  31 //to remove
  32 #include <QTreeView>
  33
  34 class QModelIndex;
  35 class QStandardItemModel;
  36 class QStandardItem;
  37 class QLabel;
  38
  39 //own
  40 class DeviceNotifier;
  41
  42 //desktop view
  43 namespace Plasma
  44 {
  45     class Icon;
  46     class Dialog;
  47 }
  48 namespace Solid
  49 {
  50     class Device;
  51 }
  52 namespace Notifier
  53 {
  54   class NotifierView;
  55
  56   /**
  57   * @short The panel used to display devices in a popup
  58   *
  59   */
  60   class NotifierDialog : public QObject
  61   {
  62   Q_OBJECT
  63
  64       public:
  65
  66
  67           ///Specific role for the data-model
  68           enum SpecificRoles {
  69               SolidUdiRole = Qt::UserRole + 1,
  70               PredicateFilesRole = Qt::UserRole + 2,
  71               ActionRole = Qt::UserRole + 3,
  72               IconNameRole = Qt::UserRole + 4,
  73               ScopeRole = Qt::UserRole + 5,
  74               SubTitleMandatoryRole = Qt::UserRole + 6
  75           };
  76
  77           /**
  78           * Constructor of the dialog
  79           * @param notifier the notifier attached to this dialog
  80           * @param area where the dialog is displayed
  81           * @param parent the parent of this object
  82           **/
  83           NotifierDialog(DeviceNotifier * notifier,QObject *parent = 0);
  84
  85           /**
  86           * Default destructor
  87           **/
  88           virtual ~NotifierDialog();
  89
  90           /**
  91           * Returns the related QWidget.
  92           **/
  93           QWidget * dialog();
  94
  95           /**
  96           * Hide the dialog
  97           **/
  98           void hide();
  99
 100           /**
 101           * Show the dialog
 102           **/
 103           void show();
 104
 105           /**
 106           * insert a device in the data-model of the dialog
 107           * @param name the name of the device
 108           **/
 109           void insertDevice(const QString &name);
 110
 111           void setUnMount(bool unmount,const QString &name);
 112
 113           /**
 114           * Allow to set data which will be displayed by the view
 115           * @param name the name of the device
 116           * @param data the data
 117           * @param role the role in the data-model
 118           **/
 119           void setDeviceData(const QString &name, QVariant data, int role);
 120
 121           /**
 122           * Allow to get a data display by the view
 123           * @param name the name of the device
 124           * @param role the role where is the data
 125           **/
 126           QVariant getDeviceData(const QString &name, int role);
 127
 128           /**
 129           * Remove a device in the dialog
 130           * @param name the name of the device
 131           **/
 132           void removeDevice(const QString &name);
 133
 134           /**
 135           * Remove a device in the view (provided by convenience)
 136           * @param index the index where the data will be delete
 137           **/
 138           void removeDevice(int index);
 139
 140           /**
 141           * Return the number of items displayed
 142           *
 143           **/
 144           int countDevices();
 145
 146           /**
 147           * get the udi of a device displayed in the dialog
 148           * @param index the index of the device
 149           **/
 150           QString getDeviceUdi(int index);
 151
 152       signals :
 153
 154           void itemSelected();
 155
 156       private slots:
 157           /**
 158           * @internal slot called when user has click on a item in the dialog
 159           * @param index the model index which is clicked
 160           **/
 161           void slotOnItemClicked(const QModelIndex & index);
 162
 163           /**
 164           * @internal slot called when an eject is finished
 165           * @param errorData the error if problem
 166           * @param error type of error given by solid
 167           **/
 168           void storageEjectDone(Solid::ErrorType error, QVariant errorData);
 169
 170           /**
 171           * @internal slot called when a storage tear is finished
 172           * @param errorData the error if problem
 173           * @param error type of error given by solid
 174           **/
 175           void storageTeardownDone(Solid::ErrorType error, QVariant errorData);
 176
 177           /**
 178           * @internal slot called to restore to the notifier his icon
 179           **/
 180           void resetNotifierIcon();
 181
 182           /**
 183           * @internal update the color of the label to follow plasma theme
 184           *
 185           **/
 186           void updateColors();
 187
 188
 189       private :
 190           /**
 191           * @internal build the dialog depending where it is
 192           **/
 193           void buildDialog();
 194
 195           /**
 196           * @internal get the model index in the data-model by using the udi in parameter
 197           * @param udi the udi used to find the model index
 198           **/
 199           QModelIndex indexForUdi(const QString &udi) const;
 200
 201           ///The data-model used to store devices
 202           QStandardItemModel *m_hotplugModel;
 203
 204           // The widget which display the panel
 205           QWidget *m_widget;
 206           ///The tree view used to display the content
 207           NotifierView *m_notifierView;
 208
 209           ///QLabel which represent the title
 210           QLabel * m_label;
 211
 212           ///The applet attached to this item
 213           DeviceNotifier * m_notifier;
 214
 215           ///Root item in treeview
 216           QStandardItem *m_rootItem;
 217
 218           /**
 219           * @internal Search a category with same name. If not find, create a new category in top of treeview
 220           * @param categoryName the name of the category for device
 221           **/
 222           QStandardItem* searchOrCreateDeviceCategory(const QString &categoryName);
 223
 224           /**
 225           * @internal get The category name of a device plugged
 226           * @param device the solid device plugged in hardware
 227           **/
 228           QString getCategoryNameOfDevice(const Solid::Device& device);
 229   };
 230
 231 }
 232
 233 #endif
 234