# kdeui Library API Documentation

Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Source Files

# KCModule Class Reference

The base class for control center modules. More...

`#include <kcmodule.h>`

Inheritance diagram for KCModule:

[legend]
Collaboration diagram for KCModule:

[legend]
List of all members.

## Public Types

enum | Button { Help = 1, Default = 2, Apply = 16, Reset = 4, Cancel = 8, Ok = 32, SysDefault = 64 }
| An enumeration type for the buttons used by this module. More...

## Signals

void | changed (bool state)
| Indicate that the state of the modules contents has changed.
void | quickHelpChanged ()
| Indicate that the module's quickhelp has changed.

## Public Member Functions

| KCModule (QWidget *parent=0, const char *name=0, const QStringList &args=QStringList())
| KCModule (KInstance *instance, QWidget *parent=0, const QStringList &args=QStringList())
virtual void | load ()
| Load the configuration data into the module.
virtual void | save ()
| Save the configuration data.
virtual void | defaults ()
| Sets the configuration to sensible default values.
virtual void | sysdefaults ()
| Set the configuration to system default values.
virtual QString | quickHelp () const
| Return a quick-help text.
virtual const KAboutData * | aboutData () const
| Returns a the KAboutData for this module This is generally only called for the KBugReport.
int | buttons () const
| Indicate which buttons will be used.
QString | rootOnlyMsg () const
| Get the RootOnly message for this module.
bool | useRootOnlyMsg () const
| Tell if KControl should show a RootOnly message when run as a normal user.
KInstance * | instance () const

## Protected Member Functions

void | setButtons (int btn)
| Sets the buttons to display.
void | setRootOnlyMsg (const QString &msg)
| Sets the RootOnly message.
void | setUseRootOnlyMsg (bool on)
| Change wether or not the RootOnly message should be shown.
virtual void | virtual_hook (int id, void *data)

## Detailed Description

The base class for control center modules.

Starting from KDE 2.0, control center modules are realized as shared libraries that are loaded into the control center at runtime.

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 at one factory function like this:

     #include <kgenericfactory.h>

     typedef KGenericFactory<YourKCModule, QWidget> YourKCModuleFactory;
     K_EXPORT_COMPONENT_FACTORY( yourLibName, YourKCModuleFactory("name_of_the_po_file") );

The parameter "name_of_the_po_file" has to correspond with the messages target that you created in your Makefile.am.

See kdebase/kcontrol/HOWTO for more detailed documentation.

Author:
  Matthias Hoelzer-Kluepfel <hoelzer@kde.org>

Definition at line 62 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.

See also:
  KCModule::buttons

  KCModule::setButtons

Definition at line 74 of file kcmodule.h.

## Member Function Documentation

virtual void KCModule::load | ( |  | ) | `[inline, virtual]`

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. NOTE that this is not called after the modules is loaded, so you probably want to call this method in the constructor.

Definition at line 108 of file kcmodule.h.

virtual void KCModule::save | ( |  | ) | `[inline, virtual]`

| 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. save is called when the user clicks "Apply" or "Ok". Definition at line 121 of file kcmodule.h.

virtual void KCModule::defaults | ( |  | ) | `[inline, virtual]`

| 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. Definition at line 129 of file kcmodule.h. Referenced by sysdefaults().

virtual void KCModule::sysdefaults | ( |  | ) | `[inline, virtual]`

| Set the configuration to system default values. This method is called when the user clicks the "System-Default" button. It should set the display to the system default values. NOTE: The default behaviour is to call defaults(). Definition at line 139 of file kcmodule.h. References defaults().

virtual QString KCModule::quickHelp | ( |  | ) | const`[inline, 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 formating tags in the text. NOTE: Please make sure the quick help text gets translated (use i18n()). Definition at line 150 of file kcmodule.h.

virtual const KAboutData* KCModule::aboutData | ( |  | ) | const`[inline, virtual]`

| Returns a the KAboutData for this module This is generally only called for the KBugReport. Override and have it return a pointer to a constant Definition at line 157 of file kcmodule.h.

int KCModule::buttons | ( |  | ) | const`[inline]`

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 167 of file kcmodule.h.

QString KCModule::rootOnlyMsg | ( |  | ) | 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::setRootOnlyMsg

Definition at line 78 of file kcmodule.cpp.

bool KCModule::useRootOnlyMsg | ( |  | ) | 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::setUseRootOnlyMsg

Definition at line 88 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 control center to keep track of unsaved changes.

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.

void KCModule::setButtons | ( | int | btn | ) | `[inline, 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 234 of file kcmodule.h.

void KCModule::setRootOnlyMsg | ( | const QString & | msg | ) | `[protected]`

Sets the RootOnly message.

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.

See also:
  KCModule::rootOnlyMessage

Definition at line 73 of file kcmodule.cpp.

void KCModule::setUseRootOnlyMsg | ( | bool | on | ) | `[protected]`

Change wether or not the RootOnly message should be shown.

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

See also:
  KCModule::useRootOnlyMsg

Definition at line 83 of file kcmodule.cpp.

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

- kcmodule.h
- kcmodule.cpp

This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Jan 28 12:59:10 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001