You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
lxqt-panel-packaging/panel/pluginsettings.h

97 lines
2.6 KiB

/* BEGIN_COMMON_COPYRIGHT_HEADER
* (c)LGPL2+
*
* LXQt - a lightweight, Qt based, desktop toolset
* http://lxqt.org
*
* Copyright: 2015 LXQt team
* Authors:
* Paulo Lieuthier <paulolieuthier@gmail.com>
*
* This program or library is free software; you can redistribute it
* and/or modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA
*
* END_COMMON_COPYRIGHT_HEADER */
#ifndef PLUGIN_SETTINGS_H
#define PLUGIN_SETTINGS_H
#include <QObject>
#include <QString>
#include <QVariant>
#include "lxqtpanelglobals.h"
namespace LXQt
{
class Settings;
}
class PluginSettingsFactory;
class PluginSettingsPrivate;
/*!
* \brief
* Settings for particular plugin. This object/class can be used similarly as \sa QSettings.
* Object cannot be constructed direcly (it is the panel's responsibility to construct it for each plugin).
*
*
* \note
* We are relying here on so called "back linking" (calling a function defined in executable
* back from an external library)...
*/
class LXQT_PANEL_API PluginSettings : public QObject
{
Q_OBJECT
//for instantiation
friend class PluginSettingsFactory;
public:
~PluginSettings();
QString group() const;
QVariant value(const QString &key, const QVariant &defaultValue = QVariant()) const;
void setValue(const QString &key, const QVariant &value);
void remove(const QString &key);
bool contains(const QString &key) const;
QList<QMap<QString, QVariant> > readArray(const QString &prefix);
void setArray(const QString &prefix, const QList<QMap<QString, QVariant> > &hashList);
void clear();
void sync();
QStringList allKeys() const;
QStringList childGroups() const;
void beginGroup(const QString &subGroup);
void endGroup();
void loadFromCache();
signals:
void settingsChanged();
private:
explicit PluginSettings(LXQt::Settings *settings, const QString &group, QObject *parent = nullptr);
private:
QScopedPointer<PluginSettingsPrivate> d_ptr;
Q_DECLARE_PRIVATE(PluginSettings)
};
#endif