KSettings::PluginPage Class Reference

#include <pluginpage.h>

Inheritance diagram for KSettings::PluginPage:

Public Member Functions
	PluginPage (TQWidget *parent=0, const char *name=0, const TQStringList &args=TQStringList())
	PluginPage (TDEInstance *instance, TQWidget *parent=0, const TQStringList &args=TQStringList())
KPluginSelector *	pluginSelector ()
virtual void	load ()
virtual void	save ()
virtual void	defaults ()
Public Member Functions inherited from TDECModule
virtual void	sysdefaults ()
virtual TQString	quickHelp () const
virtual TQString	handbookDocPath () const
virtual TQString	handbookSection () const
virtual const TDEAboutData *	aboutData () const
void	setAboutData (TDEAboutData *about)
int	buttons () const
TQString	rootOnlyMsg () const
bool	useRootOnlyMsg () const
const TQPtrList< TDEConfigDialogManager > &	configs () const

Additional Inherited Members
Public Types inherited from TDECModule
enum	Button
Signals inherited from TDECModule
void	changed (bool state)
void	quickHelpChanged ()
Protected Slots inherited from TDECModule
void	changed ()
void	widgetChanged ()
Protected Member Functions inherited from TDECModule
TDEConfigDialogManager *	addConfig (TDEConfigSkeleton *config, TQWidget *widget)
void	setQuickHelp (const TQString &help)
void	setButtons (int btn)
void	setRootOnlyMsg (const TQString &msg)
void	setUseRootOnlyMsg (bool on)
bool	managedWidgetChangeState () const
void	unmanagedWidgetChangeState (bool)

Detailed Description

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:

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" );
}

All that remains to be done is to create the appropriate .desktop file

[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:

Author

Matthias Kretz kretz.nosp@m.@kde.nosp@m..org

Since

3.2

Definition at line 73 of file pluginpage.h.

Constructor & Destructor Documentation

PluginPage() [1/2]

KSettings::PluginPage::PluginPage	(	TQWidget *	parent = 0,
		const char *	name = 0,
		const TQStringList &	args = TQStringList()
	)

Standart TDECModule constructor.

Automatically creates the the KPluginSelector widget.

Definition at line 40 of file pluginpage.cpp.

PluginPage() [2/2]

KSettings::PluginPage::PluginPage	(	TDEInstance *	instance,
		TQWidget *	parent = 0,
		const TQStringList &	args = TQStringList()
	)

Standart TDECModule constructor.

Automatically creates the the KPluginSelector widget.

Definition at line 49 of file pluginpage.cpp.

Member Function Documentation

load()

void KSettings::PluginPage::load ( )

virtual

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.

Reimplemented from TDECModule.

Definition at line 70 of file pluginpage.cpp.

pluginSelector()

KPluginSelector * KSettings::PluginPage::pluginSelector

(

)

Returns

a reference to the KPluginSelector.

Definition at line 65 of file pluginpage.cpp.

save()

void KSettings::PluginPage::save ( )

virtual

Save the state of the plugins to TDEConfig objects.

Reimplemented from TDECModule.

Definition at line 75 of file pluginpage.cpp.

---

The documentation for this class was generated from the following files:

• pluginpage.h
• pluginpage.cpp