.TH "KCModule" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KCModule \- The base class for control center modules.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kcmodule.h>\fP
.PP
Inherits \fBQWidget\fP.
.PP
Inherited by \fBKCModuleContainer\fP, and \fBKSettings::PluginPage\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBButton\fP { \fBHelp\fP = 1, \fBDefault\fP = 2, \fBApply\fP = 16, \fBReset\fP = 4, \fBCancel\fP = 8, \fBOk\fP = 32, \fBSysDefault\fP = 64 }"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBchanged\fP (bool state)"
.br
.ti -1c
.RI "void \fBquickHelpChanged\fP ()"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKCModule\fP (\fBQWidget\fP *parent=0, const char *name=0, const \fBQStringList\fP &args=\fBQStringList\fP())"
.br
.ti -1c
.RI "\fBKCModule\fP (\fBKInstance\fP *instance, \fBQWidget\fP *parent=0, const \fBQStringList\fP &args=\fBQStringList\fP())"
.br
.ti -1c
.RI "virtual void \fBload\fP ()"
.br
.ti -1c
.RI "virtual void \fBsave\fP ()"
.br
.ti -1c
.RI "virtual void \fBdefaults\fP ()"
.br
.ti -1c
.RI "virtual void \fBsysdefaults\fP ()"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBquickHelp\fP () const "
.br
.ti -1c
.RI "virtual const \fBKAboutData\fP * \fBaboutData\fP () const "
.br
.ti -1c
.RI "void \fBsetAboutData\fP (\fBKAboutData\fP *about)"
.br
.ti -1c
.RI "int \fBbuttons\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBrootOnlyMsg\fP () const "
.br
.ti -1c
.RI "bool \fBuseRootOnlyMsg\fP () const "
.br
.ti -1c
.RI "\fBKInstance\fP * \fBinstance\fP () const "
.br
.ti -1c
.RI "const \fBQPtrList\fP< \fBKConfigDialogManager\fP > & \fBconfigs\fP () const "
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBchanged\fP ()"
.br
.ti -1c
.RI "void \fBwidgetChanged\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBKConfigDialogManager\fP * \fBaddConfig\fP (\fBKConfigSkeleton\fP *config, \fBQWidget\fP *widget)"
.br
.ti -1c
.RI "void \fBsetQuickHelp\fP (const \fBQString\fP &help)"
.br
.ti -1c
.RI "void \fBsetButtons\fP (int btn)"
.br
.ti -1c
.RI "void \fBsetRootOnlyMsg\fP (const \fBQString\fP &msg)"
.br
.ti -1c
.RI "void \fBsetUseRootOnlyMsg\fP (bool on)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The base class for control center modules. 

Starting from \fBKDE\fP 2.0, control center modules are realized as shared libraries that are loaded into the control center at runtime.
.PP
The module in principle is a simple widget displaying the item to be changed. The module has a very small interface.
.PP
All the necessary glue logic and the GUI bells and whistles are provided by the control center and must not concern the module author.
.PP
To write a config module, you have to create a library that contains at one factory function like this:
.PP
.PP
.nf
 #include <kgenericfactory.h>

 typedef KGenericFactory<YourKCModule, QWidget> YourKCModuleFactory;
 K_EXPORT_COMPONENT_FACTORY( yourLibName, YourKCModuleFactory('name_of_the_po_file') );
.fi
.PP
.PP
The parameter 'name_of_the_po_file' has to correspond with the messages target that you created in your Makefile.am.
.PP
See http://developer.kde.org/documentation/other/kcm_howto.html for more detailed documentation.
.PP
\fBAuthor:\fP
.RS 4
Matthias Hoelzer-Kluepfel <hoelzer@kde.org> 
.RE
.PP

.PP
Definition at line 69 of file kcmodule.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBKCModule::Button\fP"
.PP
An enumeration type for the buttons used by this module. 
.PP
You should only use Help, Default and Apply. The rest is obsolete.
.PP
\fBSee also:\fP
.RS 4
\fBKCModule::buttons\fP 
.PP
\fBKCModule::setButtons\fP 
.RE
.PP

.PP
Definition at line 81 of file kcmodule.h.
.SH "Member Function Documentation"
.PP 
.SS "void KCModule::load ()\fC [virtual]\fP"
.PP
Load the configuration data into the module. 
.PP
The load method sets the user interface elements of the module to reflect the current settings stored in the configuration files.
.PP
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.
.PP
If you use KConfigXT, loading is taken care of automatically and you do not need to do it manually. However, if you for some reason reimplement it and also are using KConfigXT, you must call this function otherwise the loading of KConfigXT options will not work. 
.PP
Reimplemented in \fBKCModuleContainer\fP, and \fBKSettings::PluginPage\fP.
.PP
Definition at line 103 of file kcmodule.cpp.
.PP
References KConfigDialogManager::updateWidgets().
.SS "void KCModule::save ()\fC [virtual]\fP"
.PP
Save the configuration data. 
.PP
The save method stores the config information as shown in the user interface in the config files.
.PP
If necessary, this method also updates the running system, e.g. by restarting applications. This normally does not apply for \fBKSettings::Dialog\fP modules where the updating is taken care of by \fBKSettings::Dispatcher\fP.
.PP
save is called when the user clicks 'Apply' or 'Ok'.
.PP
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 \fBchanged()\fP signals getting emitted when you modify widgets. 
.PP
Reimplemented in \fBKCModuleContainer\fP, and \fBKSettings::PluginPage\fP.
.PP
Definition at line 110 of file kcmodule.cpp.
.PP
References changed(), and KConfigDialogManager::updateSettings().
.SS "void KCModule::defaults ()\fC [virtual]\fP"
.PP
Sets the configuration to sensible default values. 
.PP
This method is called when the user clicks the 'Default' button. It should set the display to useful values.
.PP
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. 
.PP
Reimplemented in \fBKCModuleContainer\fP, and \fBKSettings::PluginPage\fP.
.PP
Definition at line 118 of file kcmodule.cpp.
.PP
References KConfigDialogManager::updateWidgetsDefault().
.SS "virtual void KCModule::sysdefaults ()\fC [inline, virtual]\fP"
.PP
Set the configuration to system default values. 
.PP
This method is called when the user clicks the 'System-Default' button. It should set the display to the system default values.
.PP
\fBNote:\fP
.RS 4
The default behavior is to call \fBdefaults()\fP. 
.RE
.PP

.PP
Definition at line 166 of file kcmodule.h.
.SS "\fBQString\fP KCModule::quickHelp () const\fC [virtual]\fP"
.PP
Return a quick-help text. 
.PP
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.
.PP
\fBNote:\fP
.RS 4
make sure the quick help text gets translated (use i18n()). 
.RE
.PP

.PP
Definition at line 181 of file kcmodule.cpp.
.SS "const \fBKAboutData\fP * KCModule::aboutData () const\fC [virtual]\fP"
.PP
This is generally only called for the \fBKBugReport\fP. 
.PP
If you override you should have it return a pointer to a constant.
.PP
\fBReturns:\fP
.RS 4
the \fBKAboutData\fP for this module 
.RE
.PP

.PP
Definition at line 134 of file kcmodule.cpp.
.SS "void KCModule::setAboutData (\fBKAboutData\fP * about)"
.PP
This sets the \fBKAboutData\fP returned by \fBaboutData()\fP 
.PP
\fBSince:\fP
.RS 4
3.3. 
.RE
.PP

.PP
Definition at line 139 of file kcmodule.cpp.
.SS "int KCModule::buttons () const\fC [inline]\fP"
.PP
Indicate which buttons will be used. 
.PP
The return value is a value or'ed together from the Button enumeration type.
.PP
\fBSee also:\fP
.RS 4
\fBKCModule::setButtons\fP 
.RE
.PP

.PP
Definition at line 203 of file kcmodule.h.
.SS "\fBQString\fP KCModule::rootOnlyMsg () const"
.PP
Get the RootOnly message for this module. 
.PP
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.
.PP
\fBSee also:\fP
.RS 4
\fBKCModule::setRootOnlyMsg\fP 
.RE
.PP

.PP
Definition at line 150 of file kcmodule.cpp.
.SS "bool KCModule::useRootOnlyMsg () const"
.PP
Tell if KControl should show a RootOnly message when run as a normal user. 
.PP
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
.PP
\fBSee also:\fP
.RS 4
\fBKCModule::setUseRootOnlyMsg\fP 
.RE
.PP

.PP
Definition at line 160 of file kcmodule.cpp.
.SS "const \fBQPtrList\fP< \fBKConfigDialogManager\fP > & KCModule::configs () const"
.PP
\fBReturns:\fP
.RS 4
a list of \fBKConfigDialogManager\fP's in use, if any. 
.RE
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 187 of file kcmodule.cpp.
.SS "\fBKConfigDialogManager\fP * KCModule::addConfig (\fBKConfigSkeleton\fP * config, \fBQWidget\fP * widget)\fC [protected]\fP"
.PP
Adds a KConfigskeleton \fCconfig\fP to watch the widget \fCwidget\fP. 
.PP
This function is useful if you need to handle multiple configuration files.
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP
\fBReturns:\fP
.RS 4
a pointer to the \fBKConfigDialogManager\fP in use 
.RE
.PP
\fBParameters:\fP
.RS 4
\fIconfig\fP the \fBKConfigSkeleton\fP to use 
.br
\fIwidget\fP the widget to watch 
.RE
.PP

.PP
Definition at line 87 of file kcmodule.cpp.
.PP
References widgetChanged().
.SS "void KCModule::setQuickHelp (const \fBQString\fP & help)\fC [protected]\fP"
.PP
Sets the quick help. 
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP

.PP
Definition at line 175 of file kcmodule.cpp.
.PP
References quickHelpChanged().
.SS "void KCModule::changed (bool state)\fC [signal]\fP"
.PP
Indicate that the state of the modules contents has changed. 
.PP
This signal is emitted whenever the state of the configuration shown in the module changes. It allows the control center to keep track of unsaved changes. 
.SS "void KCModule::quickHelpChanged ()\fC [signal]\fP"
.PP
Indicate that the module's quickhelp has changed. 
.PP
Emit this signal whenever the module's quickhelp changes. Modules implemented as tabbed dialogs might want to implement per-tab quickhelp for example. 
.PP
Referenced by setQuickHelp().
.SS "void KCModule::changed ()\fC [protected, slot]\fP"
.PP
Calling this slot is equivalent to emitting changed(true). 
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP

.PP
Definition at line 165 of file kcmodule.cpp.
.PP
Referenced by save(), and widgetChanged().
.SS "void KCModule::widgetChanged ()\fC [protected, slot]\fP"
.PP
A managed widget was changed, the widget settings and the current settings are compared and a corresponding \fBchanged()\fP signal is emitted 
.PP
\fBSince:\fP
.RS 4
3.4. 
.RE
.PP

.PP
Definition at line 125 of file kcmodule.cpp.
.PP
References changed(), and KConfigDialogManager::hasChanged().
.PP
Referenced by addConfig().
.SS "void KCModule::setButtons (int btn)\fC [inline, protected]\fP"
.PP
Sets the buttons to display. 
.PP
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
.PP
If Apply is not specified, kcmshell will show a 'Close' button.
.PP
\fBSee also:\fP
.RS 4
\fBKCModule::buttons\fP 
.RE
.PP

.PP
Definition at line 309 of file kcmodule.h.
.SS "void KCModule::setRootOnlyMsg (const \fBQString\fP & msg)\fC [protected]\fP"
.PP
Sets the RootOnly message. 
.PP
This message will be shown at the top of the module of the corresponding desktop file contains the line X-KDE-RootOnly=true. If no message is set, a default one will be used.
.PP
\fBSee also:\fP
.RS 4
\fBKCModule::rootOnlyMsg\fP 
.RE
.PP

.PP
Definition at line 145 of file kcmodule.cpp.
.SS "void KCModule::setUseRootOnlyMsg (bool on)\fC [protected]\fP"
.PP
Change wether or not the RootOnly message should be shown. 
.PP
Following the value of \fCon\fP, the RootOnly message will be shown or not.
.PP
\fBSee also:\fP
.RS 4
\fBKCModule::useRootOnlyMsg\fP 
.RE
.PP

.PP
Definition at line 155 of file kcmodule.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
