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.
118 lines
3.8 KiB
118 lines
3.8 KiB
/* This file is part of the KDE project
|
|
Copyright (C) 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 KSETTINGS_PLUGINPAGE_H
|
|
#define KSETTINGS_PLUGINPAGE_H
|
|
|
|
#include <tdecmodule.h>
|
|
#include <tdelibs_export.h>
|
|
|
|
class KPluginSelector;
|
|
|
|
namespace KSettings
|
|
{
|
|
|
|
/**
|
|
* @ingroup settings
|
|
* @ingroup plugin
|
|
* @short Convenience TDECModule for creating a plugins config page.
|
|
*
|
|
* This class makes it very easy to create a plugins configuration page to your
|
|
* program. All you need to do is create a class that is derived from
|
|
* PluginPage and add the appropriate plugin infos to the KPluginSelector.
|
|
* This is done using the pluginSelector() method:
|
|
* \code
|
|
* typedef KGenericFactory<MyAppPluginConfig, TQWidget> MyAppPluginConfigFactory;
|
|
* K_EXPORT_COMPONENT_FACTORY( kcm_myapppluginconfig, MyAppPluginConfigFactory( "kcm_myapppluginconfig" ) );
|
|
*
|
|
* MyAppPluginConfig( TQWidget * parent, const char *, const TQStringList & args )
|
|
* : PluginPage( MyAppPluginConfigFactory::instance(), parent, args )
|
|
* {
|
|
* pluginSelector()->addPlugins( TDEGlobal::instance()->instanceName(), i18n( "General Plugins" ), "General" );
|
|
* pluginSelector()->addPlugins( TDEGlobal::instance()->instanceName(), i18n( "Effects" ), "Effects" );
|
|
* }
|
|
* \endcode
|
|
*
|
|
* All that remains to be done is to create the appropriate .desktop file
|
|
* \verbatim
|
|
[Desktop Entry]
|
|
Encoding=UTF-8
|
|
Icon=plugin
|
|
Type=Service
|
|
ServiceTypes=TDECModule
|
|
|
|
X-TDE-ModuleType=Library
|
|
X-TDE-Library=myapppluginconfig
|
|
X-TDE-FactoryName=MyAppPluginConfigFactory
|
|
X-TDE-ParentApp=myapp
|
|
X-TDE-ParentComponents=myapp
|
|
|
|
Name=Plugins
|
|
Comment=Select and configure your plugins:
|
|
\endverbatim
|
|
*
|
|
* @author Matthias Kretz <kretz@kde.org>
|
|
* @since 3.2
|
|
*/
|
|
class TDEUTILS_EXPORT PluginPage : public TDECModule
|
|
{
|
|
TQ_OBJECT
|
|
public:
|
|
/**
|
|
* Standart TDECModule constructor. Automatically creates the the
|
|
* KPluginSelector widget.
|
|
*/
|
|
PluginPage( TQWidget * parent = 0, const char * name = 0, const TQStringList & args = TQStringList() );
|
|
|
|
/**
|
|
* Standart TDECModule constructor. Automatically creates the the
|
|
* KPluginSelector widget.
|
|
*/
|
|
PluginPage( TDEInstance * instance, TQWidget * parent = 0, const TQStringList & args = TQStringList() );
|
|
|
|
~PluginPage();
|
|
|
|
/**
|
|
* @return a reference to the KPluginSelector.
|
|
*/
|
|
KPluginSelector * pluginSelector();
|
|
|
|
/**
|
|
* Load the state of the plugins (selected or not) from the KPluginInfo
|
|
* objects. For KParts plugins everything should work automatically. For
|
|
* your own type of plugins you might need to reimplement the
|
|
* KPluginInfo::pluginLoaded() method. If that doesn't fit your needs
|
|
* you can also reimplement this method.
|
|
*/
|
|
virtual void load();
|
|
|
|
/**
|
|
* Save the state of the plugins to TDEConfig objects
|
|
*/
|
|
virtual void save();
|
|
virtual void defaults();
|
|
|
|
private:
|
|
class PluginPagePrivate;
|
|
PluginPagePrivate * d;
|
|
};
|
|
|
|
}
|
|
#endif // KSETTINGS_PLUGINPAGE_H
|