KConfigWidgets

kconfigdialog.cpp
1/*
2 This file is part of the KDE libraries
3 SPDX-FileCopyrightText: 2003 Benjamin C Meyer <ben+kdelibs at meyerhome dot net>
4 SPDX-FileCopyrightText: 2003 Waldo Bastian <bastian@kde.org>
5 SPDX-FileCopyrightText: 2004 Michael Brade <brade@kde.org>
6 SPDX-FileCopyrightText: 2021 Ahmad Samir <a.samirh78@gmail.com>
7
8 SPDX-License-Identifier: LGPL-2.0-or-later
9*/
10
11#include "kconfigdialog.h"
12
13#include <KCoreConfigSkeleton>
14#include <KLocalizedString>
15#include <KPageWidgetModel>
16#include <kconfigdialogmanager.h>
17#include <khelpclient.h>
18
19#include <QDialogButtonBox>
20#include <QIcon>
21#include <QPushButton>
22#include <QScrollArea>
23#include <QScrollBar>
24#include <QVBoxLayout>
25
26#include <vector>
27
28class KConfigDialogPrivate
29{
30public:
31 KConfigDialogPrivate(const QString &name, KCoreConfigSkeleton *config, KConfigDialog *qq)
32 : q(qq)
33 {
34 const QString dialogName = !name.isEmpty() ? name : QString::asprintf("SettingsDialog-%p", static_cast<void *>(q));
35
36 q->setObjectName(dialogName);
37 q->setWindowTitle(i18nc("@title:window", "Configure"));
38 q->setFaceType(KPageDialog::List);
39 s_openDialogs.push_back({dialogName, q});
40
41 QDialogButtonBox *buttonBox = q->buttonBox();
42 buttonBox->setStandardButtons(QDialogButtonBox::RestoreDefaults | QDialogButtonBox::Ok | QDialogButtonBox::Apply | QDialogButtonBox::Cancel
43 | QDialogButtonBox::Help);
44 QObject::connect(buttonBox->button(QDialogButtonBox::Ok), &QAbstractButton::clicked, q, &KConfigDialog::updateSettings);
45 QObject::connect(buttonBox->button(QDialogButtonBox::Apply), &QAbstractButton::clicked, q, &KConfigDialog::updateSettings);
46 QObject::connect(buttonBox->button(QDialogButtonBox::Apply), &QAbstractButton::clicked, q, [this]() {
47 updateButtons();
48 });
49 QObject::connect(buttonBox->button(QDialogButtonBox::Cancel), &QAbstractButton::clicked, q, &KConfigDialog::updateWidgets);
50 QObject::connect(buttonBox->button(QDialogButtonBox::RestoreDefaults), &QAbstractButton::clicked, q, &KConfigDialog::updateWidgetsDefault);
51 QObject::connect(buttonBox->button(QDialogButtonBox::RestoreDefaults), &QAbstractButton::clicked, q, [this]() {
52 updateButtons();
53 });
54 QObject::connect(buttonBox->button(QDialogButtonBox::Help), &QAbstractButton::clicked, q, &KConfigDialog::showHelp);
55
56 QObject::connect(q, &KPageDialog::pageRemoved, q, &KConfigDialog::onPageRemoved);
57
58 manager = new KConfigDialogManager(q, config);
59 setupManagerConnections(manager);
60
61 if (QPushButton *applyButton = q->buttonBox()->button(QDialogButtonBox::Apply)) {
62 applyButton->setEnabled(false);
63 };
64 }
65
66 KPageWidgetItem *addPageInternal(QWidget *page, const QString &itemName, const QString &pixmapName, const QString &header);
67
68 void setupManagerConnections(KConfigDialogManager *manager);
69
70 void updateApplyButton();
71 void updateDefaultsButton();
72 void updateButtons();
73 void settingsChangedSlot();
74
75 KConfigDialog *const q;
76 QString mAnchor;
77 QString mHelpApp;
78 bool shown = false;
79 KConfigDialogManager *manager = nullptr;
80
81 struct WidgetManager {
82 QWidget *widget = nullptr;
83 KConfigDialogManager *manager = nullptr;
84 };
85 std::vector<WidgetManager> m_managerForPage;
86
87 /**
88 * The list of existing dialogs.
89 */
90 struct OpenDialogInfo {
91 QString dialogName;
92 KConfigDialog *dialog = nullptr;
93 };
94 static std::vector<OpenDialogInfo> s_openDialogs;
95};
96
97std::vector<KConfigDialogPrivate::OpenDialogInfo> KConfigDialogPrivate::s_openDialogs;
98
99KConfigDialog::KConfigDialog(QWidget *parent, const QString &name, KCoreConfigSkeleton *config)
100 : KPageDialog(parent)
101 , d(new KConfigDialogPrivate(name, config, this))
102{
103}
104
105KConfigDialog::~KConfigDialog()
106{
107 auto &openDlgs = KConfigDialogPrivate::s_openDialogs;
108 const QString currentObjectName = objectName();
109 auto it = std::find_if(openDlgs.cbegin(), openDlgs.cend(), [=](const KConfigDialogPrivate::OpenDialogInfo &info) {
110 return currentObjectName == info.dialogName;
111 });
112
113 if (it != openDlgs.cend()) {
114 openDlgs.erase(it);
115 }
116}
117
118KPageWidgetItem *KConfigDialog::addPage(QWidget *page, const QString &itemName, const QString &pixmapName, const QString &header, bool manage)
119{
120 Q_ASSERT(page);
121 if (!page) {
122 return nullptr;
123 }
124
125 KPageWidgetItem *item = d->addPageInternal(page, itemName, pixmapName, header);
126 if (manage) {
127 d->manager->addWidget(page);
128 }
129
130 if (d->shown && manage) {
131 // update the default button if the dialog is shown
132 QPushButton *defaultButton = buttonBox()->button(QDialogButtonBox::RestoreDefaults);
133 if (defaultButton) {
134 bool is_default = defaultButton->isEnabled() && d->manager->isDefault();
135 defaultButton->setEnabled(!is_default);
136 }
137 }
138 return item;
139}
140
141KPageWidgetItem *KConfigDialog::addPage(QWidget *page, KCoreConfigSkeleton *config, const QString &itemName, const QString &pixmapName, const QString &header)
142{
143 Q_ASSERT(page);
144 if (!page) {
145 return nullptr;
146 }
147
148 KPageWidgetItem *item = d->addPageInternal(page, itemName, pixmapName, header);
149 auto *manager = new KConfigDialogManager(page, config);
150 d->m_managerForPage.push_back({page, manager});
151 d->setupManagerConnections(manager);
152
153 if (d->shown) {
154 // update the default button if the dialog is shown
155 QPushButton *defaultButton = buttonBox()->button(QDialogButtonBox::RestoreDefaults);
156 if (defaultButton) {
157 const bool is_default = defaultButton->isEnabled() && manager->isDefault();
158 defaultButton->setEnabled(!is_default);
159 }
160 }
161 return item;
162}
163
164KPageWidgetItem *KConfigDialogPrivate::addPageInternal(QWidget *page, const QString &itemName, const QString &pixmapName, const QString &header)
165{
166 QWidget *frame = new QWidget(q);
167 QVBoxLayout *boxLayout = new QVBoxLayout(frame);
168 boxLayout->setContentsMargins(0, 0, 0, 0);
169 boxLayout->setContentsMargins(0, 0, 0, 0);
170
171 QScrollArea *scroll = new QScrollArea(q);
172 scroll->setFrameShape(QFrame::NoFrame);
173 scroll->setHorizontalScrollBarPolicy(Qt::ScrollBarAsNeeded);
174 scroll->setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
175 scroll->setWidget(page);
176 scroll->setWidgetResizable(true);
177 scroll->setSizePolicy(QSizePolicy::MinimumExpanding, QSizePolicy::MinimumExpanding);
178
179 if (page->minimumSizeHint().height() > scroll->sizeHint().height() - 2) {
180 if (page->sizeHint().width() < scroll->sizeHint().width() + 2) {
181 // QScrollArea is planning only a vertical scroll bar,
182 // try to avoid the horizontal one by reserving space for the vertical one.
183 // Currently KPageViewPrivate::_k_modelChanged() queries the minimumSizeHint().
184 // We can only set the minimumSize(), so this approach relies on QStackedWidget size calculation.
185 scroll->setMinimumWidth(scroll->sizeHint().width() + qBound(0, scroll->verticalScrollBar()->sizeHint().width(), 200) + 4);
186 }
187 }
188
189 boxLayout->addWidget(scroll);
190 KPageWidgetItem *item = new KPageWidgetItem(frame, itemName);
191 item->setHeader(header);
192 if (!pixmapName.isEmpty()) {
193 item->setIcon(QIcon::fromTheme(pixmapName));
194 }
195
196 q->KPageDialog::addPage(item);
197 return item;
198}
199
200void KConfigDialogPrivate::setupManagerConnections(KConfigDialogManager *manager)
201{
202 q->connect(manager, qOverload<>(&KConfigDialogManager::settingsChanged), q, [this]() {
203 settingsChangedSlot();
204 });
205 q->connect(manager, &KConfigDialogManager::widgetModified, q, [this]() {
206 updateButtons();
207 });
208
209 QDialogButtonBox *buttonBox = q->buttonBox();
210 q->connect(buttonBox->button(QDialogButtonBox::Ok), &QPushButton::clicked, manager, &KConfigDialogManager::updateSettings);
211 q->connect(buttonBox->button(QDialogButtonBox::Apply), &QPushButton::clicked, manager, &KConfigDialogManager::updateSettings);
212 q->connect(buttonBox->button(QDialogButtonBox::Cancel), &QPushButton::clicked, manager, &KConfigDialogManager::updateWidgets);
213 q->connect(buttonBox->button(QDialogButtonBox::RestoreDefaults), &QPushButton::clicked, manager, &KConfigDialogManager::updateWidgetsDefault);
214}
215
216void KConfigDialogPrivate::updateApplyButton()
217{
218 QPushButton *applyButton = q->buttonBox()->button(QDialogButtonBox::Apply);
219 if (!applyButton) {
220 return;
221 }
222
223 const bool hasManagerChanged = std::any_of(m_managerForPage.cbegin(), m_managerForPage.cend(), [](const WidgetManager &widgetManager) {
224 return widgetManager.manager->hasChanged();
225 });
226
227 applyButton->setEnabled(manager->hasChanged() || q->hasChanged() || hasManagerChanged);
228}
229
230void KConfigDialogPrivate::updateDefaultsButton()
231{
232 QPushButton *restoreDefaultsButton = q->buttonBox()->button(QDialogButtonBox::RestoreDefaults);
233 if (!restoreDefaultsButton) {
234 return;
235 }
236
237 const bool isManagerDefaulted = std::all_of(m_managerForPage.cbegin(), m_managerForPage.cend(), [](const WidgetManager &widgetManager) {
238 return widgetManager.manager->isDefault();
239 });
240
241 restoreDefaultsButton->setDisabled(manager->isDefault() && q->isDefault() && isManagerDefaulted);
242}
243
244void KConfigDialog::onPageRemoved(KPageWidgetItem *item)
245{
246 auto it = std::find_if(d->m_managerForPage.cbegin(), d->m_managerForPage.cend(), [item](const KConfigDialogPrivate::WidgetManager &wm) {
247 return item->widget()->isAncestorOf(wm.widget);
248 });
249
250 if (it != d->m_managerForPage.cend()) { // There is a manager for this page, so remove it
251 delete it->manager;
252 d->m_managerForPage.erase(it);
253 d->updateButtons();
254 }
255}
256
257KConfigDialog *KConfigDialog::exists(const QString &name)
258{
259 auto &openDlgs = KConfigDialogPrivate::s_openDialogs;
260 auto it = std::find_if(openDlgs.cbegin(), openDlgs.cend(), [name](const KConfigDialogPrivate::OpenDialogInfo &info) {
261 return name == info.dialogName;
262 });
263
264 return it != openDlgs.cend() ? it->dialog : nullptr;
265}
266
267bool KConfigDialog::showDialog(const QString &name)
268{
269 KConfigDialog *dialog = exists(name);
270 if (dialog) {
271 dialog->show();
272 }
273 return (dialog != nullptr);
274}
275
276void KConfigDialogPrivate::updateButtons()
277{
278 static bool only_once = false;
279 if (only_once) {
280 return;
281 }
282 only_once = true;
283
284 updateApplyButton();
285 updateDefaultsButton();
286
287 Q_EMIT q->widgetModified();
288 only_once = false;
289}
290
291void KConfigDialogPrivate::settingsChangedSlot()
292{
293 // Update the buttons
294 updateButtons();
295 Q_EMIT q->settingsChanged(q->objectName());
296}
297
298void KConfigDialog::showEvent(QShowEvent *e)
299{
300 if (!d->shown) {
301 updateWidgets();
302 d->manager->updateWidgets();
303 for (auto [widget, manager] : d->m_managerForPage) {
304 manager->updateWidgets();
305 }
306
307 d->updateApplyButton();
308 d->updateDefaultsButton();
309
310 d->shown = true;
311 }
312 KPageDialog::showEvent(e);
313}
314
318
322
326
327bool KConfigDialog::hasChanged()
328{
329 return false;
330}
331
332bool KConfigDialog::isDefault()
333{
334 return true;
335}
336
337void KConfigDialog::updateButtons()
338{
339 d->updateButtons();
340}
341
342void KConfigDialog::settingsChangedSlot()
343{
344 d->settingsChangedSlot();
345}
346
347void KConfigDialog::setHelp(const QString &anchor, const QString &appname)
348{
349 d->mAnchor = anchor;
350 d->mHelpApp = appname;
351}
352
353void KConfigDialog::showHelp()
354{
355 KHelpClient::invokeHelp(d->mAnchor, d->mHelpApp);
356}
357
358#include "moc_kconfigdialog.cpp"
KConfigDialogManager
Provides a means of automatically retrieving, saving and resetting KConfigSkeleton based settings in ...
Definition kconfigdialogmanager.h:132
KConfigDialogManager::updateWidgetsDefault
void updateWidgetsDefault()
Traverse the specified widgets, sets the state of all known widgets according to the default state in...
Definition kconfigdialogmanager.cpp:343
KConfigDialogManager::widgetModified
void widgetModified()
If retrieveSettings() was told to track changes then if any known setting was changed this signal wil...
KConfigDialogManager::settingsChanged
void settingsChanged()
One or more of the settings have been saved (such as when the user clicks on the Apply button).
KConfigDialogManager::updateWidgets
void updateWidgets()
Traverse the specified widgets, sets the state of all known widgets according to the state in the set...
Definition kconfigdialogmanager.cpp:304
KConfigDialogManager::updateSettings
void updateSettings()
Traverse the specified widgets, saving the settings of all known widgets in the settings object.
Definition kconfigdialogmanager.cpp:356
KConfigDialog::isDefault
virtual bool isDefault()
Returns whether the current state of the dialog is the same as the default configuration.
Definition kconfigdialog.cpp:332
KConfigDialog::KConfigDialog
KConfigDialog(QWidget *parent, const QString &name, KCoreConfigSkeleton *config)
Definition kconfigdialog.cpp:99
KConfigDialog::showDialog
static bool showDialog(const QString &name)
Attempts to show the dialog with the name 'name'.
Definition kconfigdialog.cpp:267
KConfigDialog::addPage
KPageWidgetItem * addPage(QWidget *page, const QString &itemName, const QString &pixmapName=QString(), const QString &header=QString(), bool manage=true)
Adds page to the dialog and to KConfigDialogManager.
Definition kconfigdialog.cpp:118
KConfigDialog::showHelp
virtual void showHelp()
Displays help for this config dialog.
Definition kconfigdialog.cpp:353
KConfigDialog::settingsChangedSlot
void settingsChangedSlot()
Some setting was changed.
Definition kconfigdialog.cpp:342
KConfigDialog::~KConfigDialog
~KConfigDialog() override
Deconstructor, removes name from the list of open dialogs.
Definition kconfigdialog.cpp:105
KConfigDialog::updateSettings
virtual void updateSettings()
Update the settings from the dialog.
Definition kconfigdialog.cpp:315
KConfigDialog::showEvent
void showEvent(QShowEvent *e) override
Definition kconfigdialog.cpp:298
KConfigDialog::exists
static KConfigDialog * exists(const QString &name)
See if a dialog with the name 'name' already exists.
Definition kconfigdialog.cpp:257
KConfigDialog::hasChanged
virtual bool hasChanged()
Returns whether the current state of the dialog is different from the current configuration.
Definition kconfigdialog.cpp:327
KConfigDialog::updateWidgets
virtual void updateWidgets()
Update the dialog based on the settings.
Definition kconfigdialog.cpp:319
KConfigDialog::updateButtons
void updateButtons()
Updates the Apply and Default buttons.
Definition kconfigdialog.cpp:337
KConfigDialog::setHelp
void setHelp(const QString &anchor, const QString &appname=QString())
Sets the help path and topic.
Definition kconfigdialog.cpp:347
KConfigDialog::updateWidgetsDefault
virtual void updateWidgetsDefault()
Update the dialog based on the default settings.
Definition kconfigdialog.cpp:323
KPageDialog::buttonBox
QDialogButtonBox * buttonBox()
KPageDialog::pageRemoved
void pageRemoved(KPageWidgetItem *page)
KPageDialog::KPageDialog
KPageDialog(QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
KPageWidgetItem::setIcon
void setIcon(const QIcon &icon)
KPageWidgetItem::setHeader
void setHeader(const QString &header)
i18nc
QString i18nc(const char *context, const char *text, const TYPE &arg...)
KHelpClient::invokeHelp
void invokeHelp(const QString &anchor=QString(), const QString &appname=QString())
Invokes the KHelpCenter HTML help viewer from docbook sources.
Definition khelpclient.cpp:17
KStandardActions::name
QString name(StandardAction id)
QAbstractButton::clicked
void clicked(bool checked)
QAbstractScrollArea::setHorizontalScrollBarPolicy
void setHorizontalScrollBarPolicy(Qt::ScrollBarPolicy)
QAbstractScrollArea::verticalScrollBar
QScrollBar * verticalScrollBar() const const
QAbstractScrollArea::setVerticalScrollBarPolicy
void setVerticalScrollBarPolicy(Qt::ScrollBarPolicy)
QBoxLayout::addWidget
void addWidget(QWidget *widget, int stretch, Qt::Alignment alignment)
QDialog::showEvent
virtual void showEvent(QShowEvent *event) override
QDialogButtonBox::button
QPushButton * button(StandardButton which) const const
QDialogButtonBox::setStandardButtons
void setStandardButtons(StandardButtons buttons)
QFrame::setFrameShape
void setFrameShape(Shape)
QIcon::fromTheme
QIcon fromTheme(const QString &name)
QLayout::setContentsMargins
void setContentsMargins(const QMargins &margins)
QObject::connect
QMetaObject::Connection connect(const QObject *sender, PointerToMemberFunction signal, Functor functor)
QObject::parent
QObject * parent() const const
QScrollArea::setWidget
void setWidget(QWidget *widget)
QScrollArea::sizeHint
virtual QSize sizeHint() const const override
QScrollArea::setWidgetResizable
void setWidgetResizable(bool resizable)
QScrollBar::sizeHint
virtual QSize sizeHint() const const override
QSize::height
int height() const const
QSize::width
int width() const const
QString::asprintf
QString asprintf(const char *cformat,...)
QString::isEmpty
bool isEmpty() const const
QString::push_back
void push_back(QChar ch)
Qt::ScrollBarAsNeeded
ScrollBarAsNeeded
QWidget::QWidget
QWidget(QWidget *parent, Qt::WindowFlags f)
QWidget::isEnabled
bool isEnabled() const const
QWidget::setMinimumWidth
void setMinimumWidth(int minw)
QWidget::setDisabled
void setDisabled(bool disable)
QWidget::show
void show()
QWidget::setSizePolicy
void setSizePolicy(QSizePolicy)
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri May 2 2025 11:52:19 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.