# class KCModuleProxy

###

Module | kutils
Namespace |
Class | KCModuleProxy
Inherits | QWidget

Encapsulates a KCModule for embedding.

KCModuleProxy is a wrapper for KCModule intended for cases where modules are to be displayed. It ensures layout is consistent and in general takes care of the details needed for making a module available in an interface. A KCModuleProxy can be treated as a QWidget, without worrying about the details specific for modules such as library loading. KCModuleProxy is not a sub class of KCModule but its API closely resembles KCModule's.\n Usually, an instance is created by passing one of the constructors a KService.Ptr, KCModuleInfo or simply the name of the module and then added to the layout as any other widget. \n When the user has changed the module, changed(bool) as well as changed(KCModuleProxy *) is emitted. KCModuleProxy does not take care of prompting for saving - if the object is deleted while changes is not saved the changes will be lost. changed() returns true if changes are unsaved. \n \n KCModuleProxy does not take care of authorization of KCModules. \n KCModuleProxy implements lazy loading, meaning the library will not be loaded or any other initialization done before its show() function is called. This means modules will only be loaded when they are actually needed as well as it is possible to load many KCModuleProxy without any speed penalty.

KCModuleProxy should be used in all cases where modules are embedded in order to promote code efficiency and usability consistency.

Author Frans Englich <frans.englich@telia.com> Author Matthias Kretz <kretz@kde.org>

### methods

- KCModuleProxy (info, parent, args)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  info | KCModuleInfo |
  parent | QWidget | 0
  args | QStringList | QStringList()

  Constructs a KCModuleProxy from a KCModuleInfo class.

  info - The KCModuleInfo to construct the module from.

  parent - the parent QWidget.

  args - This is used in the implementation and is internal. Use the default.

- KCModuleProxy (serviceName, parent, args)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  serviceName | QString |
  parent | QWidget | 0
  args | QStringList | QStringList()

  Constructs a KCModuleProxy from a module's service name, which is equivalent to the desktop file for the kcm without the ".desktop" part. Otherwise equal to the one above.

  serviceName - The module's service name to construct from.

  parent - the parent QWidget.

  args - This is used in the implementation and is internal. Use the default.

- KCModuleProxy (service, parent, args)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  service | KService.Ptr |
  parent | QWidget | 0
  args | QStringList | QStringList()

  Constructs a KCModuleProxy from KService. Otherwise equal to the one above.

  service - The KService to construct from.

  parent - the parent QWidget.

  args - This is used in the implementation and is internal. Use the default.

- KCModuleProxy (a0, a1, a2)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | KCModuleInfo |
  a1 | QWidget | 0
  a2 | QStringList | QStringList()

- KCModuleProxy (a0, a1, a2)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | QString |
  a1 | QWidget | 0
  a2 | QStringList | QStringList()

- KCModuleProxy (a0, a1, a2)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | KService.Ptr |
  a1 | QWidget | 0
  a2 | QStringList | QStringList()

- aboutData ( )

  returns KAboutData

  Returns the module's aboutData()

- buttons ( )

  returns KCModule.Buttons

  Returns what buttons the module needs

- changed ( )

  returns bool

  Returns true if the module is modified and needs to be saved.

- changed (state)

  returns Nothing
  SIGNAL ("changed (bool)")

  Argument | Type | Default
  --- | --- | ---
  state | bool |

- changed (mod)

  returns Nothing
  SIGNAL ("changed (KCModuleProxy*)")

  Argument | Type | Default
  --- | --- | ---
  mod | KCModuleProxy |

  This is emitted in the same situations as in the one above. Practical when several KCModuleProxys are loaded.

- childClosed ( )

  returns Nothing
  SIGNAL ("childClosed ()")

  When a module running with root privileges and exits, returns to normal mode, the childClosed() signal is emitted.

- componentData ( )

  returns KComponentData

  Returns the embedded KCModule's KComponentData. Returns The module's KComponentData. Deprecated

- dbusPath ( )

  returns QString

  Returns the DBUS Path

- dbusService ( )

  returns QString

  Returns the DBUS Service name

- defaults ( )

  returns Nothing

  Calling it will cause the contained module to load its default values.

- deleteClient ( )

  returns Nothing

  Calling this, results in deleting the contained module, and unregistering from DCOP. A similar result is achieved by deleting the KCModuleProxy itself.

- load ( )

  returns Nothing

  Calling it will cause the contained module to run its load() routine.

- moduleInfo ( )

  returns KCModuleInfo

  Returns a KCModuleInfo for the encapsulated module

- quickHelp ( )

  returns QString

  Returns the module's quickHelp();

- quickHelpChanged ( )

  returns Nothing
  SIGNAL ("quickHelpChanged ()")

- realModule ( )

  returns KCModule

  Access to the actual module. However, if the module is running in root mode, see rootMode(), this function returns a NULL pointer, since the module is in another process. It may also return NULL if anything goes wrong.

  Returns the encapsulated module.

- rootOnlyMessage ( )

  returns QString

  Returns The module's custom root message, if it has one Deprecated

- save ( )

  returns Nothing

  Calling it will cause the contained module to run its save() routine.

  If the module was not modified, it will not be asked to save.

- showEvent (a0)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | QShowEvent |

  Reimplemented for internal purposes. Makes sure the encapsulated module is loaded before the show event is taken care of.

- useRootOnlyMessage ( )

  returns bool

  Returns If the module is a root module. Deprecated