kdeconnect-kde/core/kdeconnectpluginconfig.h
Albert Vaca 02a2990720 Added a baseclass for the plugins' KCMs and a class for the plugins' config
Centralizing the plugins' config will ensure that all the plugins store it
the same way (ie: not in random files scattered around, like until now).
The base KCM class, together with the already existing base plugin class,
will give easy access to all the plugins to this centralized config. Also,
now the settings are not shared across devices (that is: every device can
have different config for a same plugin).

Note: This commit requires KCMUtils 5.9

REVIEW: 122927
2015-03-13 21:22:21 -07:00

68 lines
2.2 KiB
C++

/**
* Copyright 2015 Albert Vaca <albertvaka@gmail.com>
*
* 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) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* 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 KDECONNECTPLUGINCONFIG_H
#define KDECONNECTPLUGINCONFIG_H
#include <QDir>
#include <QString>
#include <QStringList>
#include <QVariant>
#include "default_args.h"
#include "kdeconnectcore_export.h"
struct KdeConnectPluginConfigPrivate;
class KDECONNECTCORE_EXPORT KdeConnectPluginConfig
{
public:
KdeConnectPluginConfig(const QString& deviceId, const QString& pluginName);
~KdeConnectPluginConfig();
/**
* A directory to store stuff for this device and plugin. It's private in the sense
* of not-shared with other plugins or devices, not from a security point of view.
*/
QDir privateDirectory();
/**
* Store a key-value pair in this config object
*/
void set(const QString& key, const QVariant& value);
/**
* Read a key-value pair from this config object
*/
QVariant get(const QString& key, const QVariant& defaultValue);
/**
* Convenience method that will convert the QVariant to whatever type for you
*/
template<typename T> T get(const QString& key, const T& defaultValue = default_arg<T>::get()) {
return get(key, QVariant(defaultValue)).template value<T>(); //Important note: Awesome template syntax is awesome
}
private:
QScopedPointer<KdeConnectPluginConfigPrivate> d;
};
#endif