#include <kcmodule.h>

Inheritance diagram for KCModule:

Public Types
enum	Button { NoAdditionalButton =0, Help =1, Default =2, Apply =4, Export =8 }

Public Slots
virtual void	defaults ()

virtual void	load ()

virtual void	save ()

Signals
void	changed (bool state)

void	quickHelpChanged ()

void	rootOnlyMessageChanged (bool use, QString message)

Public Member Functions
	KCModule (const KComponentData &componentData, QWidget *parent=0, const QVariantList &args=QVariantList())

	~KCModule ()

virtual const KAboutData *	aboutData () const

KAuth::Action *	authAction () const

Buttons	buttons () const

KComponentData	componentData () const

QList< KConfigDialogManager * >	configs () const

QString	exportText () const

bool	needsAuthorization () const

virtual QString	quickHelp () const

QString	rootOnlyMessage () const

void	setAboutData (const KAboutData *about)

void	setExportText (const QString &)

void	setNeedsAuthorization (bool needsAuth)

bool	useRootOnlyMessage () const

Protected Slots
void	authStatusChanged (int)

void	changed ()

void	widgetChanged ()

Protected Member Functions
KConfigDialogManager *	addConfig (KCoreConfigSkeleton config, QWidget widget)

KConfigDialogManager *	addConfig (KConfigSkeleton config, QWidget widget)

bool	managedWidgetChangeState () const

void	setButtons (Buttons btn)

void	setQuickHelp (const QString &help)

void	setRootOnlyMessage (const QString &message)

void	setUseRootOnlyMessage (bool on)

virtual void	showEvent (QShowEvent *ev)

void	unmanagedWidgetChangeState (bool)

Detailed Description

The base class for configuration modules.

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 library that contains a factory function like the following:

#include <KPluginFactory>
K_PLUGIN_FACTORY(MyKCModuleFactory, registerPlugin<MyKCModule>() )
K_EXPORT_PLUGIN(MyKCModuleFactory("yourLibName","name_of_the_po_file") )

The optional parameter "name_of_the_po_file" has to correspond with the messages target that containst the strings to be translated. Instead of using the library name for yourLibName you can also use another name which you specify in the desktop file with X-KDE-FactoryName. This is useful to have more than one factory in one lib.

The constructor of the KCModule then looks like this:

YourKCModule::YourKCModule( QWidget* parent )
  : KCModule( YourKCModuleFactory::componentData(), parent )
{
  KAboutData *about = new KAboutData(
    <kcm name>, 0, ki18n( "..." ),
    KDE_VERSION_STRING, KLocalizedString(), KAboutData::License_GPL,
    ki18n( "Copyright 2006 ..." ) );
  about->addAuthor( ki18n(...) );
  setAboutData( about );
  .
  .
  .
}

If you want to make the KCModule available only conditionally (i.e. show in the list of available modules only if some test succeeds) then you can use Hidden in the .desktop file. An example:

Hidden[$e]=$(if test -e /dev/js*; then echo "false"; else echo "true"; fi)

The example executes the given code in a shell and uses the stdout output for the Hidden value (so it's either Hidden=true or Hidden=false).

See http://techbase.kde.org/Development/Tutorials/KCM_HowTo for more detailed documentation.

Author: Matthias Hoelzer-Kluepfel hoelz.nosp@m.er@k.nosp@m.de.or.nosp@m.g

Definition at line 107 of file kcmodule.h.

Member Enumeration Documentation

enum KCModule::Button

An enumeration type for the buttons used by this module.

You should only use Help, Default and Apply. The rest is obsolete. NoAdditionalButton can be used when we do not want have other button that Ok Cancel

See also: KCModule::buttons; KCModule::setButtons

Enumerator
NoAdditionalButton
Help
Default
Apply
Export

Definition at line 120 of file kcmodule.h.

Constructor & Destructor Documentation

KCModule::KCModule	(	const KComponentData &	componentData,
		QWidget *	parent = `0`,
		const QVariantList &	args = `QVariantList()`
	)

explicit

Base class for all KControlModules.

Note: do not emit changed signals here, since they are not yet connected to any slot.

Definition at line 77 of file kcmodule.cpp.

KCModule::~KCModule ( )

Destroys the module.

Definition at line 193 of file kcmodule.cpp.

Member Function Documentation

const KAboutData * KCModule::aboutData ( ) const

virtual

This is generally only called for the KBugReport.

If you override you should have it return a pointer to a constant.

Returns: the KAboutData for this module

Definition at line 247 of file kcmodule.cpp.

KConfigDialogManager * KCModule::addConfig	(	KCoreConfigSkeleton *	config,
		QWidget *	widget
	)

protected

Adds a KCoreConfigskeleton config to watch the widget widget.

This function is useful if you need to handle multiple configuration files.

Returns: a pointer to the KCoreConfigDialogManager in use

Parameters

config	the KCoreConfigSkeleton to use
widget	the widget to watch

Definition at line 128 of file kcmodule.cpp.

KConfigDialogManager * KCModule::addConfig	(	KConfigSkeleton *	config,
		QWidget *	widget
	)

protected

Adds a KConfigskeleton config to watch the widget widget.

This function is useful if you need to handle multiple configuration files.

Returns: a pointer to the KConfigDialogManager in use

Parameters

config	the KConfigSkeleton to use
widget	the widget to watch

Definition at line 137 of file kcmodule.cpp.

KAuth::Action * KCModule::authAction ( ) const

Returns the action previously set with setAuthAction().

By default its an invalid action.

Returns: The action that has to be authorized to execute the save() method.

Definition at line 167 of file kcmodule.cpp.

void KCModule::authStatusChanged ( int status )

protectedslot

The status of the auth action, if one, has changed.

Definition at line 172 of file kcmodule.cpp.

KCModule::Buttons KCModule::buttons ( ) const

Indicate which buttons will be used.

The return value is a value or'ed together from the Button enumeration type.

See also: KCModule::setButtons

Definition at line 118 of file kcmodule.cpp.

void KCModule::changed ( bool state )

signal

Indicate that the state of the modules contents has changed.

This signal is emitted whenever the state of the configuration shown in the module changes. It allows the module container to keep track of unsaved changes.

void KCModule::changed ( )

protectedslot

Calling this slot is equivalent to emitting changed(true).

Definition at line 282 of file kcmodule.cpp.

KComponentData KCModule::componentData ( ) const

Definition at line 287 of file kcmodule.cpp.

QList< KConfigDialogManager * > KCModule::configs ( ) const

Returns: a list of KConfigDialogManager's in use, if any.

Definition at line 313 of file kcmodule.cpp.

void KCModule::defaults ( )

virtualslot

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.

If you use KConfigXT, you do not have to reimplement this function since the fetching and settings of default values is done automatically. However, if you reimplement and also are using KConfigXT, remember to call the base function at the very end of your reimplementation.

Definition at line 217 of file kcmodule.cpp.

QString KCModule::exportText ( ) const

Returns the value set by setExportText();.

Definition at line 292 of file kcmodule.cpp.

void KCModule::load ( )

virtualslot

Load the configuration data into the module.

The load method sets the user interface elements of the module to reflect the current settings stored in the configuration files.

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.

Definition at line 201 of file kcmodule.cpp.

bool KCModule::managedWidgetChangeState ( ) const

protected

Returns the changed state of automatically managed widgets in this dialog.

Definition at line 229 of file kcmodule.cpp.

bool KCModule::needsAuthorization ( ) const

Returns the value previously set with setNeedsAuthorization().

By default it's false.

Returns: true if the module's save() method requires authorization, false otherwise

Definition at line 162 of file kcmodule.cpp.

QString KCModule::quickHelp ( ) const

virtual

Return a quick-help text.

This method is called when the module is docked. The quick-help text should contain a short description of the module and links to the module's help files. You can use QML formatting tags in the text.

Note: make sure the quick help text gets translated (use i18n()).

Definition at line 308 of file kcmodule.cpp.

void KCModule::quickHelpChanged ( )

signal

Indicate that the module's quickhelp has changed.

Emit this signal whenever the module's quickhelp changes. Modules implemented as tabbed dialogs might want to implement per-tab quickhelp for example.

QString KCModule::rootOnlyMessage ( ) const

Get the RootOnly message for this module.

When the module must be run as root, or acts differently for root and a normal user, it is sometimes useful to customize the message that appears at the top of the module when used as a normal user. This function returns this customized message. If none has been set, a default message will be used.

See also: KCModule::setRootOnlyMessage

Definition at line 266 of file kcmodule.cpp.

void KCModule::rootOnlyMessageChanged	(	bool	use,
		QString	message
	)

signal

Indicate that the module's root message has changed.

Emits this signal whenever the module's root message changes.

Since: 4.4

void KCModule::save ( )

virtualslot

Save the configuration data.

The save method stores the config information as shown in the user interface in the config files.

If necessary, this method also updates the running system, e.g. by restarting applications. This normally does not apply for KSettings::Dialog modules where the updating is taken care of by KSettings::Dispatcher.

save is called when the user clicks "Apply" or "Ok".

If you use KConfigXT, saving is taken care off automatically and you do not need to load manually. However, if you for some reason reimplement it and also are using KConfigXT, you must call this function, otherwise the saving of KConfigXT options will not work. Call it at the very end of your reimplementation, to avoid changed() signals getting emitted when you modify widgets.

Definition at line 209 of file kcmodule.cpp.

void KCModule::setAboutData ( const KAboutData * about )

This sets the KAboutData returned by aboutData()

Definition at line 252 of file kcmodule.cpp.

void KCModule::setButtons ( Buttons btn )

protected

Sets the buttons to display.

Help: shows a "Help" button.

Default: shows a "Use Defaults" button.

Apply: in kcontrol this will show an "Apply" and "Reset" button, in kcmshell this will show an "Ok", "Apply" and "Cancel" button.

If Apply is not specified, kcmshell will show a "Close" button.

See also: KCModule::buttons

Definition at line 123 of file kcmodule.cpp.

void KCModule::setExportText ( const QString & text )

Sets the export QString value, used for exporting data.

Definition at line 297 of file kcmodule.cpp.

void KCModule::setNeedsAuthorization ( bool needsAuth )

Set if the module's save() method requires authorization to be executed.

The module can set this property to true if it requires authorization. It will still have to execute the action itself using the KAuth library, so this method is not technically needed to perform the action, but using this and/or the setAuthAction() method will ensure that hosting applications like System Settings or kcmshell behave correctly.

Called with true, this method will set the action to "org.kde.kcontrol.name.save" where "name" is aboutData()->appName() return value. This default action won't be set if the aboutData() object is not valid.

Note that called with false, this method will reset the action name set with setAuthAction().

Parameters

needsAuth Tells if the module's save() method requires authorization to be executed.

Definition at line 146 of file kcmodule.cpp.

void KCModule::setQuickHelp ( const QString & help )

protected

Sets the quick help.

Definition at line 302 of file kcmodule.cpp.

void KCModule::setRootOnlyMessage ( const QString & message )

protected

Sets the RootOnly message.

This message will be shown at the top of the module if useRootOnlyMessage is set. If no message is set, a default one will be used.

See also: KCModule::rootOnlyMessage

Definition at line 260 of file kcmodule.cpp.

void KCModule::setUseRootOnlyMessage ( bool on )

protected

Change whether or not the RootOnly message should be shown.

Following the value of on, the RootOnly message will be shown or not.

See also: KCModule::useRootOnlyMessage

Definition at line 271 of file kcmodule.cpp.

void KCModule::showEvent ( QShowEvent * ev )

protectedvirtual

Definition at line 107 of file kcmodule.cpp.

void KCModule::unmanagedWidgetChangeState ( bool changed )

protected

Call this method when your manually managed widgets change state between changed and not changed.

Definition at line 241 of file kcmodule.cpp.

bool KCModule::useRootOnlyMessage ( ) const

Tell if KControl should show a RootOnly message when run as a normal user.

In some cases, the module don't want a RootOnly message to appear (for example if it has already one). This function tells KControl if a RootOnly message should be shown

See also: KCModule::setUseRootOnlyMessage

Definition at line 277 of file kcmodule.cpp.

void KCModule::widgetChanged ( )

protectedslot

A managed widget was changed, the widget settings and the current settings are compared and a corresponding changed() signal is emitted.

Definition at line 224 of file kcmodule.cpp.

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

KDEUI

Public Types

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

KDEUI

kdelibs API Reference

Search