workspace/plasma/shells/common/plasmaappletitemmodel.cpp

   1 /*
   2  *   Copyright (C) 2007 Ivan Cukic <ivan.cukic+kde@gmail.com>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU Library/Lesser General Public License
   6  *   version 2, or (at your option) any later version, as published by the
   7  *   Free Software Foundation
   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 Library/Lesser General Public
  15  *   License 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 #include "plasmaappletitemmodel_p.h"
  21
  22 #include <KSycoca>
  23
  24 PlasmaAppletItem::PlasmaAppletItem(PlasmaAppletItemModel *model,
  25                                    const QMap<QString, QVariant>& info,
  26                                    FilterFlags flags,
  27                                    QMap<QString, QVariant> *extraAttrs)
  28     : QObject(model), m_model(model)
  29 {
  30     QMap<QString, QVariant> attrs(info);
  31
  32     attrs.insert("favorite", flags & Favorite ? true : false);
  33     attrs.insert("used", flags & Used ? true : false);
  34     //attrs.insert("recommended", flags & Recommended ? true : false);
  35     if (extraAttrs) {
  36         attrs.unite(* extraAttrs);
  37     }
  38     setText(info["name"].toString() + " - "+ info["category"].toString());
  39     setData(attrs);
  40     setIcon(qvariant_cast<QIcon>(info["icon"]));
  41 }
  42
  43 QString PlasmaAppletItem::name() const
  44 {
  45     return data().toMap()["name"].toString();
  46 }
  47
  48 QString PlasmaAppletItem::pluginName() const
  49 {
  50     return data().toMap()["pluginName"].toString();
  51 }
  52
  53 QString PlasmaAppletItem::description() const
  54 {
  55     return data().toMap()["description"].toString();
  56 }
  57
  58 int PlasmaAppletItem::running() const
  59 {
  60     return data().toMap()["runningCount"].toInt();
  61 }
  62
  63 bool PlasmaAppletItem::used() const
  64 {
  65     return data().toMap()["used"].toBool();
  66 }
  67
  68 void PlasmaAppletItem::setFavorite(bool favorite)
  69 {
  70     QMap<QString, QVariant> attrs = data().toMap();
  71     attrs.insert("favorite", favorite ? true : false);
  72     setData(QVariant(attrs));
  73
  74     QString pluginName = attrs["pluginName"].toString();
  75     m_model->setFavorite(pluginName, favorite);
  76 }
  77
  78 void PlasmaAppletItem::setRunning(int count)
  79 {
  80     QMap<QString, QVariant> attrs = data().toMap();
  81     attrs.insert("running", count > 0); //bool for the filter
  82     attrs.insert("runningCount", count);
  83     setData(QVariant(attrs));
  84 }
  85
  86 void PlasmaAppletItem::setUsed(bool used)
  87 {
  88     QMap<QString, QVariant> attrs = data().toMap();
  89     attrs.insert("used", used);
  90     setData(QVariant(attrs));
  91 }
  92
  93 bool PlasmaAppletItem::passesFiltering(
  94         const KCategorizedItemsViewModels::Filter & filter) const
  95 {
  96     return data().toMap()[filter.first] == filter.second;
  97 }
  98
  99 QVariantList PlasmaAppletItem::arguments() const
 100 {
 101     return qvariant_cast<QVariantList>(data().toMap()["arguments"]);
 102 }
 103
 104 PlasmaAppletItemModel::PlasmaAppletItemModel(KConfigGroup configGroup, QObject * parent) :
 105     KCategorizedItemsViewModels::DefaultItemModel(parent),
 106     m_configGroup(configGroup)
 107 {
 108     m_used = m_configGroup.readEntry("used").split(',');
 109     m_favorites = m_configGroup.readEntry("favorites").split(',');
 110     connect(KSycoca::self(), SIGNAL(databaseChanged()), this, SLOT(populateModel()));
 111 }
 112
 113 void PlasmaAppletItemModel::populateModel()
 114 {
 115     clear();
 116     //kDebug() << "populating model, our application is" << m_application;
 117
 118     // Recommended emblems and filters
 119     QRegExp rx("recommended[.]([0-9A-Za-z]+)[.]plugins");
 120     QMapIterator<QString, QString> i(m_configGroup.entryMap());
 121     QMap < QString, QMap < QString, QVariant > > extraPluginAttrs;
 122     while (i.hasNext()) {
 123         i.next();
 124         if (!rx.exactMatch(i.key())) {
 125             continue;
 126         }
 127         QString id = rx.cap(1);
 128
 129         foreach (const QString &plugin, i.value().split(',')) {
 130             extraPluginAttrs[plugin]["recommended." + id] = true;
 131         }
 132     }
 133
 134     //TODO: get recommended, favorite, used, etc out of listAppletInfo()
 135     //kDebug() << "number of applets is"
 136     //         <<  Plasma::Applet::listAppletInfo(QString(), m_application).count();
 137     foreach (const KPluginInfo &info, Plasma::Applet::listAppletInfo(QString(), m_application)) {
 138         //kDebug() << info.pluginName() << "NoDisplay" << info.property("NoDisplay").toBool();
 139         if (info.property("NoDisplay").toBool() || info.category() == i18n("Containments")) {
 140             // we don't want to show the hidden category
 141             continue;
 142         }
 143         //kDebug() << info.pluginName() << " is the name of the plugin\n";
 144
 145         QMap<QString, QVariant> attrs;
 146         attrs.insert("name", info.name());
 147         attrs.insert("pluginName", info.pluginName());
 148         attrs.insert("description", info.comment());
 149         attrs.insert("category", info.category());
 150         attrs.insert("icon",
 151                      static_cast<QIcon>(KIcon(info.icon().isEmpty() ?
 152                                               "application-x-plasma" : info.icon())));
 153
 154         appendRow(new PlasmaAppletItem(this, attrs,((m_favorites.contains(info.pluginName())) ? PlasmaAppletItem::Favorite : PlasmaAppletItem::NoFilter) | ((m_used.contains(info.pluginName())) ? PlasmaAppletItem::Used : PlasmaAppletItem::NoFilter), &(extraPluginAttrs[info.pluginName()])));
 155     }
 156 }
 157
 158 void PlasmaAppletItemModel::setRunningApplets(const QHash<QString, int> &apps)
 159 {
 160     //foreach item, find that string and set the count
 161     for (int r=0; r<rowCount(); ++r) {
 162         QStandardItem *i = item(r);
 163         PlasmaAppletItem *p = dynamic_cast<PlasmaAppletItem *>(i);
 164
 165         if (p) {
 166             const bool running = apps.value(p->name());
 167             const bool used = m_used.contains(p->pluginName());
 168
 169             p->setRunning(running);
 170             //mark just used applets that arent't running
 171             p->setUsed(!running && used);
 172
 173             if (running && !used) {
 174                 m_used.append(p->pluginName());
 175             }
 176         }
 177     }
 178
 179     m_configGroup.writeEntry("used", m_used.join(","));
 180 }
 181
 182 void PlasmaAppletItemModel::setRunningApplets(const QString &name, int count)
 183 {
 184     for (int r=0; r<rowCount(); ++r) {
 185         QStandardItem *i = item(r);
 186         PlasmaAppletItem *p = dynamic_cast<PlasmaAppletItem *>(i);
 187         if (p && p->name() == name) {
 188             const bool used = m_used.contains(p->pluginName());
 189
 190             p->setRunning(count);
 191             p->setUsed(used && count == 0);
 192
 193             if (count > 0 && !used) {
 194                 m_used.append(p->pluginName());
 195             }
 196         }
 197     }
 198
 199     m_configGroup.writeEntry("used", m_used.join(","));
 200 }
 201
 202 QStringList PlasmaAppletItemModel::mimeTypes() const
 203 {
 204     QStringList types;
 205     types << QLatin1String("text/x-plasmoidservicename");
 206     return types;
 207 }
 208
 209 QMimeData *PlasmaAppletItemModel::mimeData(const QModelIndexList &indexes) const
 210 {
 211     kDebug() << "GETTING MIME DATA\n";
 212     if (indexes.count() <= 0) {
 213         return 0;
 214     }
 215
 216     QStringList types = mimeTypes();
 217
 218     if (types.isEmpty()) {
 219         return 0;
 220     }
 221
 222     QMimeData *data = new QMimeData();
 223
 224     QString format = types.at(0);
 225
 226     QByteArray appletNames;
 227     int lastRow = -1;
 228     foreach (const QModelIndex &index, indexes) {
 229         if (index.row() == lastRow) {
 230             continue;
 231         }
 232
 233         lastRow = index.row();
 234         PlasmaAppletItem *selectedItem = (PlasmaAppletItem *) itemFromIndex(index);
 235         appletNames += '\n' + selectedItem->pluginName().toUtf8();
 236         //kDebug() << selectedItem->pluginName() << index.column() << index.row();
 237     }
 238
 239     data->setData(format, appletNames);
 240     return data;
 241 }
 242
 243 void PlasmaAppletItemModel::setFavorite(const QString &plugin, bool favorite)
 244 {
 245     if (favorite) {
 246         if (!m_favorites.contains(plugin)) {
 247             m_favorites.append(plugin);
 248         }
 249     } else if (m_favorites.contains(plugin)) {
 250         m_favorites.removeAll(plugin);
 251     }
 252
 253     m_configGroup.writeEntry("favorites", m_favorites.join(","));
 254     m_configGroup.sync();
 255 }
 256
 257 void PlasmaAppletItemModel::setApplication(const QString &app)
 258 {
 259     m_application = app;
 260     populateModel();
 261 }
 262
 263 QString &PlasmaAppletItemModel::Application()
 264 {
 265     return m_application;
 266 }
 267
 268 #include <plasmaappletitemmodel_p.moc>
 269