KControl module classes

Thwse classes provide the KControl module API. More...


Classes

class  KCModuleContainer
 KCModuleContainer is a convenience class encapsulating several KCModules. More...
class  KCModuleInfo
 A class that provides information about a KCModule. More...
class  KCModuleLoader
 Loads a KControl Module. More...
class  KCModuleProxy
 Encapsulates a KCModule for embedding. More...
class  KCModuleProxyIface
 DCOP Interface for KCModule. More...
class  KCModuleProxyRootDispatcher
 DCOP interface for communicating with the real module running in root mode. More...
class  KCMultiDialog
 A method that offers a KDialogBase containing arbitrary KControl Modules. More...

Defines

#define KCMODULECONTAINER(modules, factoryName)

Detailed Description

Thwse classes provide the KControl module API.

Define Documentation

#define KCMODULECONTAINER ( modules,
factoryName   ) 

Value:

extern "C" \
{ \
    KCModule *create_## factoryName(QWidget *parent, const char *name) \
    { \
        return new KCModuleContainer( parent, name, QString( modules ) ); \
    } \
    \
    bool test_## factoryName() \
    { \
        QStringList modList = QStringList::split( ",", QString(modules).remove( " " )); \
        for ( QStringList::Iterator it = modList.begin(); it != modList.end(); ++it ) \
            if ( KCModuleLoader::testModule( *it ) ) \
                return true; \
        return false; \
    } \
}
This macro creates an factory declaration which when run creates an KCModule with specified modules.

For example:

 KCMODULECONTAINER( "kcm_fonts, kcm_keyboard,kcm_fonts", misc_modules)
would create a KCModule with three tabs, each containing one of the specified KCMs. Each use of the macro must be accompanied by a desktop file where the factory name equals the second argument in the macro(in this example, misc_modules).
The module container takes care of testing the contained modules when being shown, as well as when the module itself is asked whether it should be shown.

Parameters:
modules the modules to put in the container
factoryName what factory name the module should have

Definition at line 188 of file kcmodulecontainer.h.

KDE Home | KDE Accessibility Home | Description of Access Keys