workspace/systemsettings/kcmultiwidget.cpp

   1 /*
   2    Copyright (c) 2000 Matthias Elter <elter@kde.org>
   3    Copyright (c) 2003 Daniel Molkentin <molkentin@kde.org>
   4    Copyright (c) 2003 Matthias Kretz <kretz@kde.org>
   5    Copyright (c) 2004 Frans Englich <englich@kde.org>
   6    Copyright (c) 2008 Michael Jansen <kde@michael-jansen.biz>
   7
   8    This library is free software; you can redistribute it and/or
   9    modify it under the terms of the GNU Library General Public
  10    License as published by the Free Software Foundation; either
  11    version 2 of the License, or (at your option) any later version.
  12
  13    This library is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16    Library General Public License for more details.
  17
  18    You should have received a copy of the GNU Library General Public License
  19    along with this library; see the file COPYING.LIB.  If not, write to
  20    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21    Boston, MA 02110-1301, USA.
  22
  23 */
  24
  25 #include "kcmultiwidget.h"
  26
  27 #include <QLayout>
  28 #include <QProcess>
  29 #include <QScrollArea>
  30
  31 #include <kdebug.h>
  32 #include <kiconloader.h>
  33 #include <klibloader.h>
  34 #include <klocale.h>
  35 #include <kmessagebox.h>
  36 #include <krun.h>
  37 #include <kstandardguiitem.h>
  38 #include <kuser.h>
  39 #include <kauthorized.h>
  40 #include <ktoolinvocation.h>
  41
  42 #include "kcmoduleloader.h"
  43 #include "kcmoduleproxy.h"
  44
  45 /*
  46 Button usage:
  47
  48     User1 => Close
  49     User2 => Admin (dead in KDE 4)
  50 */
  51
  52 class KCMultiWidget::KCMultiWidgetPrivate
  53 {
  54     public:
  55         KCMultiWidgetPrivate()
  56             : hasRootKCM( false )
  57         {}
  58
  59         bool hasRootKCM;
  60 };
  61
  62 KCMultiWidget::KCMultiWidget(QWidget *parent, Qt::WindowModality modality)
  63     : KPageDialog( parent ),
  64     d( new KCMultiWidgetPrivate )
  65 {
  66     InitKIconDialog(i18n("Configure"), modality);
  67     init();
  68 }
  69
  70 // Maybe move into init()?
  71 void KCMultiWidget::InitKIconDialog(const QString& caption,
  72                                     Qt::WindowModality modality)
  73 {
  74   setCaption(caption);
  75   setButtons(KDialog::Help |
  76              KDialog::Default |
  77              KDialog::Apply |
  78              KDialog::Reset );
  79   setDefaultButton(KDialog::Reset);
  80
  81   setWindowModality(modality);
  82 }
  83
  84
  85 inline void KCMultiWidget::init()
  86 {
  87     // A bit hackish: KCMultiWidget inherits from KPageDialog, but it really is
  88     // a widget...
  89     setWindowFlags(Qt::Widget);
  90
  91     enableButton(Apply, false);
  92     enableButton(Reset, false);
  93     enableButton(Default, false);
  94     enableButton(Help, false);
  95
  96     connect(
  97         this, SIGNAL(currentPageChanged(KPageWidgetItem*, KPageWidgetItem*)),
  98         this, SLOT(slotAboutToShow(KPageWidgetItem*, KPageWidgetItem* )) );
  99     setInitialSize(QSize(640,480));
 100     setFaceType( Auto );
 101     connect( this, SIGNAL(helpClicked()), this, SLOT(slotHelp()) );
 102     connect( this, SIGNAL(defaultClicked()), this, SLOT(slotDefault()) );
 103     connect( this, SIGNAL(applyClicked()), this, SLOT(slotApply()) );
 104     connect( this, SIGNAL(resetClicked()), this, SLOT(slotReset()) );
 105 }
 106
 107 KCMultiWidget::~KCMultiWidget()
 108 {
 109     delete d;
 110 }
 111
 112 void KCMultiWidget::slotDefault()
 113 {
 114     defaults(currentModule());
 115 }
 116
 117
 118 void KCMultiWidget::slotReset()
 119 {
 120     reset(currentModule());
 121 }
 122
 123
 124 void KCMultiWidget::slotApply()
 125 {
 126     apply(currentModule());
 127 }
 128
 129
 130 void KCMultiWidget::slotHelp()
 131 {
 132     QString docPath = currentModule()->moduleInfo().docPath();
 133     if(docPath.isEmpty())
 134        return;
 135     KUrl url( KUrl("help:/"), docPath );
 136
 137     if (url.protocol() == "help" || url.protocol() == "man" || url.protocol() == "info") {
 138         QProcess::startDetached("khelpcenter", QStringList() << url.url());
 139     } else {
 140         KToolInvocation::invokeBrowser( url.url() );
 141     }
 142 }
 143
 144
 145 void KCMultiWidget::clientChanged(bool state)
 146 {
 147     kDebug( 710 ) << state;
 148     foreach( const CreatedModule &it, m_modules )
 149         if( it.kcm->changed() ) {
 150             enableButton( Apply, true );
 151             enableButton( Reset, true);
 152             return;
 153         }
 154     enableButton( Apply, false );
 155     enableButton( Reset, false);
 156 }
 157
 158
 159 void KCMultiWidget::addModule(const KCModuleInfo& moduleinfo)
 160 {
 161     if( !moduleinfo.service() ) {
 162         kWarning() << "ModuleInfo has no associated KService" ;
 163         return;
 164     }
 165
 166     if ( !KAuthorized::authorizeControlModule( moduleinfo.service()->menuId() )) {
 167         kWarning() << "Not authorised to load module" ;
 168         return;
 169     }
 170
 171     if(moduleinfo.service()->noDisplay()) {
 172         return;
 173     }
 174
 175     QScrollArea* moduleScrollArea = new QScrollArea( this );
 176     KCModuleProxy *module = new KCModuleProxy( moduleinfo, moduleScrollArea );
 177     moduleScrollArea->setWidget( module );
 178     moduleScrollArea->setWidgetResizable( true );
 179     moduleScrollArea->setFrameStyle( QFrame::NoFrame );
 180     moduleScrollArea->viewport()->setAutoFillBackground(false);
 181     module->setAutoFillBackground(false);
 182     QStringList parentComponents = moduleinfo.service()->property(
 183             "X-KDE-System-Settings-Parent-Category" ).toStringList();
 184     moduleParentComponents.insert( module, parentComponents );
 185
 186     connect(module, SIGNAL(changed(bool)), this, SLOT(clientChanged(bool)));
 187
 188     CreatedModule cm;
 189     cm.kcm = module;
 190     cm.service = moduleinfo.service();
 191     cm.adminmode = false;
 192
 193     // "root KCMs are gone" says KControl
 194     //  if ( moduleinfo.needsRootPrivileges() && !d->hasRootKCM &&
 195     //                  !KUser().isSuperUser() ) {/* If we're embedded, it's true */
 196     //          d->hasRootKCM = true;
 197     //          cm.adminmode = true;
 198     //          m_modules.append( cm );
 199     //          if( dialogface==Plain ) {
 200     //                  slotAboutToShow( page ); // Won't be called otherwise, necessary for adminMode button
 201     //                }
 202     //  } else {
 203     //          m_modules.append( cm );
 204     //  }
 205
 206     m_modules.append( cm );
 207     if( m_modules.count() == 1 ) {
 208         slotAboutToShow( module );
 209     }
 210     KPageWidgetItem* page = addPage(moduleScrollArea, moduleinfo.moduleName());
 211     page->setIcon( KIcon(moduleinfo.icon()) );
 212     page->setHeader(moduleinfo.comment());
 213 }
 214
 215
 216 KCModuleProxy* KCMultiWidget::currentModule()
 217 {
 218     KPageWidgetItem *pageWidget = currentPage();
 219     if ( pageWidget == 0 )
 220         return 0;
 221
 222     QScrollArea *scrollArea = qobject_cast<QScrollArea*>( pageWidget->widget() );
 223     KCModuleProxy *module = qobject_cast<KCModuleProxy*>( scrollArea->widget() );
 224
 225     return module;
 226 }
 227
 228
 229 void KCMultiWidget::slotAboutToShow(KPageWidgetItem* current, KPageWidgetItem* before)
 230  {
 231     if( before != 0 ) {
 232         QScrollArea *scrollArea = qobject_cast<QScrollArea*>( before->widget() );
 233         KCModuleProxy *module = qobject_cast<KCModuleProxy*>( scrollArea->widget() );
 234         if (!queryClose(module)) {
 235             setCurrentPage(before);
 236             return;
 237         }
 238     }
 239
 240     QWidget* sendingWidget = current->widget();
 241     slotAboutToShow(sendingWidget);
 242 }
 243
 244
 245 void KCMultiWidget::slotAboutToShow(QWidget *page)
 246 {
 247     QList<KCModuleProxy*> objects = page->findChildren<KCModuleProxy*>();
 248
 249     // add fall back
 250     objects.append( qobject_cast<KCModuleProxy*>(page) );
 251
 252     KCModuleProxy *module = objects.first();
 253     if( ! module ) {
 254         return;
 255     }
 256
 257     emit ( aboutToShow( module ) );
 258
 259     int buttons = 0;
 260     bool found = false;
 261     foreach( const CreatedModule &it, m_modules ) {
 262         if( it.kcm==module) {
 263             showButton(User2, it.adminmode);
 264             buttons = it.kcm->buttons();
 265             found = true;
 266         }
 267     }
 268     if (!found) {
 269         buttons = module->buttons();
 270     }
 271
 272     showButton(Apply, buttons & KCModule::Apply);
 273     showButton(Reset, buttons & KCModule::Apply);
 274
 275     enableButton( KDialog::Help, buttons & KCModule::Help );
 276     enableButton( KDialog::Default, buttons & KCModule::Default );
 277
 278     disconnect( this, SIGNAL(user3Clicked()), 0, 0 );
 279
 280     //  if (module->moduleInfo().needsRootPrivileges() &&
 281     //                  !module->rootMode() )
 282     //  { /* Enable the Admin Mode button */
 283     //          enableButton( User2, true );
 284     //          connect( this, SIGNAL(user3Clicked()), module, SLOT( runAsRoot() ));
 285     //          connect( this, SIGNAL(user3Clicked()), SLOT( disableRModeButton() ));
 286     //  } else {
 287     //          enableButton( User2, false );
 288     //  }
 289 }
 290
 291 // Currently unused. Whenever root mode comes back
 292 #if 0
 293 void KCMultiWidget::rootExit()
 294 {
 295     enableButton( User2, true);
 296 }
 297
 298 void KCMultiWidget::disableRModeButton()
 299 {
 300     enableButton( User2, false );
 301     connect ( currentModule(), SIGNAL( childClosed() ), SLOT( rootExit() ) );
 302 }
 303 #endif
 304
 305
 306 void KCMultiWidget::apply(KCModuleProxy *module)
 307 {
 308     module->save();
 309     emit configCommitted();
 310
 311         // TODO: check what that stuff does! I think it's not needed
 312         QStringList updatedModules;
 313         QStringList names = moduleParentComponents[ module ];
 314         foreach ( const QString &name , names )
 315         {
 316             if ( updatedModules.indexOf(name) == -1 )
 317                 updatedModules.append(name);
 318         }
 319
 320         foreach( const QString &it, updatedModules )
 321         {
 322             emit configCommitted( it.toLatin1() );
 323         }
 324
 325     clientChanged(false);
 326 }
 327
 328
 329 void KCMultiWidget::defaults(KCModuleProxy *module)
 330 {
 331     module->defaults();
 332     clientChanged( true );
 333 }
 334
 335
 336 bool KCMultiWidget::queryClose()
 337 {
 338     return queryClose(currentModule());
 339 }
 340
 341
 342 bool KCMultiWidget::queryClose(KCModuleProxy *module)
 343 {
 344     if( !module || !module->changed() )
 345         return true;
 346
 347     // Let the user decide
 348     int res = KMessageBox::warningYesNoCancel(
 349         this,
 350         i18n("There are unsaved changes in the active module.\n"
 351              "Do you want to apply the changes or discard them?"),
 352         i18n("Unsaved Changes"),
 353         KStandardGuiItem::save(),
 354         KStandardGuiItem::discard(),
 355         KStandardGuiItem::cancel() );
 356
 357     switch (res) {
 358
 359     case KMessageBox::Yes:
 360         apply(module);
 361         return true;
 362
 363     case KMessageBox::No:
 364         reset(module);
 365         return true;
 366
 367     case KMessageBox::Cancel:
 368         return false;
 369
 370     default:
 371         Q_ASSERT(false);
 372         return false;
 373     }
 374 }
 375
 376
 377 void KCMultiWidget::reset(KCModuleProxy *module)
 378 {
 379     module->load();
 380     clientChanged(false);
 381 }
 382
 383
 384 #include "kcmultiwidget.moc"