File indexing completed on 2024-06-16 04:15:42

 /* This file is part of the KDE libraries
     Copyright
     (C) 2000 Reginald Stadlbauer (reggie@kde.org)
     (C) 1997 Stephan Kulow (coolo@kde.org)
     (C) 1997-2000 Sven Radej (radej@kde.org)
     (C) 1997-2000 Matthias Ettrich (ettrich@kde.org)
     (C) 1999 Chris Schlaeger (cs@kde.org)
     (C) 2002 Joseph Wenninger (jowenn@kde.org)
     (C) 2005-2006 Hamish Rodda (rodda@kde.org)
 
     SPDX-License-Identifier: LGPL-2.0-only
 */
 
 #include "kxmlguiwindow.h"
 
 #include "config-xmlgui.h"
 
 #include "kmainwindow_p.h"
 #include "kactioncollection.h"
 #ifdef HAVE_DBUS
 #include "kmainwindowiface_p.h"
 #endif
 #include "ktoolbarhandler_p.h"
 #include "kxmlguifactory.h"
 #include "kedittoolbar.h"
 #include "khelpmenu.h"
 #include "ktoolbar.h"
 
 #include <QCloseEvent>
 #ifdef HAVE_DBUS
 #include <QDBusConnection>
 #endif
 #include <QDomDocument>
 #include <QLayout>
 #include <QDebug>
 #include <QMenuBar>
 #include <QObject>
 #include <QStatusBar>
 #include <QStyle>
 #include <QWidget>
 #include <QList>
 
 #include <ktoggleaction.h>
 #include <kstandardaction.h>
 #include <kconfig.h>
 #include <klocalizedstring.h>
 #include <kaboutdata.h>
 #include <ksharedconfig.h>
 #include <kconfiggroup.h>
 
 #include <stdlib.h>
 #include <ctype.h>
 
 class KXmlGuiWindowPrivate : public KisKMainWindowPrivate
 {
 public:
     void _k_slotFactoryMakingChanges(bool b)
     {
         // While the GUI factory is adding/removing clients,
         // don't let KisKMainWindow think those are changes made by the user
         // #105525
         letDirtySettings = !b;
     }
 
     bool showHelpMenu: 1;
     QSize defaultSize;
 
     KDEPrivate::ToolBarHandler *toolBarHandler;
     KToggleAction *showStatusBarAction;
     QPointer<KisKEditToolBar> toolBarEditor;
     KisKXMLGUIFactory *factory;
 };
 
 KXmlGuiWindow::KXmlGuiWindow(QWidget *parent, Qt::WindowFlags f)
     : KisKMainWindow(*new KXmlGuiWindowPrivate, parent, f), KisKXMLGUIBuilder(this)
 {
     K_D(KXmlGuiWindow);
     d->showHelpMenu = true;
     d->toolBarHandler = 0;
     d->showStatusBarAction = 0;
     d->factory = 0;
 #ifdef HAVE_DBUS
     new KisKMainWindowInterface(this);
 #endif
 }
 
 QAction *KXmlGuiWindow::toolBarMenuAction()
 {
     K_D(KXmlGuiWindow);
     if (!d->toolBarHandler) {
         return 0;
     }
 
     return d->toolBarHandler->toolBarMenuAction();
 }
 
 void KXmlGuiWindow::setupToolbarMenuActions()
 {
     K_D(KXmlGuiWindow);
     if (d->toolBarHandler) {
         d->toolBarHandler->setupActions();
     }
 }
 
 KXmlGuiWindow::~KXmlGuiWindow()
 {
     K_D(KXmlGuiWindow);
     delete d->factory;
 }
 
 bool KXmlGuiWindow::event(QEvent *ev)
 {
     bool ret = KisKMainWindow::event(ev);
 #ifdef HAVE_DBUS
     if (ev->type() == QEvent::Polish) {
         QDBusConnection::sessionBus().registerObject(dbusName() + QStringLiteral("/actions"), actionCollection(),
                 QDBusConnection::ExportScriptableSlots |
                 QDBusConnection::ExportScriptableProperties |
                 QDBusConnection::ExportNonScriptableSlots |
                 QDBusConnection::ExportNonScriptableProperties |
                 QDBusConnection::ExportChildObjects);
     }
 #endif
     return ret;
 }
 
 void KXmlGuiWindow::setHelpMenuEnabled(bool showHelpMenu)
 {
     K_D(KXmlGuiWindow);
     d->showHelpMenu = showHelpMenu;
 }
 
 bool KXmlGuiWindow::isHelpMenuEnabled() const
 {
     K_D(const KXmlGuiWindow);
     return d->showHelpMenu;
 }
 
 KisKXMLGUIFactory *KXmlGuiWindow::guiFactory()
 {
     K_D(KXmlGuiWindow);
     if (!d->factory) {
         d->factory = new KisKXMLGUIFactory(this, this);
         connect(d->factory, SIGNAL(makingChanges(bool)),
                 this, SLOT(_k_slotFactoryMakingChanges(bool)));
     }
     return d->factory;
 }
 
 void KXmlGuiWindow::configureToolbars()
 {
     K_D(KXmlGuiWindow);
     KConfigGroup cg(KSharedConfig::openConfig(), "");
     saveMainWindowSettings(cg);
     if (!d->toolBarEditor) {
         d->toolBarEditor = new KisKEditToolBar(guiFactory(), this);
         d->toolBarEditor->setAttribute(Qt::WA_DeleteOnClose);
         connect(d->toolBarEditor, SIGNAL(newToolBarConfig()), SLOT(saveNewToolbarConfig()));
     }
     d->toolBarEditor->show();
 }
 
 void KXmlGuiWindow::saveNewToolbarConfig()
 {
     // createGUI(xmlFile()); // this loses any plugged-in guiclients, so we use remove+add instead.
 
     guiFactory()->removeClient(this);
     guiFactory()->addClient(this);
 
     KConfigGroup cg(KSharedConfig::openConfig(), "");
     applyMainWindowSettings(cg);
 }
 
 void KXmlGuiWindow::setupGUI(StandardWindowOptions options, const QString &xmlfile)
 {
     setupGUI(QSize(), options, xmlfile);
 }
 
 void KXmlGuiWindow::setupGUI(const QSize &defaultSize, StandardWindowOptions options, const QString &xmlfile)
 {
     K_D(KXmlGuiWindow);
     if (options & Keys) {
         KStandardAction::keyBindings(guiFactory(),
                                      SLOT(configureShortcuts()), actionCollection());
     }
     if ((options & StatusBar) && statusBar()) {
         createStandardStatusBarAction();
     }
 
     if (options & ToolBar) {
         setStandardToolBarMenuEnabled(true);
         KStandardAction::configureToolbars(this,
                                            SLOT(configureToolbars()), actionCollection());
     }
 
     d->defaultSize = defaultSize;
 
     if (options & Create) {
         createGUI(xmlfile);
     }
 
     if (d->defaultSize.isValid()) {
         resize(d->defaultSize);
     } else if (isHidden()) {
         adjustSize();
     }
 
     if (options & Save) {
         const KConfigGroup cg(autoSaveConfigGroup());
         if (cg.isValid()) {
             setAutoSaveSettings(cg);
         } else {
             setAutoSaveSettings();
         }
     }
 }
 void KXmlGuiWindow::createGUI(const QString &xmlfile)
 {
     K_D(KXmlGuiWindow);
     // disabling the updates prevents unnecessary redraws
     //setUpdatesEnabled( false );
 
     // just in case we are rebuilding, let's remove our old client
     guiFactory()->removeClient(this);
 
     // make sure to have an empty GUI
     QMenuBar *mb = menuBar();
     if (mb) {
         mb->clear();
     }
 
     qDeleteAll(toolBars());   // delete all toolbars
 
     // don't build a help menu unless the user ask for it
     if (d->showHelpMenu) {
         delete d->helpMenu;
         // we always want a help menu
         d->helpMenu = new KisKHelpMenu(this, KAboutData::applicationData(), true);
 
         KisKActionCollection *actions = actionCollection();
         QAction *helpContentsAction = d->helpMenu->action(KisKHelpMenu::menuHelpContents);
         QAction *whatsThisAction = d->helpMenu->action(KisKHelpMenu::menuWhatsThis);
         QAction *reportBugAction = d->helpMenu->action(KisKHelpMenu::menuReportBug);
         QAction *switchLanguageAction = d->helpMenu->action(KisKHelpMenu::menuSwitchLanguage);
         QAction *aboutAppAction = d->helpMenu->action(KisKHelpMenu::menuAboutApp);
         QAction *aboutKdeAction = d->helpMenu->action(KisKHelpMenu::menuAboutKDE);
 
         if (helpContentsAction) {
             actions->addAction(helpContentsAction->objectName(), helpContentsAction);
         }
         if (whatsThisAction) {
             actions->addAction(whatsThisAction->objectName(), whatsThisAction);
         }
         if (reportBugAction) {
             actions->addAction(reportBugAction->objectName(), reportBugAction);
         }
         if (switchLanguageAction) {
             actions->addAction(switchLanguageAction->objectName(), switchLanguageAction);
         }
         if (aboutAppAction) {
             actions->addAction(aboutAppAction->objectName(), aboutAppAction);
         }
         if (aboutKdeAction) {
             actions->addAction(aboutKdeAction->objectName(), aboutKdeAction);
         }
     }
 
     const QString windowXmlFile = xmlfile.isNull() ? componentName() + QStringLiteral("ui.xmlgui") : xmlfile;
 
     // Help beginners who call setXMLFile and then setupGUI...
     if (!xmlFile().isEmpty() && xmlFile() != windowXmlFile) {
         qWarning() << "You called setXMLFile(" << xmlFile() << ") and then createGUI or setupGUI,"
                    << "which also calls setXMLFile and will overwrite the file you have previously set.\n"
                    << "You should call createGUI(" << xmlFile() << ") or setupGUI(<options>," << xmlFile() << ") instead.";
     }
 
     // we always want to load in our global standards file
     loadStandardsXmlFile();
 
     // now, merge in our local xml file.
     setXMLFile(windowXmlFile, true);
 
     // make sure we don't have any state saved already
     setXMLGUIBuildDocument(QDomDocument());
 
     // do the actual GUI building
     guiFactory()->reset();
     guiFactory()->addClient(this);
 
     //  setUpdatesEnabled( true );
 }
 
 void KXmlGuiWindow::slotStateChanged(const QString &newstate)
 {
     stateChanged(newstate, KisKXMLGUIClient::StateNoReverse);
 }
 
 void KXmlGuiWindow::slotStateChanged(const QString &newstate,
                                      bool reverse)
 {
     stateChanged(newstate,
                  reverse ? KisKXMLGUIClient::StateReverse : KisKXMLGUIClient::StateNoReverse);
 }
 
 void KXmlGuiWindow::setStandardToolBarMenuEnabled(bool enable)
 {
     K_D(KXmlGuiWindow);
     if (enable) {
         if (d->toolBarHandler) {
             return;
         }
 
         d->toolBarHandler = new KDEPrivate::ToolBarHandler(this);
 
         if (factory()) {
             factory()->addClient(d->toolBarHandler);
         }
     } else {
         if (!d->toolBarHandler) {
             return;
         }
 
         if (factory()) {
             factory()->removeClient(d->toolBarHandler);
         }
 
         delete d->toolBarHandler;
         d->toolBarHandler = 0;
     }
 }
 
 bool KXmlGuiWindow::isStandardToolBarMenuEnabled() const
 {
     K_D(const KXmlGuiWindow);
     return (d->toolBarHandler);
 }
 
 void KXmlGuiWindow::createStandardStatusBarAction()
 {
     K_D(KXmlGuiWindow);
     if (!d->showStatusBarAction) {
         d->showStatusBarAction = KStandardAction::showStatusbar(this, SLOT(setSettingsDirty()), actionCollection());
         QStatusBar *sb = statusBar(); // Creates statusbar if it doesn't exist already.
         connect(d->showStatusBarAction, SIGNAL(toggled(bool)), sb, SLOT(setVisible(bool)));
         d->showStatusBarAction->setChecked(sb->isHidden());
     } else {
         // If the language has changed, we'll need to grab the new text and whatsThis
         QAction *tmpStatusBar = KStandardAction::showStatusbar(0, 0, 0);
         d->showStatusBarAction->setText(tmpStatusBar->text());
         d->showStatusBarAction->setWhatsThis(tmpStatusBar->whatsThis());
         delete tmpStatusBar;
     }
 }
 
 void KXmlGuiWindow::finalizeGUI(bool /*force*/)
 {
     // FIXME: this really needs to be removed with a code more like the one we had on KDE3.
     //        what we need to do here is to position correctly toolbars so they don't overlap.
     //        Also, take in count plugins could provide their own toolbars and those also need to
     //        be restored.
     if (autoSaveSettings() && autoSaveConfigGroup().isValid()) {
         applyMainWindowSettings(autoSaveConfigGroup());
     }
 }
 
 void KXmlGuiWindow::applyMainWindowSettings(const KConfigGroup &config)
 {
     K_D(KXmlGuiWindow);
     KisKMainWindow::applyMainWindowSettings(config);
     QStatusBar *sb = findChild<QStatusBar *>();
     if (sb && d->showStatusBarAction) {
         d->showStatusBarAction->setChecked(!sb->isHidden());
     }
 }
 
 // KDE5 TODO: change it to "using KisKXMLGUIBuilder::finalizeGUI;" in the header
 // and remove the reimplementation
 void KXmlGuiWindow::finalizeGUI(KisKXMLGUIClient *client)
 {
     KisKXMLGUIBuilder::finalizeGUI(client);
 }
 
 #include "moc_kxmlguiwindow.cpp"