diff --git a/src/quickaddons/managedconfigmodule.h b/src/quickaddons/managedconfigmodule.h index fb31da2..ced9dc1 100644 --- a/src/quickaddons/managedconfigmodule.h +++ b/src/quickaddons/managedconfigmodule.h @@ -1,225 +1,225 @@ /* This file is part of the KDE libraries Copyright (C) 2019 Kevin Ottens This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 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 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 MANAGEDCONFIGMODULE_H #define MANAGEDCONFIGMODULE_H #include namespace KQuickAddons { class ManagedConfigModulePrivate; /** * @class KQuickAddons::ManagedConfigModule managedconfigmodule.h KQuickAddons/ManagedConfigModule * * The base class for configuration modules using KConfigXT settings. * * Configuration modules are realized as plugins that are loaded only when * needed. * * The module in principle is a simple widget displaying the * item to be changed. The module has a very small interface. * * All the necessary glue logic and the GUI bells and whistles * are provided by the control center and must not concern * the module author. * * To write a config module, you have to create a C++ library * and an accompaning QML user interface. * The library must contain a factory function like the following: * * \code * #include * * K_PLUGIN_FACTORY(MyConfigModuleFactory, registerPlugin() ) * \endcode * * The constructor of the ConfigModule then looks like this: * \code * YourConfigModule::YourConfigModule( QObject* parent ) * : ManagedConfigModule( parent ), * SettingsObject( this ) * { * KAboutData *about = new KAboutData( * , i18n( "..." ), * KDE_VERSION_STRING, QString(), KAboutLicense::GPL, * i18n( "Copyright 2006 ..." ) ); * about->addAuthor( i18n(...) ); * setAboutData( about ); * . * . * . * } * \endcode * * We are assuming here that SettingsObject is a class generated from a kcfg file * and that it will be somehow exposed as a constant property to be used from the QML side. * It will be automatically discovered by ManagedConfigModule which will update * the saveNeeded and defaults inherited properties by itself. Thus by inheriting from * this class you shall not try to manage those properties yourselves. * * The QML part must be in the KPackage format, installed under share/kpackage/kcms. * @see KPackage::Package * The package must have the same name as the KAboutData componentName, to be installed * by CMake with the command: * kpackage_install_package(package kcm_componentName kcms) * given "package" is the subdirectory in the source tree where the package sources are * located, and "kcm_componentName" is the componentname passed to the KAboutData in the * C++ part. * The main config dialog UI will be the file * ui/main.qml from the package (or what X-KPackage-MainScript value is in the * package metadata desktop file). * * The QML part can access all the properties of ManagedConfigModule (together with the properties * defined in its subclass) by accessing to the global object "kcm", or with the * import of "org.kde.kcm 1.0" the ConfigModule attached property. * * \code * import QtQuick 2.1 * import QtQuick.Controls 1.0 as QtControls * import org.kde.kcm 1.0 * import org.kde.plasma.core 2.0 as PlasmaCore * * Item { * //implicitWidth and implicitHeight will be used as initial size * //when loaded in kcmshell5 * implicitWidth: units.gridUnit * 20 * implicitHeight: units.gridUnit * 20 * * ConfigModule.buttons: ConfigModule.Help|ConfigModule.Apply * Label { * text: kcm.needsSave * } * } * \endcode * * See https://techbase.kde.org/Development/Tutorials/KCM_HowTo * for more detailed documentation. * * @since 5.65 */ class QUICKADDONS_EXPORT ManagedConfigModule : public ConfigModule { Q_OBJECT public: /** * Base class for all modules which manage automatically some of their state. * * @param aboutData becomes owned by the ManagedConfigModule */ explicit ManagedConfigModule(const KAboutData *aboutData, QObject *parent = nullptr, const QVariantList &args = QVariantList()); /** * @param metaData description for the plugin: it will generate a KAboutData from that */ explicit ManagedConfigModule(const KPluginMetaData &metaData, QObject *parent = nullptr, const QVariantList &args = QVariantList()); /** * Base class for all KControlModules. * * @note do not emit changed signals here, since they are not yet connected * to any slot. */ explicit ManagedConfigModule(QObject *parent = nullptr, const QVariantList &args = QVariantList()); /** * Destroys the module. */ ~ManagedConfigModule(); public Q_SLOTS: /** * Load the configuration data into the module. * * This method is invoked whenever the module should read its configuration * (most of the times from a config file) and update the user interface. * This happens when the user clicks the "Reset" button in the control * center, to undo all of his changes and restore the currently valid * settings. It is also called right after construction. * * By default this will load the settings from the child setting objects * of this module. */ void load() override; /** * Save the configuration data. * * The save method stores the config information as shown * in the user interface in the config files. * It is called when the user clicks "Apply" or "Ok". * * By default this will save the child setting objects * of this module. */ void save() override; /** * Sets the configuration to sensible default values. * * This method is called when the user clicks the "Default" * button. It should set the display to useful values. * * By default this will reset to defaults the child setting objects * of this module. */ void defaults() override; protected Q_SLOTS: /** * Forces the module to reevaluate the saveNeeded and * representsDefault state. * * This is required for some modules which might have * some settings managed outside of KConfigXT objects. */ void settingsChanged(); private: /** * Allows to indicate if the module requires saving. * - * By default this returns false, it needs to be overriden only + * By default this returns false, it needs to be overridden only * if the module has state outside of the settings declared in * the KConfigXT classes it uses. */ virtual bool isSaveNeeded() const; /** * Allows to indicate if the module state is representing its defaults. * - * By default this returns true, it needs to be overriden only + * By default this returns true, it needs to be overridden only * if the module has state outside of the settings declared in * the KConfigXT classes it uses. */ virtual bool isDefaults() const; Q_PRIVATE_SLOT(d, void _k_registerSettings()) ManagedConfigModulePrivate *const d; friend class ManagedConfigModulePrivate; }; } #endif //MANAGEDCONFIGMODULE_H