org.kde.koala
Class KCModule
public
class
KCModule
extends QWidget
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:
#include
typedef KGenericFactory 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.
See http://developer.kde.org/documentation/other/kcm_howto.html
for more detailed documentation.
See
KCModuleSignals for signals emitted by KCModule
Author: Matthias Hoelzer-Kluepfel
UNKNOWN: The base class for control center modules.
Method Summary |
KAboutData | aboutData()
This is generally only called for the KBugReport.
|
int | buttons()
Indicate which buttons will be used.
|
protected void | changed()
Calling this slot is equivalent to emitting changed(true). |
String | className() |
void | defaults()
Sets the configuration to sensible default values.
|
void | dispose() Delete the wrapped C++ instance ahead of finalize() |
protected void | finalize() Deletes the wrapped C++ instance |
KInstanceInterface | instance() |
boolean | isDisposed() Has the wrapped C++ instance been deleted? |
void | load()
Load the configuration data into the module.
|
protected boolean | managedWidgetChangeState()
Returns the changed state of automatically managed widgets in this dialog |
QMetaObject | metaObject() |
String | quickHelp()
Return a quick-help text.
|
String | rootOnlyMsg()
Get the RootOnly message for this module.
|
void | save()
Save the configuration data.
|
void | setAboutData(KAboutData about)
This sets the KAboutData returned by aboutData() |
protected void | setButtons(int btn)
Sets the buttons to display.
|
protected void | setQuickHelp(String help)
Sets the quick help. |
protected void | setRootOnlyMsg(String msg)
Sets the RootOnly message.
|
protected void | setUseRootOnlyMsg(boolean on)
Change whether or not the RootOnly message should be shown.
|
void | sysdefaults()
Set the configuration to system default values.
|
protected void | unmanagedWidgetChangeState(boolean arg1)
Call this method when your manually managed widgets change state between
changed and not changed |
boolean | useRootOnlyMsg()
Tell if KControl should show a RootOnly message when run as
a normal user.
|
protected void | widgetChanged()
A managed widget was changed, the widget settings and the current
settings are compared and a corresponding changed() signal is emitted |
public static final int Apply
public static final int Cancel
public static final int Default
public static final int Help
An enumeration type for the buttons used by this module.
You should only use Help, Default and Apply. The rest is obsolete.
See Also: KCModule @see
KCModule
UNKNOWN: An enumeration type for the buttons used by this module.
public static final int Ok
public static final int Reset
public static final int SysDefault
protected KCModule(Class dummy)
public KCModule(QWidget parent, String name, String[] args)
public KCModule(QWidget parent, String name)
public KCModule(QWidget parent)
public KCModule()
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
UNKNOWN: This is generally only called for the KBugReport.
public int buttons()
Indicate which buttons will be used.
The return value is a value or'ed together from
the Button enumeration type.
See Also: KCModule
UNKNOWN: Indicate which buttons will be used.
protected void changed()
Calling this slot is equivalent to emitting changed(true).
UNKNOWN: Calling this slot is equivalent to emitting changed(true).
public String className()
public void defaults()
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.
UNKNOWN: Sets the configuration to sensible default values.
public void dispose()
Delete the wrapped C++ instance ahead of finalize()
protected void finalize()
Deletes the wrapped C++ instance
public boolean isDisposed()
Has the wrapped C++ instance been deleted?
public void load()
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.
If you use KConfigXT, loading is taken care of automatically and
you do not need to do it manually. However, if you for some reason reimplement it and
also are using KConfigXT, you must call this function otherwise the loading of KConfigXT
options will not work.
UNKNOWN: Load the configuration data into the module.
protected boolean managedWidgetChangeState()
Returns the changed state of automatically managed widgets in this dialog
UNKNOWN: Returns the changed state of automatically managed widgets in this dialog
public QMetaObject metaObject()
public String quickHelp()
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.
UNKNOWN: make sure the quick help text gets translated (use i18n()). Return a quick-help text.
public String rootOnlyMsg()
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
UNKNOWN: Get the RootOnly message for this module.
public void save()
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.
UNKNOWN: Save the configuration data.
This sets the KAboutData returned by aboutData()
UNKNOWN: This sets the KAboutData returned by aboutData()
protected void setButtons(int btn)
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
UNKNOWN: Sets the buttons to display.
protected void setQuickHelp(String help)
Sets the quick help.
UNKNOWN: Sets the quick help.
protected void setRootOnlyMsg(String msg)
Sets the RootOnly message.
This message will be shown at the top of the module of the
corresponding desktop file contains the line X-KDE-RootOnly=true.
If no message is set, a default one will be used.
See Also: KCModule
UNKNOWN: Sets the RootOnly message.
protected void setUseRootOnlyMsg(boolean on)
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
UNKNOWN: Change whether or not the RootOnly message should be shown.
public void sysdefaults()
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.
UNKNOWN: The default behavior is to call defaults(). Set the configuration to system default values.
protected void unmanagedWidgetChangeState(boolean arg1)
Call this method when your manually managed widgets change state between
changed and not changed
UNKNOWN: Call this method when your manually managed widgets change state between changed and not changed
public boolean useRootOnlyMsg()
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
UNKNOWN: Tell if KControl should show a RootOnly message when run as a normal user.
protected void widgetChanged()
A managed widget was changed, the widget settings and the current
settings are compared and a corresponding changed() signal is emitted
UNKNOWN: A managed widget was changed, the widget settings and the current settings are compared and a corresponding changed() signal is emitted