Differential D3716 Diff 9131 kerfuffle/pluginsettingspage.cpp

Changeset View

Standalone View

kerfuffle/pluginsettingspage.cpp

This file was added.

1		/*
2		* ark -- archiver for the KDE project
3		*
4		* Copyright (C) 2016 Elvis Angelaccio <elvis.angelaccio@kde.org>
5		*
6		* Redistribution and use in source and binary forms, with or without
7		* modification, are permitted provided that the following conditions
8		* are met:
9		*
10		* 1. Redistributions of source code must retain the above copyright
11		* notice, this list of conditions and the following disclaimer.
12		* 2. Redistributions in binary form must reproduce the above copyright
13		* notice, this list of conditions and the following disclaimer in the
14		* documentation and/or other materials provided with the distribution.
15		*
16		* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17		* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18		* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19		* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20		* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES ( INCLUDING, BUT
21		* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION ) HOWEVER CAUSED AND ON ANY
23		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24		* ( INCLUDING NEGLIGENCE OR OTHERWISE ) ARISING IN ANY WAY OUT OF THE USE OF
25		* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26		*/
27
28		#include "pluginsettingspage.h"
29		#include "ark_debug.h"
30
31		#include <QTreeWidget>
32
33		#include <KConfigDialogManager>
34
35		namespace Kerfuffle
36		{
37
38		PluginSettingsPage::PluginSettingsPage(QWidget *parent, const QString &name, const QString &iconName)
39		: SettingsPage(parent, name, iconName)
40		{
41		setupUi(this);
42
43		foreach (const auto plugin, m_pluginManager.installedPlugins()) {
44		const auto metaData = plugin->metaData();
45		auto item = new QTreeWidgetItem(kcfg_disabledPlugins);
46		item->setData(0, Qt::UserRole, QVariant::fromValue(plugin));
47		item->setText(0, metaData.name());
48		item->setText(1, metaData.description());
49		item->setCheckState(0, plugin->isEnabled() ? Qt::Checked : Qt::Unchecked);
50		if (!plugin->isEnabled()) {
51		m_toBeDisabled << metaData.pluginId();
52		}
53		if (!plugin->hasRequiredExecutables()) {
54		item->setDisabled(true);
55		for (int i : {0, 1}) {
56		item->setToolTip(i, i18n("The plugin cannot be used because one or more required executables are missing. Check your installation."));
57		}
	rthomsenUnsubmitted Not Done executables -> required executables Checks -> Check rthomsen: executables -> required executables Checks -> Check
58		}
59		}
60
61		kcfg_disabledPlugins->resizeColumnToContents(0);
62		connect(kcfg_disabledPlugins, &QTreeWidget::itemChanged, this, &PluginSettingsPage::slotItemChanged);
63
64		// Set the custom property that KConfigDialogManager will use to update the settings.
65		kcfg_disabledPlugins->setProperty("kcfg_property", QByteArray("disabledPlugins"));
66		// Tell KConfigDialogManager to monitor the itemChanged signal for a QTreeWidget instance in the dialog.
67		KConfigDialogManager::changedMap()->insert(QString::fromLatin1(QTreeWidget::staticMetaObject.className()),
68		SIGNAL(itemChanged(QTreeWidgetItem*,int)));
69		}
70
71		void PluginSettingsPage::slotSettingsChanged()
72		{
73		m_toBeDisabled.clear();
74		}
75
76		void PluginSettingsPage::slotDefaultsButtonClicked()
77		{
78		// KConfigDialogManager doesn't know how to reset the QTreeWidget, we need to do it manually.
79		QTreeWidgetItemIterator iterator(kcfg_disabledPlugins);
80		while (*iterator) {
81		auto item = *iterator;
82		// By default every plugin is enabled.
83		item->setCheckState(0, Qt::Checked);
84		iterator++;
85		}
86		}
87
88		void PluginSettingsPage::slotItemChanged(QTreeWidgetItem *item)
89		{
90		auto plugin = item->data(0, Qt::UserRole).value<Plugin*>();
91		if (!plugin) {
92		return;
93		}
94
95		const auto pluginId = plugin->metaData().pluginId();
96		plugin->setEnabled(item->checkState(0) == Qt::Checked);
97		// If unchecked, add to the list of plugins that will be disabled.
98		m_toBeDisabled.removeAll(pluginId);
99		if (!plugin->isEnabled()) {
100		m_toBeDisabled << pluginId;
101		}
102		// Enable the Apply button by setting the property.
103		qCDebug(ARK) << "Going to disable the following plugins:" << m_toBeDisabled;
104		kcfg_disabledPlugins->setProperty("disabledPlugins", m_toBeDisabled);
105		}
106
107		}
108