plasma/wallpaper.cpp

   1 /*
   2  *   Copyright 2008 by Aaron Seigo <aseigo@kde.org>
   3  *   Copyright 2008 by Petri Damsten <damu@iki.fi>
   4  *
   5  *   This program is free software; you can redistribute it and/or modify
   6  *   it under the terms of the GNU Library General Public License as
   7  *   published by the Free Software Foundation; either version 2, or
   8  *   (at your option) any later version.
   9  *
  10  *   This program is distributed in the hope that it will be useful,
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *   GNU General Public License for more details
  14  *
  15  *   You should have received a copy of the GNU Library General Public
  16  *   License along with this program; if not, write to the
  17  *   Free Software Foundation, Inc.,
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20
  21 #include "wallpaper.h"
  22
  23 #include <kservicetypetrader.h>
  24 #include <kdebug.h>
  25
  26 #include <version.h>
  27
  28 namespace Plasma
  29 {
  30
  31 class WallpaperPrivate
  32 {
  33 public:
  34     WallpaperPrivate(KService::Ptr service, Wallpaper *wallpaper) :
  35         q(wallpaper),
  36         wallpaperDescription(service),
  37         initialized(false)
  38     {
  39     };
  40
  41     ~WallpaperPrivate()
  42     {
  43     };
  44
  45     Wallpaper *q;
  46     KPluginInfo wallpaperDescription;
  47     QRectF boundingRect;
  48     KServiceAction mode;
  49     bool initialized;
  50 };
  51
  52 Wallpaper::Wallpaper(QObject *parentObject, const QVariantList &args)
  53     : d(new WallpaperPrivate(KService::serviceByStorageId(args.count() > 0 ?
  54                              args[0].toString() : QString()), this))
  55 {
  56     // now remove first item since those are managed by Wallpaper and subclasses shouldn't
  57     // need to worry about them. yes, it violates the constness of this var, but it lets us add
  58     // or remove items later while applets can just pretend that their args always start at 0
  59     QVariantList &mutableArgs = const_cast<QVariantList &>(args);
  60     if (!mutableArgs.isEmpty()) {
  61         mutableArgs.removeFirst();
  62     }
  63     setParent(parentObject);
  64 }
  65
  66 Wallpaper::~Wallpaper()
  67 {
  68     delete d;
  69 }
  70
  71 KPluginInfo::List Wallpaper::listWallpaperInfo(const QString &formFactor)
  72 {
  73     QString constraint;
  74
  75     if (!formFactor.isEmpty()) {
  76         constraint.append("[X-Plasma-FormFactors] ~~ '").append(formFactor).append("'");
  77     }
  78
  79     KService::List offers = KServiceTypeTrader::self()->query("Plasma/Wallpaper", constraint);
  80     return KPluginInfo::fromServices(offers);
  81 }
  82
  83 Wallpaper *Wallpaper::load(const QString &wallpaperName, const QVariantList &args)
  84 {
  85     if (wallpaperName.isEmpty()) {
  86         return 0;
  87     }
  88
  89     QString constraint = QString("[X-KDE-PluginInfo-Name] == '%1'").arg(wallpaperName);
  90     KService::List offers = KServiceTypeTrader::self()->query("Plasma/Wallpaper", constraint);
  91
  92     if (offers.isEmpty()) {
  93         kDebug() << "offers is empty for " << wallpaperName;
  94         return 0;
  95     }
  96
  97     KService::Ptr offer = offers.first();
  98     KPluginLoader plugin(*offer);
  99
 100     if (!Plasma::isPluginVersionCompatible(plugin.pluginVersion())) {
 101         return 0;
 102     }
 103
 104     QVariantList allArgs;
 105     allArgs << offer->storageId() << args;
 106     QString error;
 107     Wallpaper *wallpaper = offer->createInstance<Plasma::Wallpaper>(0, allArgs, &error);
 108
 109     if (!wallpaper) {
 110         kDebug() << "Couldn't load wallpaper \"" << wallpaperName << "\"! reason given: " << error;
 111     }
 112     return wallpaper;
 113 }
 114
 115 Wallpaper *Wallpaper::load(const KPluginInfo &info, const QVariantList &args)
 116 {
 117     if (!info.isValid()) {
 118         return 0;
 119     }
 120     return load(info.pluginName(), args);
 121 }
 122
 123 QString Wallpaper::name() const
 124 {
 125     if (!d->wallpaperDescription.isValid()) {
 126         return i18n("Unknown Wallpaper");
 127     }
 128
 129     return d->wallpaperDescription.name();
 130 }
 131
 132 QString Wallpaper::icon() const
 133 {
 134     if (!d->wallpaperDescription.isValid()) {
 135         return QString();
 136     }
 137
 138     return d->wallpaperDescription.icon();
 139 }
 140
 141 QString Wallpaper::pluginName() const
 142 {
 143     if (!d->wallpaperDescription.isValid()) {
 144         return QString();
 145     }
 146
 147     return d->wallpaperDescription.pluginName();
 148 }
 149
 150 KServiceAction Wallpaper::renderingMode() const
 151 {
 152     return d->mode;
 153 }
 154
 155 QList<KServiceAction> Wallpaper::listRenderingModes() const
 156 {
 157     if (!d->wallpaperDescription.isValid()) {
 158         return QList<KServiceAction>();
 159     }
 160
 161     return d->wallpaperDescription.service()->actions();
 162 }
 163
 164 QRectF Wallpaper::boundingRect() const
 165 {
 166     return d->boundingRect;
 167 }
 168
 169 bool Wallpaper::isInitialized() const
 170 {
 171     return d->initialized;
 172 }
 173
 174 void Wallpaper::setBoundingRect(const QRectF &boundingRect)
 175 {
 176     d->boundingRect = boundingRect;
 177 }
 178
 179 void Wallpaper::setRenderingMode(const QString &mode)
 180 {
 181     if (d->mode.name() == mode) {
 182         return;
 183     }
 184
 185     d->mode = KServiceAction();
 186     if (!mode.isEmpty()) {
 187         QList<KServiceAction> modes = listRenderingModes();
 188
 189         foreach (const KServiceAction &action, modes) {
 190             if (action.name() == mode) {
 191                 d->mode = action;
 192                 break;
 193             }
 194         }
 195     }
 196 }
 197
 198 void Wallpaper::restore(const KConfigGroup &config)
 199 {
 200     d->initialized = true;
 201     init(config);
 202 }
 203
 204 void Wallpaper::init(const KConfigGroup &config)
 205 {
 206     Q_UNUSED(config);
 207 }
 208
 209 void Wallpaper::save(KConfigGroup &config)
 210 {
 211     Q_UNUSED(config);
 212 }
 213
 214 QWidget *Wallpaper::createConfigurationInterface(QWidget *parent)
 215 {
 216     Q_UNUSED(parent);
 217     return 0;
 218 }
 219
 220 void Wallpaper::mouseMoveEvent(QGraphicsSceneMouseEvent *event)
 221 {
 222     Q_UNUSED(event)
 223 }
 224
 225 void Wallpaper::mousePressEvent(QGraphicsSceneMouseEvent *event)
 226 {
 227     Q_UNUSED(event)
 228 }
 229
 230 void Wallpaper::mouseReleaseEvent(QGraphicsSceneMouseEvent *event)
 231 {
 232     Q_UNUSED(event)
 233 }
 234
 235 void Wallpaper::wheelEvent(QGraphicsSceneWheelEvent *event)
 236 {
 237     Q_UNUSED(event)
 238 }
 239
 240 } // Plasma namespace
 241
 242 #include "wallpaper.moc"