KDE PIM / Developers / API Docs / kpilot

ConduitConfigBase Class Reference

The first classe here: ConduitConfigBase is for configuration purposes. More...

#include <plugin.h>

Inherits QObject.

Inherited by AbbrowserWidgetSetup, ConfigPage, DOCWidgetConfig, KNotesConfigBase, MALWidgetSetup, MemofileConduitConfig, NotepadConduitConfig, NullConduitConfig, PerlConduitConfig, PopMailWidgetConfig, PythonConduitConfig, SysInfoWidgetConfig, TimeWidgetConfig, VCalWidgetSetupBase, and VCalWidgetSetupBase.

List of all members.

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes


Detailed Description

The first classe here: ConduitConfigBase is for configuration purposes.

ConduitConfigBase: this is an object (with a widget!) that is embedded in a dialog. This is the currently preferred form for configuration, and it's what is used in the KPilot conduit configuration dialog. The factory is asked for a "ConduitConfigBase" object.

NB. The reason that this is a QObject which needs to create a separate widget - instead of a QWidget subclass - has to do with layouting. If you make the widget with designer then the easiest thing to do is to use a grid layout there. Making ConduitConfigBase a QWidget subclass would require an additional layout here, which seems a little foolish.


Member Function Documentation

virtual bool ConduitConfigBase::isModified  )  const [inline, virtual]
 

This function is called to check whether the configuration of the conduit has changed -- and hence, whether the user needs to be prompted.

By default, this just returns fModified, but you can do more complicated things.

virtual void ConduitConfigBase::commit  )  [pure virtual]
 

Load or save the config widget's settings in the given KConfig object; leave the group unchanged.

load() and commit() should both call unmodified() to indicate that the current settings match the on-disk ones.

bool ConduitConfigBase::maybeSave  )  [virtual]
 

Called when the object is to be hidden again and might need to save changed settings.

Should prompt the user and call commit() if needed. Override this function only if you need a very different kind of prompt window.

Returns false if the change is to be canceled. Returns true otherwise, whether or not the changes were saved.

QString ConduitConfigBase::maybeSaveText  )  const [protected, virtual]
 

This function provides the string for the prompt used in maybeSave().

Override it to change the text.


The documentation for this class was generated from the following files: