KConfigWidgets

kconfigdialogmanager.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: 2017 Friedrich W. H. Kossebau <kossebau@kde.org>
6 SPDX-FileCopyrightText: 2020 Kevin Ottens <kevin.ottens@enioka.com>
7 SPDX-FileCopyrightText: 2020 Cyril Rossi <cyril.rossi@enioka.com>
8
9 SPDX-License-Identifier: LGPL-2.0-or-later
10*/
11
12#include "kconfigdialogmanager.h"
13#include "kconfigdialogmanager_p.h"
14#include "kconfigwidgets_debug.h"
15
16#include <QComboBox>
17#include <QGroupBox>
18#include <QLabel>
19#include <QLayout>
20#include <QMetaObject>
21#include <QMetaProperty>
22#include <QRadioButton>
23#include <QTimer>
24
25#include <KConfigSkeleton>
26
27typedef QHash<QString, QByteArray> MyHash;
28Q_GLOBAL_STATIC(MyHash, s_propertyMap)
29Q_GLOBAL_STATIC(MyHash, s_changedMap)
30
31KConfigDialogManager::KConfigDialogManager(QWidget *parent, KCoreConfigSkeleton *conf)
32 : QObject(parent)
33 , d(new KConfigDialogManagerPrivate(this))
34{
35 d->m_conf = conf;
36 d->m_dialog = parent;
37 init(true);
38}
39
40KConfigDialogManager::~KConfigDialogManager() = default;
41
42// KF6: Drop this and get signals only from metaObject and/or widget's dynamic properties kcfg_property/kcfg_propertyNotify
43void KConfigDialogManager::initMaps()
44{
45 if (s_propertyMap()->isEmpty()) {
46 s_propertyMap()->insert(QStringLiteral("KButtonGroup"), "current");
47 s_propertyMap()->insert(QStringLiteral("KColorButton"), "color");
48 s_propertyMap()->insert(QStringLiteral("KColorCombo"), "color");
49 s_propertyMap()->insert(QStringLiteral("KKeySequenceWidget"), "keySequence");
50 }
51
52 if (s_changedMap()->isEmpty()) {
53 // Qt
54 s_changedMap()->insert(QStringLiteral("QCheckBox"), SIGNAL(checkStateChanged(Qt::CheckState)));
55 s_changedMap()->insert(QStringLiteral("QPushButton"), SIGNAL(clicked(bool)));
56 s_changedMap()->insert(QStringLiteral("QRadioButton"), SIGNAL(toggled(bool)));
57 s_changedMap()->insert(QStringLiteral("QGroupBox"), SIGNAL(toggled(bool)));
58 s_changedMap()->insert(QStringLiteral("QComboBox"), SIGNAL(activated(int)));
59 s_changedMap()->insert(QStringLiteral("QDateEdit"), SIGNAL(dateChanged(QDate)));
60 s_changedMap()->insert(QStringLiteral("QTimeEdit"), SIGNAL(timeChanged(QTime)));
61 s_changedMap()->insert(QStringLiteral("QDateTimeEdit"), SIGNAL(dateTimeChanged(QDateTime)));
62 s_changedMap()->insert(QStringLiteral("QDial"), SIGNAL(valueChanged(int)));
63 s_changedMap()->insert(QStringLiteral("QDoubleSpinBox"), SIGNAL(valueChanged(double)));
64 s_changedMap()->insert(QStringLiteral("QLineEdit"), SIGNAL(textChanged(QString)));
65 s_changedMap()->insert(QStringLiteral("QSlider"), SIGNAL(valueChanged(int)));
66 s_changedMap()->insert(QStringLiteral("QSpinBox"), SIGNAL(valueChanged(int)));
67 s_changedMap()->insert(QStringLiteral("QTextEdit"), SIGNAL(textChanged()));
68 s_changedMap()->insert(QStringLiteral("QTextBrowser"), SIGNAL(sourceChanged(QString)));
69 s_changedMap()->insert(QStringLiteral("QPlainTextEdit"), SIGNAL(textChanged()));
70 s_changedMap()->insert(QStringLiteral("QTabWidget"), SIGNAL(currentChanged(int)));
71
72 // KDE
73 s_changedMap()->insert(QStringLiteral("KComboBox"), SIGNAL(activated(int)));
74 s_changedMap()->insert(QStringLiteral("KFontComboBox"), SIGNAL(activated(int)));
75 s_changedMap()->insert(QStringLiteral("KFontRequester"), SIGNAL(fontSelected(QFont)));
76 s_changedMap()->insert(QStringLiteral("KFontChooser"), SIGNAL(fontSelected(QFont)));
77 s_changedMap()->insert(QStringLiteral("KColorCombo"), SIGNAL(activated(QColor)));
78 s_changedMap()->insert(QStringLiteral("KColorButton"), SIGNAL(changed(QColor)));
79 s_changedMap()->insert(QStringLiteral("KDatePicker"), SIGNAL(dateSelected(QDate)));
80 s_changedMap()->insert(QStringLiteral("KDateWidget"), SIGNAL(changed(QDate)));
81 s_changedMap()->insert(QStringLiteral("KDateTimeWidget"), SIGNAL(valueChanged(QDateTime)));
82 s_changedMap()->insert(QStringLiteral("KEditListWidget"), SIGNAL(changed()));
83 s_changedMap()->insert(QStringLiteral("KListWidget"), SIGNAL(itemSelectionChanged()));
84 s_changedMap()->insert(QStringLiteral("KLineEdit"), SIGNAL(textChanged(QString)));
85 s_changedMap()->insert(QStringLiteral("KRestrictedLine"), SIGNAL(textChanged(QString)));
86 s_changedMap()->insert(QStringLiteral("KTextEdit"), SIGNAL(textChanged()));
87 s_changedMap()->insert(QStringLiteral("KUrlRequester"), SIGNAL(textChanged(QString)));
88 s_changedMap()->insert(QStringLiteral("KUrlComboRequester"), SIGNAL(textChanged(QString)));
89 s_changedMap()->insert(QStringLiteral("KUrlComboBox"), SIGNAL(urlActivated(QUrl)));
90 s_changedMap()->insert(QStringLiteral("KButtonGroup"), SIGNAL(changed(int)));
91 }
92}
93
94QHash<QString, QByteArray> *KConfigDialogManager::propertyMap()
95{
96 initMaps();
97 return s_propertyMap();
98}
99
100void KConfigDialogManager::init(bool trackChanges)
101{
102 initMaps();
103 d->trackChanges = trackChanges;
104
105 // Go through all of the children of the widgets and find all known widgets
106 (void)parseChildren(d->m_dialog, trackChanges);
107}
108
109void KConfigDialogManager::addWidget(QWidget *widget)
110{
111 (void)parseChildren(widget, true);
112}
113
114void KConfigDialogManager::setupWidget(QWidget *widget, KConfigSkeletonItem *item)
115{
116 QVariant minValue = item->minValue();
117 if (minValue.isValid()) {
118 // KSelector is using this property
119 if (widget->metaObject()->indexOfProperty("minValue") != -1) {
120 widget->setProperty("minValue", minValue);
121 }
122 if (widget->metaObject()->indexOfProperty("minimum") != -1) {
123 widget->setProperty("minimum", minValue);
124 }
125 }
126 QVariant maxValue = item->maxValue();
127 if (maxValue.isValid()) {
128 // KSelector is using this property
129 if (widget->metaObject()->indexOfProperty("maxValue") != -1) {
130 widget->setProperty("maxValue", maxValue);
131 }
132 if (widget->metaObject()->indexOfProperty("maximum") != -1) {
133 widget->setProperty("maximum", maxValue);
134 }
135 }
136
137 if (widget->whatsThis().isEmpty()) {
138 QString whatsThis = item->whatsThis();
139 if (!whatsThis.isEmpty()) {
140 widget->setWhatsThis(whatsThis);
141 }
142 }
143
144 if (widget->toolTip().isEmpty()) {
145 QString toolTip = item->toolTip();
146 if (!toolTip.isEmpty()) {
147 widget->setToolTip(toolTip);
148 }
149 }
150
151 // If it is a QGroupBox with only autoExclusive buttons
152 // and has no custom property and the config item type
153 // is an integer, assume we want to save the index like we did with
154 // KButtonGroup instead of if it is checked or not
155 QGroupBox *gb = qobject_cast<QGroupBox *>(widget);
156 if (gb && getCustomProperty(gb).isEmpty()) {
157 const KConfigSkeletonItem *item = d->m_conf->findItem(widget->objectName().mid(5));
158 if (item->property().userType() == QMetaType::Int) {
159 QObjectList children = gb->children();
160 children.removeAll(gb->layout());
161 const QList<QAbstractButton *> buttons = gb->findChildren<QAbstractButton *>();
162 bool allAutoExclusiveDirectChildren = true;
163 for (QAbstractButton *button : buttons) {
164 allAutoExclusiveDirectChildren = allAutoExclusiveDirectChildren && button->autoExclusive() && button->parent() == gb;
165 }
166 if (allAutoExclusiveDirectChildren) {
167 d->allExclusiveGroupBoxes << widget;
168 }
169 }
170 }
171
172 if (!item->isEqual(property(widget))) {
173 setProperty(widget, item->property());
174 }
175
176 d->updateWidgetIndicator(item->name(), widget);
177}
178
179bool KConfigDialogManager::parseChildren(const QWidget *widget, bool trackChanges)
180{
181 bool valueChanged = false;
182 const QList<QObject *> listOfChildren = widget->children();
183 if (listOfChildren.isEmpty()) { //?? XXX
184 return valueChanged;
185 }
186
187 const QMetaMethod onWidgetModifiedSlot = metaObject()->method(metaObject()->indexOfSlot("onWidgetModified()"));
188 Q_ASSERT(onWidgetModifiedSlot.isValid() && metaObject()->indexOfSlot("onWidgetModified()") >= 0);
189
190 for (QObject *object : listOfChildren) {
191 if (!object->isWidgetType()) {
192 continue; // Skip non-widgets
193 }
194
195 QWidget *childWidget = static_cast<QWidget *>(object);
196
197 QString widgetName = childWidget->objectName();
198 bool bParseChildren = true;
199 bool bSaveInsideGroupBox = d->insideGroupBox;
200
201 if (widgetName.startsWith(QLatin1String("kcfg_"))) {
202 // This is one of our widgets!
203 QString configId = widgetName.mid(5);
204 KConfigSkeletonItem *item = d->m_conf->findItem(configId);
205 if (item) {
206 d->knownWidget.insert(configId, childWidget);
207
208 setupWidget(childWidget, item);
209
210 if (trackChanges) {
211 bool changeSignalFound = false;
212
213 if (d->allExclusiveGroupBoxes.contains(childWidget)) {
214 const QList<QAbstractButton *> buttons = childWidget->findChildren<QAbstractButton *>();
215 for (QAbstractButton *button : buttons) {
216 connect(button, &QAbstractButton::toggled, this, [this] {
217 d->onWidgetModified();
218 });
219 }
220 }
221
222 QByteArray propertyChangeSignal = getCustomPropertyChangedSignal(childWidget);
223 if (propertyChangeSignal.isEmpty()) {
224 propertyChangeSignal = getUserPropertyChangedSignal(childWidget);
225 }
226
227 if (propertyChangeSignal.isEmpty()) {
228 // get the change signal from the meta object
229 const QMetaObject *metaObject = childWidget->metaObject();
230 QByteArray userproperty = getCustomProperty(childWidget);
231 if (userproperty.isEmpty()) {
232 userproperty = getUserProperty(childWidget);
233 }
234 if (!userproperty.isEmpty()) {
235 const int indexOfProperty = metaObject->indexOfProperty(userproperty.constData());
236 if (indexOfProperty != -1) {
237 const QMetaProperty property = metaObject->property(indexOfProperty);
238 const QMetaMethod notifySignal = property.notifySignal();
239 if (notifySignal.isValid()) {
240 connect(childWidget, notifySignal, this, onWidgetModifiedSlot);
241 changeSignalFound = true;
242 }
243 }
244 } else {
245 qCWarning(KCONFIG_WIDGETS_LOG) << "Don't know how to monitor widget" << childWidget->metaObject()->className() << "for changes!";
246 }
247 } else {
248 connect(childWidget, propertyChangeSignal.constData(), this, SLOT(onWidgetModified()));
249 changeSignalFound = true;
250 }
251
252 if (changeSignalFound) {
253 QComboBox *cb = qobject_cast<QComboBox *>(childWidget);
254 if (cb && cb->isEditable()) {
255 connect(cb, &QComboBox::editTextChanged, this, &KConfigDialogManager::widgetModified);
256 }
257 }
258 }
259 QGroupBox *gb = qobject_cast<QGroupBox *>(childWidget);
260 if (!gb) {
261 bParseChildren = false;
262 } else {
263 d->insideGroupBox = true;
264 }
265 } else {
266 qCWarning(KCONFIG_WIDGETS_LOG) << "A widget named" << widgetName << "was found but there is no setting named" << configId;
267 }
268 } else if (QLabel *label = qobject_cast<QLabel *>(childWidget)) {
269 QWidget *buddy = label->buddy();
270 if (!buddy) {
271 continue;
272 }
273 QString buddyName = buddy->objectName();
274 if (buddyName.startsWith(QLatin1String("kcfg_"))) {
275 // This is one of our widgets!
276 QString configId = buddyName.mid(5);
277 d->buddyWidget.insert(configId, childWidget);
278 }
279 }
280 // kf5: commented out to reduce debug output
281 // #ifndef NDEBUG
282 // else if (!widgetName.isEmpty() && trackChanges)
283 // {
284 // QHash<QString, QByteArray>::const_iterator changedIt = s_changedMap()->constFind(childWidget->metaObject()->className());
285 // if (changedIt != s_changedMap()->constEnd())
286 // {
287 // if ((!d->insideGroupBox || !qobject_cast<QRadioButton*>(childWidget)) &&
288 // !qobject_cast<QGroupBox*>(childWidget) &&!qobject_cast<QTabWidget*>(childWidget) )
289 // qCDebug(KCONFIG_WIDGETS_LOG) << "Widget '" << widgetName << "' (" << childWidget->metaObject()->className() << ") remains unmanaged.";
290 // }
291 // }
292 // #endif
293
294 if (bParseChildren) {
295 // this widget is not known as something we can store.
296 // Maybe we can store one of its children.
297 valueChanged |= parseChildren(childWidget, trackChanges);
298 }
299 d->insideGroupBox = bSaveInsideGroupBox;
300 }
301 return valueChanged;
302}
303
304void KConfigDialogManager::updateWidgets()
305{
306 bool changed = false;
307 bool bSignalsBlocked = signalsBlocked();
308 blockSignals(true);
309
310 QWidget *widget;
311 QHashIterator<QString, QWidget *> it(d->knownWidget);
312 while (it.hasNext()) {
313 it.next();
314 widget = it.value();
315
316 KConfigSkeletonItem *item = d->m_conf->findItem(it.key());
317 if (!item) {
318 qCWarning(KCONFIG_WIDGETS_LOG) << "The setting" << it.key() << "has disappeared!";
319 continue;
320 }
321
322 if (!item->isEqual(property(widget))) {
323 setProperty(widget, item->property());
324 // qCDebug(KCONFIG_WIDGETS_LOG) << "The setting" << it.key() << "[" << widget->className() << "] has changed";
325 changed = true;
326 }
327 if (item->isImmutable()) {
328 widget->setEnabled(false);
329 QWidget *buddy = d->buddyWidget.value(it.key(), nullptr);
330 if (buddy) {
331 buddy->setEnabled(false);
332 }
333 }
334 }
335 blockSignals(bSignalsBlocked);
336
337 if (changed) {
338 QTimer::singleShot(0, this, &KConfigDialogManager::widgetModified);
339 d->updateAllWidgetIndicators();
340 }
341}
342
343void KConfigDialogManager::updateWidgetsDefault()
344{
345 bool bUseDefaults = d->m_conf->useDefaults(true);
346 updateWidgets();
347 d->m_conf->useDefaults(bUseDefaults);
348 d->updateAllWidgetIndicators();
349}
350
351void KConfigDialogManager::setDefaultsIndicatorsVisible(bool enabled)
352{
353 d->setDefaultsIndicatorsVisible(enabled);
354}
355
356void KConfigDialogManager::updateSettings()
357{
358 bool changed = false;
359
360 QWidget *widget;
361 QHashIterator<QString, QWidget *> it(d->knownWidget);
362 while (it.hasNext()) {
363 it.next();
364 widget = it.value();
365
366 KConfigSkeletonItem *item = d->m_conf->findItem(it.key());
367 if (!item) {
368 qCWarning(KCONFIG_WIDGETS_LOG) << "The setting" << it.key() << "has disappeared!";
369 continue;
370 }
371
372 QVariant fromWidget = property(widget);
373 if (!item->isEqual(fromWidget)) {
374 item->setProperty(fromWidget);
375 changed = true;
376 }
377 }
378 if (changed) {
379 d->m_conf->save();
380 Q_EMIT settingsChanged();
381 d->updateAllWidgetIndicators();
382 }
383}
384
385QByteArray KConfigDialogManager::getUserProperty(const QWidget *widget) const
386{
387 MyHash *map = s_propertyMap();
388 const QMetaObject *metaObject = widget->metaObject();
389 const QString className(QLatin1String(metaObject->className()));
390 auto it = map->find(className);
391 if (it == map->end()) {
392 const QMetaProperty userProp = metaObject->userProperty();
393 if (userProp.isValid()) {
394 it = map->insert(className, userProp.name());
395 // qCDebug(KCONFIG_WIDGETS_LOG) << "class name: '" << className
396 //<< " 's USER property: " << metaProperty.name() << endl;
397 } else {
398 return QByteArray(); // no USER property
399 }
400 }
401
402 const QComboBox *cb = qobject_cast<const QComboBox *>(widget);
403 if (cb) {
404 const char *qcomboUserPropertyName = cb->QComboBox::metaObject()->userProperty().name();
405 const int qcomboUserPropertyIndex = qcomboUserPropertyName ? cb->QComboBox::metaObject()->indexOfProperty(qcomboUserPropertyName) : -1;
406 const char *widgetUserPropertyName = metaObject->userProperty().name();
407 const int widgetUserPropertyIndex = widgetUserPropertyName ? cb->metaObject()->indexOfProperty(widgetUserPropertyName) : -1;
408
409 // no custom user property set on subclass of QComboBox?
410 if (qcomboUserPropertyIndex == widgetUserPropertyIndex) {
411 return QByteArray(); // use the q/kcombobox special code
412 }
413 }
414
415 return it != map->end() ? it.value() : QByteArray{};
416}
417
418QByteArray KConfigDialogManager::getCustomProperty(const QWidget *widget) const
419{
420 QVariant prop(widget->property("kcfg_property"));
421 if (prop.isValid()) {
422 if (!prop.canConvert<QByteArray>()) {
423 qCWarning(KCONFIG_WIDGETS_LOG) << "kcfg_property on" << widget->metaObject()->className() << "is not of type ByteArray";
424 } else {
425 return prop.toByteArray();
426 }
427 }
428 return QByteArray();
429}
430
431QByteArray KConfigDialogManager::getUserPropertyChangedSignal(const QWidget *widget) const
432{
433 const QString className = QLatin1String(widget->metaObject()->className());
434 auto changedIt = s_changedMap()->constFind(className);
435
436 if (changedIt == s_changedMap()->constEnd()) {
437 // If the class name of the widget wasn't in the monitored widgets map, then look for
438 // it again using the super class name. This fixes a problem with using QtRuby/Korundum
439 // widgets with KConfigXT where 'Qt::Widget' wasn't being seen a the real deal, even
440 // though it was a 'QWidget'.
441 if (widget->metaObject()->superClass()) {
442 const QString parentClassName = QLatin1String(widget->metaObject()->superClass()->className());
443 changedIt = s_changedMap()->constFind(parentClassName);
444 }
445 }
446
447 return (changedIt == s_changedMap()->constEnd()) ? QByteArray() : *changedIt;
448}
449
450QByteArray KConfigDialogManager::getCustomPropertyChangedSignal(const QWidget *widget) const
451{
452 QVariant prop(widget->property("kcfg_propertyNotify"));
453 if (prop.isValid()) {
454 if (!prop.canConvert<QByteArray>()) {
455 qCWarning(KCONFIG_WIDGETS_LOG) << "kcfg_propertyNotify on" << widget->metaObject()->className() << "is not of type ByteArray";
456 } else {
457 return prop.toByteArray();
458 }
459 }
460 return QByteArray();
461}
462
463void KConfigDialogManager::setProperty(QWidget *w, const QVariant &v)
464{
465 if (d->allExclusiveGroupBoxes.contains(w)) {
466 const QList<QAbstractButton *> buttons = w->findChildren<QAbstractButton *>();
467 if (v.toInt() < buttons.count()) {
468 buttons[v.toInt()]->setChecked(true);
469 }
470 return;
471 }
472
473 QByteArray userproperty = getCustomProperty(w);
474 if (userproperty.isEmpty()) {
475 userproperty = getUserProperty(w);
476 }
477 if (userproperty.isEmpty()) {
478 QComboBox *cb = qobject_cast<QComboBox *>(w);
479 if (cb) {
480 if (cb->isEditable()) {
481 int i = cb->findText(v.toString());
482 if (i != -1) {
483 cb->setCurrentIndex(i);
484 } else {
485 cb->setEditText(v.toString());
486 }
487 } else {
488 cb->setCurrentIndex(v.toInt());
489 }
490 return;
491 }
492 }
493 if (userproperty.isEmpty()) {
494 qCWarning(KCONFIG_WIDGETS_LOG) << w->metaObject()->className() << "widget not handled!";
495 return;
496 }
497
498 w->setProperty(userproperty.constData(), v);
499}
500
501QVariant KConfigDialogManager::property(QWidget *w) const
502{
503 if (d->allExclusiveGroupBoxes.contains(w)) {
504 const QList<QAbstractButton *> buttons = w->findChildren<QAbstractButton *>();
505 for (int i = 0; i < buttons.count(); ++i) {
506 if (buttons[i]->isChecked()) {
507 return i;
508 }
509 }
510 return -1;
511 }
512
513 QByteArray userproperty = getCustomProperty(w);
514 if (userproperty.isEmpty()) {
515 userproperty = getUserProperty(w);
516 }
517 if (userproperty.isEmpty()) {
518 QComboBox *cb = qobject_cast<QComboBox *>(w);
519 if (cb) {
520 if (cb->isEditable()) {
521 return QVariant(cb->currentText());
522 } else {
523 return QVariant(cb->currentIndex());
524 }
525 }
526 }
527 if (userproperty.isEmpty()) {
528 qCWarning(KCONFIG_WIDGETS_LOG) << w->metaObject()->className() << "widget not handled!";
529 return QVariant();
530 }
531
532 return w->property(userproperty.constData());
533}
534
535bool KConfigDialogManager::hasChanged() const
536{
537 QWidget *widget;
538 QHashIterator<QString, QWidget *> it(d->knownWidget);
539 while (it.hasNext()) {
540 it.next();
541 widget = it.value();
542
543 KConfigSkeletonItem *item = d->m_conf->findItem(it.key());
544 if (!item) {
545 qCWarning(KCONFIG_WIDGETS_LOG) << "The setting" << it.key() << "has disappeared!";
546 continue;
547 }
548
549 if (!item->isEqual(property(widget))) {
550 // qCDebug(KCONFIG_WIDGETS_LOG) << "Widget for '" << it.key() << "' has changed.";
551 return true;
552 }
553 }
554 return false;
555}
556
557bool KConfigDialogManager::isDefault() const
558{
559 QWidget *widget;
560 QHashIterator<QString, QWidget *> it(d->knownWidget);
561 while (it.hasNext()) {
562 it.next();
563 widget = it.value();
564
565 KConfigSkeletonItem *item = d->m_conf->findItem(it.key());
566 if (!item) {
567 qCWarning(KCONFIG_WIDGETS_LOG) << "The setting" << it.key() << "has disappeared!";
568 continue;
569 }
570
571 if (property(widget) != item->getDefault()) {
572 return false;
573 }
574 }
575 return true;
576}
577
578KConfigDialogManagerPrivate::KConfigDialogManagerPrivate(KConfigDialogManager *qq)
579 : q(qq)
580 , insideGroupBox(false)
581 , defaultsIndicatorsVisible(false)
582{
583}
584
585void KConfigDialogManagerPrivate::setDefaultsIndicatorsVisible(bool enabled)
586{
587 if (defaultsIndicatorsVisible != enabled) {
588 defaultsIndicatorsVisible = enabled;
589 updateAllWidgetIndicators();
590 }
591}
592
593void KConfigDialogManagerPrivate::onWidgetModified()
594{
595 const auto widget = qobject_cast<QWidget *>(q->sender());
596 Q_ASSERT(widget);
597
598 const QLatin1String prefix("kcfg_");
599 QString configId = widget->objectName();
600 if (configId.startsWith(prefix)) {
601 configId.remove(0, prefix.size());
602 updateWidgetIndicator(configId, widget);
603 } else {
604 auto *parent = qobject_cast<QWidget *>(widget->parent());
605 Q_ASSERT(parent);
606 configId = parent->objectName();
607 Q_ASSERT(configId.startsWith(prefix));
608 configId.remove(0, prefix.size());
609 updateWidgetIndicator(configId, parent);
610 }
611
612 Q_EMIT q->widgetModified();
613}
614
615void KConfigDialogManagerPrivate::updateWidgetIndicator(const QString &configId, QWidget *widget)
616{
617 const auto item = m_conf->findItem(configId);
618 Q_ASSERT(item);
619
620 const auto widgetValue = q->property(widget);
621 const auto defaultValue = item->getDefault();
622
623 const auto defaulted = widgetValue == defaultValue;
624
625 if (allExclusiveGroupBoxes.contains(widget)) {
626 const QList<QAbstractButton *> buttons = widget->findChildren<QAbstractButton *>();
627 for (int i = 0; i < buttons.count(); i++) {
628 const auto value = widgetValue.toInt() == i && !defaulted && defaultsIndicatorsVisible;
629 buttons.at(i)->setProperty("_kde_highlight_neutral", value);
630 buttons.at(i)->update();
631 }
632 } else {
633 widget->setProperty("_kde_highlight_neutral", !defaulted && defaultsIndicatorsVisible);
634 widget->update();
635 }
636}
637
638void KConfigDialogManagerPrivate::updateAllWidgetIndicators()
639{
640 QHashIterator<QString, QWidget *> it(knownWidget);
641 while (it.hasNext()) {
642 it.next();
643 updateWidgetIndicator(it.key(), it.value());
644 }
645}
646
647#include "moc_kconfigdialogmanager.cpp"
KConfigDialogManager
Provides a means of automatically retrieving, saving and resetting KConfigSkeleton based settings in ...
Definition kconfigdialogmanager.h:132
KConfigDialogManager::setupWidget
void setupWidget(QWidget *widget, KConfigSkeletonItem *item)
Setup secondary widget properties.
Definition kconfigdialogmanager.cpp:114
KConfigDialogManager::~KConfigDialogManager
~KConfigDialogManager() override
Destructor.
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::property
QVariant property(QWidget *w) const
Retrieve a property.
Definition kconfigdialogmanager.cpp:501
KConfigDialogManager::initMaps
static void initMaps()
Initializes the property maps.
Definition kconfigdialogmanager.cpp:43
KConfigDialogManager::getCustomProperty
QByteArray getCustomProperty(const QWidget *widget) const
Find the property to use for a widget by querying the "kcfg_property" property of the widget.
Definition kconfigdialogmanager.cpp:418
KConfigDialogManager::getUserProperty
QByteArray getUserProperty(const QWidget *widget) const
Finds the USER property name using Qt's MetaProperty system, and caches it in the property map (the c...
Definition kconfigdialogmanager.cpp:385
KConfigDialogManager::widgetModified
void widgetModified()
If retrieveSettings() was told to track changes then if any known setting was changed this signal wil...
KConfigDialogManager::setDefaultsIndicatorsVisible
void setDefaultsIndicatorsVisible(bool enabled)
Show or hide an indicator when settings have changed from their default value.
Definition kconfigdialogmanager.cpp:351
KConfigDialogManager::propertyMap
static QHash< QString, QByteArray > * propertyMap()
Retrieve the map between widgets class names and the USER properties used for the configuration value...
Definition kconfigdialogmanager.cpp:94
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::getUserPropertyChangedSignal
QByteArray getUserPropertyChangedSignal(const QWidget *widget) const
Finds the changed signal of the USER property using Qt's MetaProperty system.
Definition kconfigdialogmanager.cpp:431
KConfigDialogManager::KConfigDialogManager
KConfigDialogManager(QWidget *parent, KCoreConfigSkeleton *conf)
Constructor.
Definition kconfigdialogmanager.cpp:31
KConfigDialogManager::setProperty
void setProperty(QWidget *w, const QVariant &v)
Set a property.
Definition kconfigdialogmanager.cpp:463
KConfigDialogManager::addWidget
void addWidget(QWidget *widget)
Add additional widgets to manage.
Definition kconfigdialogmanager.cpp:109
KConfigDialogManager::hasChanged
bool hasChanged() const
Returns whether the current state of the known widgets are different from the state in the config obj...
Definition kconfigdialogmanager.cpp:535
KConfigDialogManager::parseChildren
bool parseChildren(const QWidget *widget, bool trackChanges)
Recursive function that finds all known children.
Definition kconfigdialogmanager.cpp:179
KConfigDialogManager::updateSettings
void updateSettings()
Traverse the specified widgets, saving the settings of all known widgets in the settings object.
Definition kconfigdialogmanager.cpp:356
KConfigDialogManager::getCustomPropertyChangedSignal
QByteArray getCustomPropertyChangedSignal(const QWidget *widget) const
Find the changed signal of the property to use for a widget by querying the "kcfg_propertyNotify" pro...
Definition kconfigdialogmanager.cpp:450
KConfigDialogManager::isDefault
bool isDefault() const
Returns whether the current state of the known widgets are the same as the default state in the confi...
Definition kconfigdialogmanager.cpp:557
KConfigDialogManager::init
void init(bool trackChanges)
Definition kconfigdialogmanager.cpp:100
KConfigSkeletonItem::isEqual
virtual bool isEqual(const QVariant &p) const=0
KConfigSkeletonItem::isImmutable
bool isImmutable() const
KConfigSkeletonItem::minValue
virtual QVariant minValue() const
KConfigSkeletonItem::name
QString name() const
KConfigSkeletonItem::getDefault
QVariant getDefault() const
KConfigSkeletonItem::whatsThis
QString whatsThis() const
KConfigSkeletonItem::toolTip
QString toolTip() const
KConfigSkeletonItem::setProperty
virtual void setProperty(const QVariant &p)=0
KConfigSkeletonItem::maxValue
virtual QVariant maxValue() const
KConfigSkeletonItem::property
virtual QVariant property() const=0
QAbstractButton::toggled
void toggled(bool checked)
QByteArray::constData
const char * constData() const const
QByteArray::isEmpty
bool isEmpty() const const
QComboBox::setCurrentIndex
void setCurrentIndex(int index)
QComboBox::editTextChanged
void editTextChanged(const QString &text)
QComboBox::isEditable
bool isEditable() const const
QComboBox::findText
int findText(const QString &text, Qt::MatchFlags flags) const const
QComboBox::setEditText
void setEditText(const QString &text)
QHashIterator::hasNext
bool hasNext() const const
QHashIterator::key
const Key & key() const const
QHashIterator::value
const T & value() const const
QList::at
const_reference at(qsizetype i) const const
QList::count
qsizetype count() const const
QList::isEmpty
bool isEmpty() const const
QMetaMethod::isValid
bool isValid() const const
QMetaObject::className
const char * className() const const
QMetaObject::indexOfProperty
int indexOfProperty(const char *name) const const
QMetaObject::method
QMetaMethod method(int index) const const
QMetaObject::superClass
const QMetaObject * superClass() const const
QMetaProperty::isValid
bool isValid() const const
QMetaProperty::name
const char * name() const const
QObject::QObject
QObject(QObject *parent)
QObject::QObjectList
typedef QObjectList
QObject::Q_EMIT
Q_EMITQ_EMIT
QObject::blockSignals
bool blockSignals(bool block)
QObject::children
const QObjectList & children() const const
QObject::connect
QMetaObject::Connection connect(const QObject *sender, PointerToMemberFunction signal, Functor functor)
QObject::findChildren
QList< T > findChildren(Qt::FindChildOptions options) const const
QObject::metaObject
virtual const QMetaObject * metaObject() const const
QObject::parent
QObject * parent() const const
QObject::property
QVariant property(const char *name) const const
QObject::qobject_cast
T qobject_cast(QObject *object)
QObject::setProperty
bool setProperty(const char *name, QVariant &&value)
QObject::signalsBlocked
bool signalsBlocked() const const
QString::insert
QString & insert(qsizetype position, QChar ch)
QString::isEmpty
bool isEmpty() const const
QString::mid
QString mid(qsizetype position, qsizetype n) const const
QString::remove
QString & remove(QChar ch, Qt::CaseSensitivity cs)
QString::startsWith
bool startsWith(QChar c, Qt::CaseSensitivity cs) const const
Qt::CheckState
CheckState
QVariant::canConvert
bool canConvert() const const
QVariant::isValid
bool isValid() const const
QVariant::toByteArray
QByteArray toByteArray() const const
QVariant::toInt
int toInt(bool *ok) const const
QVariant::toString
QString toString() const const
QVariant::userType
int userType() const const
QWidget::setEnabled
void setEnabled(bool)
QWidget::layout
QLayout * layout() const const
QWidget::update
void update()
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.