faces/packagestructure/sensorfacepackage.cpp

0001 /*
0002     SPDX-FileCopyrightText: 2007-2009 Aaron Seigo <aseigo@kde.org>
0003     SPDX-FileCopyrightText: 2020 Marco Martin <mart@kde.org>
0004
0005     SPDX-License-Identifier: LGPL-2.0-or-later
0006 */
0007
0008 #include <KLocalizedString>
0009 #include <kpackage/package.h>
0010 #include <kpackage/packagestructure.h>
0011
0012 class SensorFacePackage : public KPackage::PackageStructure
0013 {
0014     Q_OBJECT
0015 public:
0016     SensorFacePackage(QObject *parent = nullptr, const QVariantList &args = QVariantList())
0017         : KPackage::PackageStructure(parent, args)
0018     {
0019     }
0020
0021     void initPackage(KPackage::Package *package) override
0022     {
0023         package->setDefaultPackageRoot(QStringLiteral("ksysguard/sensorfaces"));
0024
0025         package->addDirectoryDefinition("ui", QStringLiteral("ui"), i18n("User Interface"));
0026
0027         package->addFileDefinition("CompactRepresentation",
0028                                    QStringLiteral("ui/CompactRepresentation.qml"),
0029                                    i18n("The compact representation of the sensors plasmoid when collapsed, for instance in a panel."));
0030         package->setRequired("CompactRepresentation", true);
0031
0032         package->addFileDefinition("FullRepresentation",
0033                                    QStringLiteral("ui/FullRepresentation.qml"),
0034                                    i18n("The representation of the plasmoid when it's fully expanded."));
0035         package->setRequired("FullRepresentation", true);
0036
0037         package->addFileDefinition("ConfigUI", QStringLiteral("ui/Config.qml"), i18n("The optional configuration page for this face."));
0038
0039         package->addDirectoryDefinition("config", QStringLiteral("config"), i18n("Configuration support"));
0040         package->addFileDefinition("mainconfigxml", QStringLiteral("config/main.xml"), i18n("KConfigXT xml file for face-specific configuration options."));
0041
0042         package->addFileDefinition("FaceProperties",
0043                                    QStringLiteral("faceproperties"),
0044                                    i18n("The configuration file that describes face properties and capabilities."));
0045         package->setRequired("FaceProperties", true);
0046     }
0047 };
0048
0049 K_EXPORT_KPACKAGE_PACKAGE_WITH_JSON(SensorFacePackage, "sensorface-packagestructure.json")
0050
0051 #include "sensorfacepackage.moc"