• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kutils
 

kutils

Public Types | Static Public Member Functions
KCModuleLoader Class Reference
KControl module classes

#include <kcmoduleloader.h>

List of all members.

Public Types

enum  ErrorReporting { None = 0, Inline = 1, Dialog = 2, Both = 3 }

Static Public Member Functions

static KCModule * loadModule (const KCModuleInfo &module, bool withFallback=true, TQWidget *parent=0, const char *name=0, const TQStringList &args=TQStringList()) KDE_DEPRECATED
static KCModule * loadModule (const TQString &module, TQWidget *parent=0, const char *name=0, const TQStringList &args=TQStringList()) KDE_DEPRECATED
static KCModule * loadModule (const KCModuleInfo &module, ErrorReporting report, bool withFallback=true, TQWidget *parent=0, const char *name=0, const TQStringList &args=TQStringList())
static KCModule * loadModule (const TQString &module, ErrorReporting report, TQWidget *parent=0, const char *name=0, const TQStringList &args=TQStringList())
static void unloadModule (const KCModuleInfo &mod)
static void showLastLoaderError (TQWidget *parent) KDE_DEPRECATED
static bool testModule (const TQString &module)
static bool testModule (const KCModuleInfo &module)
static KCModule * reportError (ErrorReporting report, const TQString &text, TQString details, TQWidget *parent)

Detailed Description

Loads a KControl Module.

KCModuleLoader tries in several ways to locate and load a KCModule. If loading fails a zero pointer is returned.
It is very unlikely KCModuleLoader is what you want and KCModuleProxy suits your needs.

Author:
Matthias Hoelzer-Kluepfel <mhk@kde.org>
Frans Englich <frans.englich@telia.com>
Since:
3.2

Definition at line 45 of file kcmoduleloader.h.


Member Enumeration Documentation

enum KCModuleLoader::ErrorReporting

Determines the way errors are reported.

Enumerator:
None 

no error reporting is done

Inline 

the error report is shown instead of the KCModule that should have * been loaded

Dialog 

shows a dialog with the error report

Both 

does both Inline and Dialog

Definition at line 84 of file kcmoduleloader.h.


Member Function Documentation

KCModule * KCModuleLoader::loadModule ( const KCModuleInfo &  module,
bool  withFallback = true,
TQWidget *  parent = 0,
const char *  name = 0,
const TQStringList &  args = TQStringList() 
) [static]

Loads a KCModule.

If loading fails a zero pointer is returned.

Parameters:
modulewhat module to load
withFallbackif true and loading failed a separate window with the module may appear and a zero pointer is a returned
parentThe parent widget
nameThe widget's name
argsA list of arguments for the module to load
Returns:
a pointer to the loaded KCModule
Deprecated:
use the function which explicitly states the error reporting method

Definition at line 116 of file kcmoduleloader.cpp.

KCModule * KCModuleLoader::loadModule ( const TQString &  module,
TQWidget *  parent = 0,
const char *  name = 0,
const TQStringList &  args = TQStringList() 
) [static]

Loads a KCModule.

If loading fails a zero pointer is returned.

Parameters:
modulewhat module to load with the module may appear and a zero pointer is a returned
parentThe parent widget
nameThe widget's name
argsA list of arguments for the module to load
Deprecated:
use the function which explicitly states the error reporting method

Definition at line 192 of file kcmoduleloader.cpp.

KCModule * KCModuleLoader::loadModule ( const KCModuleInfo &  module,
ErrorReporting  report,
bool  withFallback = true,
TQWidget *  parent = 0,
const char *  name = 0,
const TQStringList &  args = TQStringList() 
) [static]

Loads a KCModule.

If loading fails a zero pointer is returned.

Parameters:
modulewhat module to load
reportsee ErrorReporting
withFallbackif true and loading failed a separate window with the module may appear and a zero pointer is a returned
parentThe parent widget
nameThe widget's name
argsA list of arguments for the module to load
Returns:
a pointer to the loaded KCModule
Since:
3.4

Definition at line 121 of file kcmoduleloader.cpp.

KCModule * KCModuleLoader::loadModule ( const TQString &  module,
ErrorReporting  report,
TQWidget *  parent = 0,
const char *  name = 0,
const TQStringList &  args = TQStringList() 
) [static]

Loads a KCModule.

If loading fails a zero pointer is returned.

Parameters:
modulewhat module to load
reportsee ErrorReporting with the module may appear and a zero pointer is a returned
parentThe parent widget
nameThe widget's name
argsA list of arguments for the module to load
Returns:
a pointer to the loaded KCModule
Since:
3.4

Definition at line 198 of file kcmoduleloader.cpp.

KCModule * KCModuleLoader::reportError ( ErrorReporting  report,
const TQString &  text,
TQString  details,
TQWidget *  parent 
) [static]

Returns a KCModule containing the messages report and text.

Parameters:
reportthe type of error reporting, see ErrorReporting
textthe main message
detailsany additional details
parentThe parent widget
Since:
3.4

Definition at line 284 of file kcmoduleloader.cpp.

void KCModuleLoader::showLastLoaderError ( TQWidget *  parent) [static]

Display a message box explaining an error occured and possible reasons to why.

Deprecated:
Use a constructor with ErrorReporting set to Dialog to show a message box like this function did.

Definition at line 217 of file kcmoduleloader.cpp.

bool KCModuleLoader::testModule ( const TQString &  module) [static]

Checks whether an KCModule should be shown by running its test function.

If it is unsure whether a module should be shown, it should be made available, leaving the decision to the user. If false is returned, the module should not be loaded in any interface.

A module declares it needs to be tested by having "X-KDE-Test-Module=true" in its desktop file. When that line exists, the following code must be available in the module's library:

 extern "C"
 {
    bool test_moduleName()
    {
      // Code testing for hardware/software presence.
      return true; // and the modue will be loaded.
    }

 }

where moduleName is the library name for the module.

Parameters:
modulethe module to check
Returns:
true if the module should be loaded
Since:
3.4

Definition at line 230 of file kcmoduleloader.cpp.

bool KCModuleLoader::testModule ( const KCModuleInfo &  module) [static]

Convenience function, essentially the same as above.

Parameters:
modulethe module to check
Returns:
true if the module should be loaded
Since:
3.4

If something fails we return true - we can't risk functionality becoming unavailable because of a buggy test. Furthermore, the error needs to show so it is discovered. KCModuleProxy will detect the error and load a corresponding KCMError.

Definition at line 235 of file kcmoduleloader.cpp.

void KCModuleLoader::unloadModule ( const KCModuleInfo &  mod) [static]

Unloads the module's library.

Parameters:
modWhat module to unload for

Definition at line 204 of file kcmoduleloader.cpp.


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

kutils

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

kutils

Skip menu "kutils"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kutils by doxygen 1.7.6.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |