1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
|
/*
SPDX-FileCopyrightText: 2014 Alex Richardson <arichardson.kde@gmail.com>
SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#include "configpage.h"
#include <KConfigDialogManager>
#include <KCoreConfigSkeleton>
namespace KDevelop {
class ConfigPagePrivate
{
public:
explicit ConfigPagePrivate(IPlugin* plugin)
: plugin(plugin)
{}
QScopedPointer<KConfigDialogManager> configManager;
KCoreConfigSkeleton* configSkeleton = nullptr;
IPlugin* plugin;
};
ConfigPage::ConfigPage(IPlugin* plugin, KCoreConfigSkeleton* config, QWidget* parent)
: KTextEditor::ConfigPage(parent)
, d_ptr(new ConfigPagePrivate(plugin))
{
setConfigSkeleton(config);
}
ConfigPage::~ConfigPage()
{
}
void ConfigPage::apply()
{
Q_D(ConfigPage);
// if d->configManager is null, this method must be overridden
Q_ASSERT_X(d->configManager, metaObject()->className(),
"Config page does not use a KConfigSkeleton, but doesn't override apply()");
QSignalBlocker blockSigs(this); // we don't want to emit changed() while calling apply()
d->configManager->updateSettings();
d->configSkeleton->load();
d->configManager->updateWidgets();
}
void ConfigPage::defaults()
{
Q_D(ConfigPage);
// if d->configManager is null, this method must be overridden
Q_ASSERT_X(d->configManager, metaObject()->className(),
"Config page does not use a KConfigSkeleton, but doesn't override defaults()");
d->configManager->updateWidgetsDefault();
}
void ConfigPage::reset()
{
Q_D(ConfigPage);
// if d->configManager is null, this method must be overridden
Q_ASSERT_X(d->configManager, metaObject()->className(),
"Config page does not use a KConfigSkeleton, but doesn't override reset()");
d->configManager->updateWidgets();
}
void ConfigPage::initConfigManager()
{
Q_D(ConfigPage);
if (d->configManager) {
d->configManager->addWidget(this);
}
if (needsResetDuringInitialization()) {
reset();
}
}
bool ConfigPage::needsResetDuringInitialization() const
{
// Potentially slow but safe default: makes sure all widgets are in the correct state.
// Many Kate classes derived from KTextEditor::ConfigPage call reset() in their constructors.
// TODO: update KDevelop classes derived from KTextEditor::ConfigPage one by one as follows:
// 1) override needsResetDuringInitialization() to return false;
// 2) call reset() in constructor(s) if needed.
// Once all KDevelop and KDevelop plugin ConfigPage-derived classes return false from
// needsResetDuringInitialization() (verify by making this function pure virtual), remove
// needsResetDuringInitialization() and its overrides, never call reset() in initConfigManager().
return true;
}
KCoreConfigSkeleton* ConfigPage::configSkeleton() const
{
Q_D(const ConfigPage);
return d->configSkeleton;
}
void ConfigPage::setConfigSkeleton(KCoreConfigSkeleton* skel)
{
Q_D(ConfigPage);
if (d->configSkeleton == skel) {
return;
}
d->configSkeleton = skel;
if (!skel) {
d->configManager.reset();
return;
}
// create the config dialog manager if it didn't exist or recreate it.
// This is needed because the used config skeleton has changed
// and no setter for that exists in KConfigDialogManager
d->configManager.reset(new KConfigDialogManager(this, d->configSkeleton));
connect(d->configManager.data(), &KConfigDialogManager::widgetModified, this, &ConfigPage::changed);
// d->configManager->addWidget(this) must be called from the config dialog,
// since the widget tree is probably not complete when calling this function
}
int ConfigPage::childPages() const
{
return 0;
}
ConfigPage* ConfigPage::childPage(int number)
{
Q_UNUSED(number)
return nullptr;
}
IPlugin* ConfigPage::plugin() const
{
Q_D(const ConfigPage);
return d->plugin;
}
ConfigPage::ConfigPageType ConfigPage::configPageType() const
{
return DefaultConfigPage;
}
} // namespace KDevelop
#include "moc_configpage.cpp"
|