From a69ce2c265073b59f54cb6e72c5b8266b8186c12 Mon Sep 17 00:00:00 2001 From: "Aaron J. Seigo" Date: Sun, 15 Jun 2008 21:47:25 +0000 Subject: [PATCH] apidox clarifications svn path=/trunk/KDE/kdebase/workspace/libs/plasma/; revision=820958 --- applet.h | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/applet.h b/applet.h index e1bc0bcc2..f076d9aff 100644 --- a/applet.h +++ b/applet.h @@ -121,12 +121,24 @@ class PLASMA_EXPORT Applet : public QGraphicsWidget KConfigGroup config(const QString &group) const; /** - * Saves state information about this applet. + * Saves state information about this applet that will + * be accessed when next instantiated in the restore(KConfigGroup&) method. + * + * This method does not need to be reimplmented by Applet + * subclasses, but can be useful for Applet specializations + * (such as Containment) to do so. + * + * Applet subclasses may instead want to reimplement saveState(). **/ virtual void save(KConfigGroup &group) const; /** - * Restores state information about this applet. + * Restores state information about this applet saved previously + * in save(KConfigGroup&). + * + * This method does not need to be reimplmented by Applet + * subclasses, but can be useful for Applet specializations + * (such as Containment) to do so. **/ virtual void restore(KConfigGroup &group); @@ -579,8 +591,13 @@ class PLASMA_EXPORT Applet : public QGraphicsWidget void setFailedToLaunch(bool failed, const QString& reason = QString()); /** - * Called when a request to save the state of the applet is made - * during runtime + * When called, the Applet should write any information needed as part + * of the Applet's running state to the configuration object in config() + * and/or globalConfig(). + * + * Applets that always sync their settings/state with the config + * objects when these settings/states change do not need to reimplement + * this method. **/ virtual void saveState(KConfigGroup &config) const;