• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KCModule Class Reference

The base class for configuration modules. More...

#include <kcmodule.h>

Inheritance diagram for KCModule:

Inheritance graph
[legend]

List of all members.


Public Types

enum  Button { NoAdditionalButton = 0, Help = 1, Default = 2, Apply = 4 }

Public Slots

virtual void defaults ()
virtual void load ()
virtual void save ()

Signals

void changed (bool state)
void quickHelpChanged ()

Public Member Functions

virtual const KAboutData * aboutData () const
Buttons buttons () const
KComponentData componentData () const
QList< KConfigDialogManager * > configs () const
 KCModule (const KComponentData &componentData, QWidget *parent=0, const QVariantList &args=QVariantList())
virtual QString quickHelp () const
QString rootOnlyMessage () const
void setAboutData (const KAboutData *about)
bool useRootOnlyMessage () const
 ~KCModule ()

Protected Slots

void changed ()
void widgetChanged ()

Protected Member Functions

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 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. 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://developer.kde.org/documentation/other/kcm_howto.html for more detailed documentation.

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

Definition at line 98 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 

Definition at line 111 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 86 of file kcmodule.cpp.

KCModule::~KCModule (  ) 

Destroys the module.

Definition at line 126 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 180 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 117 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 107 of file kcmodule.cpp.

void KCModule::changed (  )  [protected, slot]

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

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

KComponentData KCModule::componentData (  )  const

Definition at line 216 of file kcmodule.cpp.

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

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

Definition at line 232 of file kcmodule.cpp.

void KCModule::defaults (  )  [virtual, slot]

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 150 of file kcmodule.cpp.

void KCModule::load (  )  [virtual, slot]

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 134 of file kcmodule.cpp.

bool KCModule::managedWidgetChangeState (  )  const [protected]

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

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 227 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 196 of file kcmodule.cpp.

void KCModule::save (  )  [virtual, slot]

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 142 of file kcmodule.cpp.

void KCModule::setAboutData ( const KAboutData *  about  ) 

This sets the KAboutData returned by aboutData().

Definition at line 185 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 112 of file kcmodule.cpp.

void KCModule::setQuickHelp ( const QString &  help  )  [protected]

Sets the quick help.

Definition at line 221 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 191 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 201 of file kcmodule.cpp.

void KCModule::showEvent ( QShowEvent *  ev  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 96 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 174 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 206 of file kcmodule.cpp.

void KCModule::widgetChanged (  )  [protected, slot]

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

Definition at line 157 of file kcmodule.cpp.


The documentation for this class was generated from the following files:
  • kcmodule.h
  • kcmodule.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal