kcmodule.cpp

/*
    SPDX-FileCopyrightText: 2001 Michael Goffioul <kdeprint@swing.be>
    SPDX-FileCopyrightText: 2004 Frans Englich <frans.englich@telia.com>
    SPDX-FileCopyrightText: 2009 Dario Freddi <drf@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#include "kcmodule.h"
#include "kabstractconfigmodule.h"
#include "kcmutils_debug.h"
 
#include <QVBoxLayout>
 
#include <KConfigDialogManager>
#include <KConfigSkeleton>
#include <KLocalizedString>
#include <KPluginMetaData>
 
class KCModuleProxyInternal : public QWidget
{
    Q_OBJECT
public:
    KCModuleProxyInternal(QWidget *parent)
        : QWidget(parent)
    {
    }
};
 
class KCModulePrivate
{
public:
    KCModulePrivate(QWidget *parentWidget)
        : _needsAuthorization(false)
        , _unmanagedWidgetChangeState(false)
        , _unmanagedWidgetDefaultState(false)
        , _unmanagedWidgetDefaultStateCalled(false)
        , parentWidget(parentWidget)
    {
    }
 
    void authStatusChanged(int status);
 
    QList<KConfigDialogManager *> managers;
 
    bool _needsAuthorization : 1;
 
    // this member is used to record the state on non-automatically
    // managed widgets, allowing for mixed KConfigXT-drive and manual
    // widgets to coexist peacefully and do the correct thing with
    // the changed(bool) signal
    bool _unmanagedWidgetChangeState : 1;
    bool _unmanagedWidgetDefaultState : 1;
    bool _unmanagedWidgetDefaultStateCalled : 1;
    QVBoxLayout *m_topLayout = nullptr; /* Contains QScrollView view, and root stuff */
    QWidget *parentWidget;
    KCModuleProxyInternal *m_proxyInternal = nullptr;
};
 
KCModule::KCModule(QWidget *parent, const KPluginMetaData &data)
    : KAbstractConfigModule(parent, data)
    , d(new KCModulePrivate(parent))
{
    connect(this, &KAbstractConfigModule::defaultsIndicatorsVisibleChanged, this, [this] {
        for (auto manager : std::as_const(d->managers)) {
            manager->setDefaultsIndicatorsVisible(defaultsIndicatorsVisible());
        }
    });
}
 
KConfigDialogManager *KCModule::addConfig(KCoreConfigSkeleton *config, QWidget *widget)
{
    KConfigDialogManager *manager = new KConfigDialogManager(widget, config);
    manager->setDefaultsIndicatorsVisible(defaultsIndicatorsVisible());
    manager->setObjectName(objectName());
    connect(manager, &KConfigDialogManager::widgetModified, this, &KCModule::widgetChanged);
    connect(manager, &QObject::destroyed, this, [this, manager]() {
        d->managers.removeOne(manager);
    });
    d->managers.append(manager);
    return manager;
}
 
KCModule::~KCModule()
{
    qDeleteAll(d->managers);
    d->managers.clear();
}
 
void KCModule::load()
{
    KAbstractConfigModule::load();
    for (KConfigDialogManager *manager : std::as_const(d->managers)) {
        manager->updateWidgets();
    }
    widgetChanged();
}
 
void KCModule::save()
{
    KAbstractConfigModule::save();
    for (KConfigDialogManager *manager : std::as_const(d->managers)) {
        manager->updateSettings();
    }
}
 
void KCModule::defaults()
{
    KAbstractConfigModule::defaults();
    for (KConfigDialogManager *manager : std::as_const(d->managers)) {
        manager->updateWidgetsDefault();
    }
}
 
QWidget *KCModule::widget()
{
    if (!d->m_proxyInternal) {
        d->m_topLayout = new QVBoxLayout(d->parentWidget);
        d->m_proxyInternal = new KCModuleProxyInternal(d->parentWidget);
        d->m_topLayout->addWidget(d->m_proxyInternal);
    }
    return d->m_proxyInternal;
}
 
void KCModule::widgetChanged()
{
    setNeedsSave(d->_unmanagedWidgetChangeState || managedWidgetChangeState());
    if (d->_unmanagedWidgetDefaultStateCalled) {
        setRepresentsDefaults(d->_unmanagedWidgetDefaultState && managedWidgetDefaultState());
    } else {
        setRepresentsDefaults(!d->managers.isEmpty() && managedWidgetDefaultState());
    }
}
 
bool KCModule::managedWidgetChangeState() const
{
    for (KConfigDialogManager *manager : std::as_const(d->managers)) {
        if (manager->hasChanged()) {
            return true;
        }
    }
 
    return false;
}
 
bool KCModule::managedWidgetDefaultState() const
{
    for (KConfigDialogManager *manager : std::as_const(d->managers)) {
        if (!manager->isDefault()) {
            return false;
        }
    }
 
    return true;
}
 
void KCModule::unmanagedWidgetChangeState(bool changed)
{
    d->_unmanagedWidgetChangeState = changed;
    widgetChanged();
}
 
void KCModule::unmanagedWidgetDefaultState(bool defaulted)
{
    d->_unmanagedWidgetDefaultStateCalled = true;
    d->_unmanagedWidgetDefaultState = defaulted;
    widgetChanged();
}
 
QList<KConfigDialogManager *> KCModule::configs() const
{
    return d->managers;
}
 
#include "kcmodule.moc"
#include "moc_kcmodule.cpp"