workspace/kwin/kcmkwin/kwincompositing/main.cpp

   1 /********************************************************************
   2  KWin - the KDE window manager
   3  This file is part of the KDE project.
   4
   5 Copyright (C) 2007 Rivo Laks <rivolaks@hot.ee>
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 *********************************************************************/
  20
  21 #include "main.h"
  22
  23 #include "advanced.h"
  24
  25 #include <kaboutdata.h>
  26 #include <kconfig.h>
  27 #include <kconfiggroup.h>
  28 #include <kdebug.h>
  29 #include <ksettings/dispatcher.h>
  30 #include <kpluginselector.h>
  31 #include <kservicetypetrader.h>
  32 #include <kplugininfo.h>
  33 #include <kservice.h>
  34
  35 #include <QtDBus/QtDBus>
  36 #include <QTimer>
  37 #include <QLabel>
  38 #include <KPluginFactory>
  39 #include <KPluginLoader>
  40
  41 K_PLUGIN_FACTORY(KWinCompositingConfigFactory,
  42         registerPlugin<KWin::KWinCompositingConfig>();
  43         )
  44 K_EXPORT_PLUGIN(KWinCompositingConfigFactory("kcmkwincompositing"))
  45
  46 namespace KWin
  47 {
  48
  49
  50 ConfirmDialog::ConfirmDialog() :
  51         KTimerDialog(10000, KTimerDialog::CountDown, 0, "mainKTimerDialog", true,
  52                      i18n("Confirm Desktop Effects Change"), KTimerDialog::Ok|KTimerDialog::Cancel,
  53                      KTimerDialog::Cancel)
  54     {
  55     setButtonGuiItem( KDialog::Ok, KGuiItem( i18n( "&Accept Configuration" ), "dialog-ok" ));
  56     setButtonGuiItem( KDialog::Cancel, KGuiItem( i18n( "&Return to Previous Configuration" ), "dialog-cancel" ));
  57
  58     QLabel *label = new QLabel( i18n( "Desktop effects settings have changed.\n"
  59             "Do you want to keep the new settings?\n"
  60             "They will be automatically reverted in 10 seconds." ), this );
  61     label->setWordWrap( true );
  62     setMainWidget( label );
  63     }
  64
  65
  66 KWinCompositingConfig::KWinCompositingConfig(QWidget *parent, const QVariantList &)
  67     : KCModule( KWinCompositingConfigFactory::componentData(), parent),
  68         mKWinConfig(KSharedConfig::openConfig("kwinrc")),
  69         m_showConfirmDialog (false)
  70 {
  71     KGlobal::locale()->insertCatalog( "kwin_effects" );
  72     ui.setupUi(this);
  73     layout()->setMargin(0);
  74     ui.tabWidget->setCurrentIndex(0);
  75     ui.statusLabel->hide();
  76
  77     connect(ui.advancedOptions, SIGNAL(clicked()), this, SLOT(showAdvancedOptions()));
  78     connect(ui.useCompositing, SIGNAL(toggled(bool)), this, SLOT(compositingEnabled(bool)));
  79     connect(ui.tabWidget, SIGNAL(currentChanged(int)), this, SLOT(currentTabChanged(int)));
  80
  81     connect(ui.useCompositing, SIGNAL(toggled(bool)), this, SLOT(changed()));
  82     connect(ui.effectWinManagement, SIGNAL(toggled(bool)), this, SLOT(changed()));
  83     connect(ui.effectShadows, SIGNAL(toggled(bool)), this, SLOT(changed()));
  84     connect(ui.effectAnimations, SIGNAL(toggled(bool)), this, SLOT(changed()));
  85
  86     connect(ui.effectSelector, SIGNAL(changed(bool)), this, SLOT(changed()));
  87     connect(ui.effectSelector, SIGNAL(configCommitted(const QByteArray&)),
  88             this, SLOT(reparseConfiguration(const QByteArray&)));
  89
  90     // Open the temporary config file
  91     // Temporary conf file is used to syncronize effect checkboxes with effect
  92     //  selector by loading/saving effects from/to temp config when active tab
  93     //  changes.
  94     mTmpConfigFile.open();
  95     mTmpConfig = KSharedConfig::openConfig(mTmpConfigFile.fileName());
  96
  97     if( CompositingPrefs::compositingPossible() )
  98     {
  99         // Driver-specific config detection
 100         mDefaultPrefs.detect();
 101
 102         initEffectSelector();
 103
 104         // Load config
 105         load();
 106     }
 107     else
 108     {
 109         ui.useCompositing->setEnabled(false);
 110         ui.useCompositing->setChecked(false);
 111         compositingEnabled(false);
 112
 113         QString text = i18n("Compositing is not supported on your system.");
 114         text += "<br><br>";
 115         text += CompositingPrefs::compositingNotPossibleReason();
 116         ui.statusLabel->setText(text);
 117         ui.statusLabel->show();
 118     }
 119
 120     KAboutData *about = new KAboutData(I18N_NOOP("kcmkwincompositing"), 0,
 121             ki18n("KWin Desktop Effects Configuration Module"),
 122             0, KLocalizedString(), KAboutData::License_GPL, ki18n("(c) 2007 Rivo Laks"));
 123     about->addAuthor(ki18n("Rivo Laks"), KLocalizedString(), "rivolaks@hot.ee");
 124     setAboutData(about);
 125 }
 126
 127 KWinCompositingConfig::~KWinCompositingConfig()
 128 {
 129 }
 130
 131 void KWinCompositingConfig::reparseConfiguration(const QByteArray&conf)
 132 {
 133     KSettings::Dispatcher::reparseConfiguration(conf);
 134 }
 135
 136 void KWinCompositingConfig::compositingEnabled(bool enabled)
 137 {
 138     ui.compositingOptionsContainer->setEnabled(enabled);
 139     ui.tabWidget->setTabEnabled(1, enabled);
 140 }
 141
 142 void KWinCompositingConfig::showAdvancedOptions()
 143 {
 144     KWinAdvancedCompositingOptions* dialog = new KWinAdvancedCompositingOptions(this, mKWinConfig, &mDefaultPrefs);
 145
 146     dialog->show();
 147 }
 148
 149 void KWinCompositingConfig::showConfirmDialog()
 150 {
 151     ConfirmDialog confirm;
 152     if(!confirm.exec())
 153     {
 154         // Revert settings
 155         KConfigGroup config(mKWinConfig, "Compositing");
 156         config.deleteGroup();
 157         QMap<QString, QString>::const_iterator it = mPreviousConfig.constBegin();
 158         for(; it != mPreviousConfig.constEnd(); ++it) {
 159             if (it.value().isEmpty())
 160                 continue;
 161             config.writeEntry(it.key(), it.value());
 162         }
 163         // Sync with KWin and reload
 164         configChanged();
 165         load();
 166     }
 167 }
 168
 169 void KWinCompositingConfig::initEffectSelector()
 170 {
 171     // Find all .desktop files of the effects
 172     KService::List offers = KServiceTypeTrader::self()->query("KWin/Effect");
 173     QList<KPluginInfo> effectinfos = KPluginInfo::fromServices(offers);
 174
 175     // Add them to the plugin selector
 176     ui.effectSelector->addPlugins(effectinfos, KPluginSelector::ReadConfigFile, i18n("Appearance"), "Appearance", mTmpConfig);
 177     ui.effectSelector->addPlugins(effectinfos, KPluginSelector::ReadConfigFile, i18n("Accessibility"), "Accessibility", mTmpConfig);
 178     ui.effectSelector->addPlugins(effectinfos, KPluginSelector::ReadConfigFile, i18n("Window Management"), "Window Management", mTmpConfig);
 179     ui.effectSelector->addPlugins(effectinfos, KPluginSelector::ReadConfigFile, i18n("Demos"), "Demos", mTmpConfig);
 180     ui.effectSelector->addPlugins(effectinfos, KPluginSelector::ReadConfigFile, i18n("Tests"), "Tests", mTmpConfig);
 181     ui.effectSelector->addPlugins(effectinfos, KPluginSelector::ReadConfigFile, i18n("Misc"), "Misc", mTmpConfig);
 182 }
 183
 184 void KWinCompositingConfig::currentTabChanged(int tab)
 185 {
 186     if (tab == 0)
 187     {
 188         // General tab was activated
 189         saveEffectsTab();
 190         loadGeneralTab();
 191     }
 192     else
 193     {
 194         // Effects tab was activated
 195         saveGeneralTab();
 196         loadEffectsTab();
 197     }
 198 }
 199
 200 void KWinCompositingConfig::loadGeneralTab()
 201 {
 202     KConfigGroup config(mKWinConfig, "Compositing");
 203     ui.useCompositing->setChecked(config.readEntry("Enabled", mDefaultPrefs.enableCompositing()));
 204
 205     // Load effect settings
 206     KConfigGroup effectconfig(mTmpConfig, "Plugins");
 207 #define LOAD_EFFECT_CONFIG(effectname)  effectconfig.readEntry("kwin4_effect_" effectname "Enabled", true)
 208     int winManagementEnabled = LOAD_EFFECT_CONFIG("presentwindows")
 209         + LOAD_EFFECT_CONFIG("boxswitch")
 210         + LOAD_EFFECT_CONFIG("desktopgrid")
 211         + LOAD_EFFECT_CONFIG("dialogparent");
 212     if (winManagementEnabled > 0 && winManagementEnabled < 4) {
 213         ui.effectWinManagement->setTristate(true);
 214         ui.effectWinManagement->setCheckState(Qt::PartiallyChecked);
 215     }
 216     else
 217         ui.effectWinManagement->setChecked(winManagementEnabled);
 218     ui.effectShadows->setChecked(LOAD_EFFECT_CONFIG("shadow"));
 219     ui.effectAnimations->setChecked(LOAD_EFFECT_CONFIG("minimizeanimation"));
 220 #undef LOAD_EFFECT_CONFIG
 221 }
 222
 223 void KWinCompositingConfig::loadEffectsTab()
 224 {
 225     ui.effectSelector->load();
 226 }
 227
 228 void KWinCompositingConfig::load()
 229 {
 230     mKWinConfig->reparseConfiguration();
 231
 232     // Copy Plugins group to temp config file
 233     QMap<QString, QString> entries = mKWinConfig->entryMap("Plugins");
 234     QMap<QString, QString>::const_iterator it = entries.constBegin();
 235     KConfigGroup tmpconfig(mTmpConfig, "Plugins");
 236     tmpconfig.deleteGroup();
 237     for(; it != entries.constEnd(); ++it)
 238     {
 239         tmpconfig.writeEntry(it.key(), it.value());
 240     }
 241
 242     loadGeneralTab();
 243     loadEffectsTab();
 244
 245     emit changed( false );
 246 }
 247
 248 void KWinCompositingConfig::saveGeneralTab()
 249 {
 250     KConfigGroup config(mKWinConfig, "Compositing");
 251     // Save current config. We'll use this for restoring in case something
 252     //  goes wrong.
 253     mPreviousConfig = config.entryMap();
 254     // Check if any critical settings that need confirmation have changed
 255     if(ui.useCompositing->isChecked()
 256         && ui.useCompositing->isChecked() != config.readEntry("Enabled", mDefaultPrefs.enableCompositing()))
 257         {
 258         m_showConfirmDialog = true;
 259         }
 260
 261     config.writeEntry("Enabled", ui.useCompositing->isChecked());
 262
 263     // Save effects
 264     KConfigGroup effectconfig(mTmpConfig, "Plugins");
 265 #define WRITE_EFFECT_CONFIG(effectname, widget)  effectconfig.writeEntry("kwin4_effect_" effectname "Enabled", widget->isChecked())
 266     if (ui.effectWinManagement->checkState() != Qt::PartiallyChecked) {
 267         WRITE_EFFECT_CONFIG("presentwindows", ui.effectWinManagement);
 268         WRITE_EFFECT_CONFIG("boxswitch", ui.effectWinManagement);
 269         WRITE_EFFECT_CONFIG("desktopgrid", ui.effectWinManagement);
 270         WRITE_EFFECT_CONFIG("dialogparent", ui.effectWinManagement);
 271     }
 272     WRITE_EFFECT_CONFIG("shadow", ui.effectShadows);
 273     // TODO: maybe also do some effect-specific configuration here, e.g.
 274     //  enable/disable desktopgrid's animation according to this setting
 275     WRITE_EFFECT_CONFIG("minimizeanimation", ui.effectAnimations);
 276 #undef WRITE_EFFECT_CONFIG
 277 }
 278
 279 void KWinCompositingConfig::saveEffectsTab()
 280 {
 281     ui.effectSelector->save();
 282 }
 283
 284 void KWinCompositingConfig::save()
 285 {
 286     // bah; tab content being dependent on the other is really bad; and
 287     // deprecated in the HIG for a reason.  Its confusing!
 288     // Make sure we only call save on each tab once; as they are stateful due to the revert concept
 289     if (ui.tabWidget->currentIndex() == 0) { // general was active
 290         saveGeneralTab();
 291         loadEffectsTab();
 292         saveEffectsTab();
 293     }
 294     else { // effects tab was active
 295         saveEffectsTab();
 296         loadGeneralTab();
 297         saveGeneralTab();
 298     }
 299
 300     // Copy Plugins group from temp config to real config
 301     QMap<QString, QString> entries = mTmpConfig->entryMap("Plugins");
 302     QMap<QString, QString>::const_iterator it = entries.constBegin();
 303     KConfigGroup realconfig(mKWinConfig, "Plugins");
 304     realconfig.deleteGroup();
 305     for(; it != entries.constEnd(); ++it)
 306     {
 307         realconfig.writeEntry(it.key(), it.value());
 308     }
 309
 310     emit changed( false );
 311
 312     configChanged();
 313
 314     if(m_showConfirmDialog)
 315     {
 316         m_showConfirmDialog = false;
 317         showConfirmDialog();
 318     }
 319 }
 320
 321 void KWinCompositingConfig::configChanged()
 322 {
 323     // Send signal to kwin
 324     mKWinConfig->sync();
 325     // Send signal to all kwin instances
 326     QDBusMessage message = QDBusMessage::createSignal("/KWin", "org.kde.KWin", "reloadConfig");
 327     QDBusConnection::sessionBus().send(message);
 328 }
 329
 330
 331 void KWinCompositingConfig::defaults()
 332 {
 333     ui.useCompositing->setChecked(mDefaultPrefs.enableCompositing());
 334     ui.effectWinManagement->setChecked(true);
 335     ui.effectShadows->setChecked(true);
 336     ui.effectAnimations->setChecked(true);
 337
 338     ui.effectSelector->defaults();
 339 }
 340
 341 QString KWinCompositingConfig::quickHelp() const
 342 {
 343     return i18n("<h1>Desktop Effects</h1>");
 344 }
 345
 346 } // namespace
 347
 348 #include "main.moc"