Differential D15372 Diff 41251 packageplugins/effect/effect.cpp

Changeset View

Standalone View

packageplugins/effect/effect.cpp

This file was added.

1		/******************************************************************************
2		* Copyright 2018 Vlad Zaogorodniy <vladzzag@gmail.com> *
3		* *
4		* This library is free software; you can redistribute it and/or *
5		* modify it under the terms of the GNU Library General Public *
6		* License as published by the Free Software Foundation; either *
7		* version 2 of the License, or (at your option) any later version. *
8		* *
9		* This library is distributed in the hope that it will be useful, *
10		* but WITHOUT ANY WARRANTY; without even the implied warranty of *
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
12		* Library General Public License for more details. *
13		* *
14		* You should have received a copy of the GNU Library General Public License *
15		* along with this library; see the file COPYING.LIB. If not, write to *
16		* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, *
17		* Boston, MA 02110-1301, USA. *
18		*******************************************************************************/
19
20		#include "effect.h"
21
22		#include <KLocalizedString>
23
24		EffectPackageStructure::EffectPackageStructure(QObject *parent, const QVariantList &args)
25		: KPackage::PackageStructure(parent, args)
26		{
27		}
28
29		void EffectPackageStructure::initPackage(KPackage::Package *package)
30		{
31		package->setDefaultPackageRoot(QStringLiteral("kwin/effects/"));
32
33		package->addDirectoryDefinition("code", QStringLiteral("code"), i18n("Executable Scripts"));
34		package->addDirectoryDefinition("config", QStringLiteral("config"), i18n("Configuration Definitions"));
35		package->addDirectoryDefinition("ui", QStringLiteral("ui"), i18n("User Interface"));
	davidedmundsonUnsubmitted Done The exact file path is hardcoded as config/main.qml, at which point we should add a fileDefintion for that instead davidedmundson: The exact file path is hardcoded as config/main.qml, at which point we should add a…
36
37		package->addFileDefinition("mainscript", QStringLiteral("code/main.js"), i18n("Main Script File"));
38		package->setRequired("mainscript", true);
39
40		package->setMimeTypes("config", {QStringLiteral("text/xml")});
41		package->setMimeTypes("effect", {QStringLiteral("text/plain")});
42		}
	davidedmundsonUnsubmitted Done Where is effect defined? davidedmundson: Where is effect defined?
	zzagAuthorUnsubmitted Done Copy-paste. I also wonder why other package structure plugins do the same. Can we drop it? zzag: Copy-paste. I also wonder why other package structure plugins do the same. Can we drop it?
	martUnsubmitted Not Done drop what? mart: drop what?
	zzagAuthorUnsubmitted Not Done See https://phabricator.kde.org/D15372?id=41265 zzag: See https://phabricator.kde.org/D15372?id=41265
43
44		void EffectPackageStructure::pathChanged(KPackage::Package *package)
45		{
46		if (package->path().isEmpty()) {
47		return;
48		}
49
50		const KPluginMetaData md(package->metadata().metaDataFileName());
51		const QString mainScript = md.value("X-Plasma-MainScript");
52		if (mainScript.isEmpty()) {
53		return;
54		}
55
56		package->addFileDefinition("mainscript", mainScript, i18n("Main Script File"));
57		}
58
59		K_EXPORT_KPACKAGE_PACKAGE_WITH_JSON(EffectPackageStructure, "kwin-packagestructure-effect.json")
60
61		#include "effect.moc"