/usr/include/KF5/KCMUtils/kpluginselector.h is in libkf5kcmutils-dev 5.44.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | /**
* This file is part of the KDE project
* Copyright (C) 2007, 2006 Rafael Fernández López <ereslibre@kde.org>
* Copyright (C) 2002-2003 Matthias Kretz <kretz@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License version 2 as published by the Free Software Foundation.
*
* 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef KPLUGINSELECTOR_H
#define KPLUGINSELECTOR_H
#include <QWidget>
#include <QtCore/QList>
#include <kcmutils_export.h>
#include <ksharedconfig.h>
class KPluginInfo;
/**
* @short A widget to select what plugins to load and configure the plugins.
*
* It shows the list of available plugins
*
* Since the user needs a way to know what a specific plugin does every plugin
* sould install a desktop file containing a name, comment and category field.
* The category is useful for applications that can use different kinds of
* plugins like a playlist, skin or visualization
*
* The location of these desktop files is the
* share/apps/<instancename>/<plugindir> directory. But if you need
* you may use a different directory
*
* You can add plugins from different KConfig[group], by just calling all times
* you want addPlugins method with the correct parameters
*
* Additionally, calls to constructor with same @p categoryName, will add new
* items to the same category, even if plugins are from different categories
*
* @author Matthias Kretz <kretz@kde.org>
* @author Rafael Fernández López <ereslibre@kde.org>
*/
class KCMUTILS_EXPORT KPluginSelector
: public QWidget
{
Q_OBJECT
Q_PROPERTY(QStringList configurationArguments READ configurationArguments WRITE setConfigurationArguments)
public:
enum PluginLoadMethod {
ReadConfigFile = 0,
IgnoreConfigFile
};
/**
* Create a new KPluginSelector
*/
KPluginSelector(QWidget *parent = nullptr);
/**
* Destructor
*/
~KPluginSelector();
/**
* Add a list of KParts plugins
*
* The information about the plugins will be loaded from the
* share/apps/<instancename>/kpartplugins directory
*
* @param componentName The name of the component of the plugin's parent.
* @param categoryName The translated name of the category. This is the
* name that is shown in the title. If the category
* did exist before because of another call to
* addPlugins, then they will be shown in that
* category. If @p categoryName is a new one, then
* a new category will be shown on the plugin window,
* and the list of plugins added to it
* @param categoryKey When you have different categories of KParts
* plugins you distinguish between the plugins using
* the Category key in the .desktop file. Use this
* parameter to select only those KParts plugins
* with the Category key == @p categoryKey. If
* @p categoryKey is not set the Category key is
* ignored and all plugins are shown. Not match case
* @param config The KConfig object that holds the state of the
* plugins being enabled or not. By default it will be
* set to KSharedConfig::openConfig(componentName + "rc").
*/
void addPlugins(const QString &componentName,
const QString &categoryName = QString(),
const QString &categoryKey = QString(),
KSharedConfig::Ptr config = KSharedConfig::Ptr());
/**
* Add a list of non-KParts plugins
*
* @param pluginInfoList A list of KPluginInfo objects containing the
* necessary information for the plugins you want to
* add to the list
* @param pluginLoadMethod If KPluginSelector will try to load the
* state of the plugin when loading the
* dialog from the configuration file or not.
* This is useful if for some reason you
* called the setPluginEnabled() for each plugin
* individually before loading the dialog, and
* don't want KPluginSelector to override them
* when loading
* @param categoryName The translated name of the category. This is the
* name that is shown in the title. If the category
* did exist before because of another call to
* addPlugins, then they will be shown in that
* category. If @p categoryName is a new one, then
* a new category will be shown on the plugin window,
* and the list of plugins added to it
* @param categoryKey When you have different categories of KParts
* plugins you distinguish between the plugins using
* the Category key in the .desktop file. Use this
* parameter to select only those KParts plugins
* with the Category key == @p categoryKey. If
* @p categoryKey is not set the Category key is
* ignored and all plugins are shown. Not match case
* @param config The KConfig object that holds the state of the
* plugins being enabled or not. By default it will
* use KSharedConfig::openConfig(). It is recommended to
* always pass a KConfig object if you use
* KSettings::PluginPage since you never know from
* where the page will be called (think global
* config app). For example KViewCanvas passes
* KConfig("kviewcanvas")
*
* @note All plugins that were set a config group using setConfig() method
* will load and save their information from there. For those that
* weren't any config object, @p config will be used
*/
void addPlugins(const QList<KPluginInfo> &pluginInfoList,
PluginLoadMethod pluginLoadMethod = ReadConfigFile,
const QString &categoryName = QString(),
const QString &categoryKey = QString(),
const KSharedConfig::Ptr &config = KSharedConfig::Ptr());
/**
* Load the state of the plugins (selected or not) from the KPluginInfo
* objects
*/
void load();
/**
* Save the configuration
*/
void save();
/**
* Change to applications defaults
* @see isDefault()
*/
void defaults();
/**
* Returns true if the plugin selector does not have any changes to application defaults
* @see defaults()
* @since 4.3
*/
bool isDefault() const;
/**
* Updates plugins state (enabled or not)
*
* This method won't save anything on any configuration file. It will just
* be useful if you added plugins with the method:
*
* \code
* void addPlugins(const QList<KPluginInfo> &pluginInfoList,
* const QString &categoryName = QString(),
* const QString &categoryKey = QString(),
* const KSharedConfig::Ptr &config = KSharedConfig::Ptr());
* \endcode
*
* To sum up, this method will update your plugins state depending if plugins
* are ticked or not on the KPluginSelector dialog, without saving anything
* anywhere
*/
void updatePluginsState();
/**
* Sets the @p arguments with which the configuration modules will be initialized
*
* @since 5.9
*/
void setConfigurationArguments(const QStringList &arguments);
/**
* Returns the configuration arguments that will be used
*
* @since 5.9
*/
QStringList configurationArguments() const;
Q_SIGNALS:
/**
* Tells you whether the configuration is changed or not.
*/
void changed(bool hasChanged);
/**
* Emitted after the config of an embedded KCM has been saved. The
* argument is the name of the parent component that needs to reload
* its config
*/
void configCommitted(const QByteArray &componentName);
private:
class Private;
Private *const d;
};
#endif
|