Provide config interface for scripted effects and KWin scripts
A scripted component providing: * ui/config.ui * config/main.xml can get a config interface by using the following in metadata.desktop: X-KDE-ServiceTypes=KWin/Effect,KCModule X-KDE-PluginKeyword=`X-KDE-PluginInfo-Name` X-KDE-Library=kcm_kwin4_genericscripted X-KDE-ParentComponents=`X-KDE-PluginInfo-Name` `X-KDE-PluginInfo-Name` has to be replaced by the actual value. In case of a KWin Script the X-KDE-ServiceTypes needs to be: X-KDE-ServiceTypes=KWin/Script,KCModule The GenericScriptedConfig tries to identify the package from the keyword and creates a Plasma::ConfigLoader and loads the UI from the packaged UI file.
This commit is contained in:
Martin Gräßlin
parent
d9d9aad674
commit
650c606e95
4 changed files with 252 additions and 0 deletions
|
|
@ -87,6 +87,10 @@ add_subdirectory( effects )
|
||||||
add_subdirectory( scripts )
|
add_subdirectory( scripts )
|
||||||
add_subdirectory( tabbox )
|
add_subdirectory( tabbox )
|
||||||
|
|
||||||
|
if(KWIN_BUILD_SCRIPTING)
|
||||||
|
add_subdirectory(scripting)
|
||||||
|
endif()
|
||||||
|
|
||||||
########### next target ###############
|
########### next target ###############
|
||||||
|
|
||||||
set(kwin_KDEINIT_SRCS
|
set(kwin_KDEINIT_SRCS
|
||||||
|
|
|
||||||
4
scripting/CMakeLists.txt
Normal file
4
scripting/CMakeLists.txt
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
set(kcm_kwin4_genericscripted_SRCS genericscriptedconfig.cpp)
|
||||||
|
kde4_add_plugin( kcm_kwin4_genericscripted ${kcm_kwin4_genericscripted_SRCS} )
|
||||||
|
target_link_libraries( kcm_kwin4_genericscripted ${KDE4_KIO_LIBS} ${KDE4_KDEUI_LIBS} ${KDE4_PLASMA_LIBS} ${QT_QTUITOOLS_LIBRARY} )
|
||||||
|
install( TARGETS kcm_kwin4_genericscripted DESTINATION ${PLUGIN_INSTALL_DIR} )
|
||||||
149
scripting/genericscriptedconfig.cpp
Normal file
149
scripting/genericscriptedconfig.cpp
Normal file
|
|
@ -0,0 +1,149 @@
|
||||||
|
/*
|
||||||
|
* KWin - the KDE window manager
|
||||||
|
* This file is part of the KDE project.
|
||||||
|
*
|
||||||
|
* Copyright (C) 2013 Martin Gräßlin <mgraesslin@kde.org>
|
||||||
|
*
|
||||||
|
* This program is free software; you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation; either version 2 of the License, or
|
||||||
|
* (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "genericscriptedconfig.h"
|
||||||
|
#include "config-kwin.h"
|
||||||
|
#include <KDE/KStandardDirs>
|
||||||
|
#include <KDE/KLocalizedString>
|
||||||
|
#include <Plasma/ConfigLoader>
|
||||||
|
|
||||||
|
#include <QDBusConnection>
|
||||||
|
#include <QDBusMessage>
|
||||||
|
#include <QFile>
|
||||||
|
#include <QLabel>
|
||||||
|
#include <QUiLoader>
|
||||||
|
#include <QVBoxLayout>
|
||||||
|
|
||||||
|
namespace KWin {
|
||||||
|
|
||||||
|
GenericScriptedConfigFactory::GenericScriptedConfigFactory()
|
||||||
|
: KPluginFactory("kcm_kwin4_genericscripted")
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
QObject *GenericScriptedConfigFactory::create(const char *iface, QWidget *parentWidget, QObject *parent, const QVariantList &args, const QString &keyword)
|
||||||
|
{
|
||||||
|
Q_UNUSED(iface)
|
||||||
|
Q_UNUSED(parent)
|
||||||
|
if (keyword.startsWith("kwin4_effect_")) {
|
||||||
|
return new ScriptedEffectConfig(componentData(), keyword, parentWidget, args);
|
||||||
|
} else {
|
||||||
|
return new ScriptingConfig(componentData(), keyword, parentWidget, args);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
GenericScriptedConfig::GenericScriptedConfig(const KComponentData &data, const QString &keyword, QWidget *parent, const QVariantList &args)
|
||||||
|
: KCModule(data, parent, args)
|
||||||
|
, m_packageName(keyword)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
GenericScriptedConfig::~GenericScriptedConfig()
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
void GenericScriptedConfig::createUi()
|
||||||
|
{
|
||||||
|
QVBoxLayout* layout = new QVBoxLayout(this);
|
||||||
|
|
||||||
|
const QString kconfigXTFile = KStandardDirs::locate("data", QLatin1String(KWIN_NAME) + '/' + typeName() + '/' + m_packageName + "/contents/config/main.xml");
|
||||||
|
const QString uiPath = KStandardDirs::locate("data", QLatin1String(KWIN_NAME) + '/' + typeName() + '/' + m_packageName + "/contents/ui/config.ui");
|
||||||
|
if (kconfigXTFile.isEmpty() || uiPath.isEmpty()) {
|
||||||
|
layout->addWidget(new QLabel(i18nc("Error message", "Plugin doesn't provide configuration file in expected location")));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
QFile xmlFile(kconfigXTFile);
|
||||||
|
KConfigGroup cg = configGroup();
|
||||||
|
Plasma::ConfigLoader *configLoader = new Plasma::ConfigLoader(&cg, &xmlFile, this);
|
||||||
|
// load the ui file
|
||||||
|
QUiLoader *loader = new QUiLoader(this);
|
||||||
|
QFile uiFile(uiPath);
|
||||||
|
uiFile.open(QFile::ReadOnly);
|
||||||
|
QWidget *customConfigForm = loader->load(&uiFile, this);
|
||||||
|
uiFile.close();
|
||||||
|
layout->addWidget(customConfigForm);
|
||||||
|
addConfig(configLoader, customConfigForm);
|
||||||
|
}
|
||||||
|
|
||||||
|
void GenericScriptedConfig::save()
|
||||||
|
{
|
||||||
|
KCModule::save();
|
||||||
|
reload();
|
||||||
|
}
|
||||||
|
|
||||||
|
void GenericScriptedConfig::reload()
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
ScriptedEffectConfig::ScriptedEffectConfig(const KComponentData &data, const QString &keyword, QWidget *parent, const QVariantList &args)
|
||||||
|
: GenericScriptedConfig(data, keyword, parent, args)
|
||||||
|
{
|
||||||
|
createUi();
|
||||||
|
}
|
||||||
|
|
||||||
|
ScriptedEffectConfig::~ScriptedEffectConfig()
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
QString ScriptedEffectConfig::typeName() const
|
||||||
|
{
|
||||||
|
return QString("effects");
|
||||||
|
}
|
||||||
|
|
||||||
|
KConfigGroup ScriptedEffectConfig::configGroup()
|
||||||
|
{
|
||||||
|
return KSharedConfig::openConfig(KWIN_CONFIG)->group("Effect-" + packageName());
|
||||||
|
}
|
||||||
|
|
||||||
|
void ScriptedEffectConfig::reload()
|
||||||
|
{
|
||||||
|
QDBusMessage message = QDBusMessage::createMethodCall("org.kde.kwin", "/KWin", "org.kde.KWin", "reconfigureEffect");
|
||||||
|
message << QString(packageName());
|
||||||
|
QDBusConnection::sessionBus().send(message);
|
||||||
|
}
|
||||||
|
|
||||||
|
ScriptingConfig::ScriptingConfig(const KComponentData &data, const QString &keyword, QWidget *parent, const QVariantList &args)
|
||||||
|
: GenericScriptedConfig(data, keyword, parent, args)
|
||||||
|
{
|
||||||
|
createUi();
|
||||||
|
}
|
||||||
|
|
||||||
|
ScriptingConfig::~ScriptingConfig()
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
KConfigGroup ScriptingConfig::configGroup()
|
||||||
|
{
|
||||||
|
return KSharedConfig::openConfig(KWIN_CONFIG)->group("Script-" + packageName());
|
||||||
|
}
|
||||||
|
|
||||||
|
QString ScriptingConfig::typeName() const
|
||||||
|
{
|
||||||
|
return QString("scripts");
|
||||||
|
}
|
||||||
|
|
||||||
|
void ScriptingConfig::reload()
|
||||||
|
{
|
||||||
|
// TODO: what to call
|
||||||
|
}
|
||||||
|
|
||||||
|
K_EXPORT_PLUGIN(GenericScriptedConfigFactory())
|
||||||
|
|
||||||
|
} // namespace
|
||||||
95
scripting/genericscriptedconfig.h
Normal file
95
scripting/genericscriptedconfig.h
Normal file
|
|
@ -0,0 +1,95 @@
|
||||||
|
/*
|
||||||
|
* KWin - the KDE window manager
|
||||||
|
* This file is part of the KDE project.
|
||||||
|
*
|
||||||
|
* Copyright (C) 2013 Martin Gräßlin <mgraesslin@kde.org>
|
||||||
|
*
|
||||||
|
* This program is free software; you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation; either version 2 of the License, or
|
||||||
|
* (at your option) any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef KWIN_GENERICSCRIPTEDCONFIG_H
|
||||||
|
#define KWIN_GENERICSCRIPTEDCONFIG_H
|
||||||
|
|
||||||
|
#include <KCModule>
|
||||||
|
#include <KPluginFactory>
|
||||||
|
|
||||||
|
namespace KWin
|
||||||
|
{
|
||||||
|
|
||||||
|
class GenericScriptedConfigFactory : public KPluginFactory
|
||||||
|
{
|
||||||
|
Q_OBJECT
|
||||||
|
public:
|
||||||
|
GenericScriptedConfigFactory();
|
||||||
|
|
||||||
|
protected:
|
||||||
|
virtual QObject *create(const char *iface, QWidget *parentWidget, QObject *parent, const QVariantList &args, const QString &keyword);
|
||||||
|
};
|
||||||
|
|
||||||
|
class GenericScriptedConfig : public KCModule
|
||||||
|
{
|
||||||
|
Q_OBJECT
|
||||||
|
|
||||||
|
public:
|
||||||
|
GenericScriptedConfig(const KComponentData &data, const QString &keyword, QWidget *parent, const QVariantList &args);
|
||||||
|
virtual ~GenericScriptedConfig();
|
||||||
|
|
||||||
|
public slots:
|
||||||
|
virtual void save();
|
||||||
|
|
||||||
|
protected:
|
||||||
|
const QString &packageName() const;
|
||||||
|
void createUi();
|
||||||
|
virtual QString typeName() const = 0;
|
||||||
|
virtual KConfigGroup configGroup() = 0;
|
||||||
|
virtual void reload();
|
||||||
|
|
||||||
|
private:
|
||||||
|
QString m_packageName;
|
||||||
|
};
|
||||||
|
|
||||||
|
class ScriptedEffectConfig : public GenericScriptedConfig
|
||||||
|
{
|
||||||
|
Q_OBJECT
|
||||||
|
public:
|
||||||
|
ScriptedEffectConfig(const KComponentData &data, const QString &keyword, QWidget *parent, const QVariantList &args);
|
||||||
|
virtual ~ScriptedEffectConfig();
|
||||||
|
protected:
|
||||||
|
virtual QString typeName() const;
|
||||||
|
virtual KConfigGroup configGroup();
|
||||||
|
virtual void reload();
|
||||||
|
};
|
||||||
|
|
||||||
|
class ScriptingConfig : public GenericScriptedConfig
|
||||||
|
{
|
||||||
|
Q_OBJECT
|
||||||
|
public:
|
||||||
|
ScriptingConfig(const KComponentData &data, const QString &keyword, QWidget *parent, const QVariantList &args);
|
||||||
|
virtual ~ScriptingConfig();
|
||||||
|
|
||||||
|
protected:
|
||||||
|
virtual QString typeName() const;
|
||||||
|
virtual KConfigGroup configGroup();
|
||||||
|
virtual void reload();
|
||||||
|
};
|
||||||
|
|
||||||
|
inline
|
||||||
|
const QString &GenericScriptedConfig::packageName() const
|
||||||
|
{
|
||||||
|
return m_packageName;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif // KWIN_GENERICSCRIPTEDCONFIG_H
|
||||||
Loading…
Reference in a new issue