summaryrefslogtreecommitdiffabout
path: root/microkde/kdeui/kcmodule.h
Side-by-side diff
Diffstat (limited to 'microkde/kdeui/kcmodule.h') (more/less context) (show whitespace changes)
-rw-r--r--microkde/kdeui/kcmodule.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/microkde/kdeui/kcmodule.h b/microkde/kdeui/kcmodule.h
index 90a87c9..bc020bc 100644
--- a/microkde/kdeui/kcmodule.h
+++ b/microkde/kdeui/kcmodule.h
@@ -5,48 +5,49 @@
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef __KCMODULE_H__
#define __KCMODULE_H__
#include <qwidget.h>
#include <qstringlist.h>
//USclass KAboutData;
class KCModulePrivate;
+class KPrefs;
//US class KInstance;
/**
* 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:
*
* <pre>
* #include <kgenericfactory.h>
*
* typedef KGenericFactory<YourKCModule, QWidget> YourKCModuleFactory;
* K_EXPORT_COMPONENT_FACTORY( yourLibName, YourKCModuleFactory("name_of_the_po_file") );
* </pre>
@@ -84,80 +85,80 @@ public:
*/
KCModule(QWidget *parent=0, const char *name=0, const QStringList &args=QStringList() );
//US KCModule(KInstance *instance, QWidget *parent=0, const QStringList &args=QStringList() );
/*
* Destroys the module.
*/
~KCModule();
/**
* 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.
*/
- virtual void load() {};
+ virtual void load(KPrefs* prefs) {};
/**
* 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".
*/
- virtual void save() {};
+ virtual void save(KPrefs* prefs) {};
/**
* 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.
*/
- virtual void defaults() {};
+ virtual void defaults(KPrefs* prefs) {};
/**
* 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().
*/
- virtual void sysdefaults() { defaults(); };
+ virtual void sysdefaults(KPrefs* prefs) { defaults(prefs); };
/**
* 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()).
*/
virtual QString quickHelp() const { return QString::null; };
/**
* 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
*/
//US virtual const KAboutData *aboutData() const { return 0; }
/**
* Indicate which buttons will be used.
*
* The return value is a value or'ed together from
* the Button enumeration type.