From 70b367d7dfac50ede4cc2e2b8ecb360d5e9d04a1 Mon Sep 17 00:00:00 2001
From: "Aaron J. Seigo" <aseigo@kde.org>
Date: Sat, 13 Jun 2009 21:49:15 +0000
Subject: [PATCH] some more details and clarity

svn path=/trunk/KDE/kdelibs/; revision=981646
---
 wallpaper.h | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/wallpaper.h b/wallpaper.h
index 991b12be9..43a859bf7 100644
--- a/wallpaper.h
+++ b/wallpaper.h
@@ -201,13 +201,20 @@ class PLASMA_EXPORT Wallpaper : public QObject
         virtual void save(KConfigGroup &config);
 
         /**
-         * Returns the widget used in the configuration dialog.
-         * Add the configuration interface of the wallpaper to this widget.
+         * Returns a widget that can be used to configure the options (if any)
+         * associated with this wallpaper. It will be deleted by the caller
+         * when it complete. The default implementation returns a null pointer.
+         *
          * To signal that settings have changed connect to
          * settingsChanged(bool modified) in @p parent.
+         *
          * @code connect(this, SIGNAL(settingsChanged(bool), parent, SLOT(settingsChanged(bool)))
          * @endcode
+         *
          * Emit settingsChanged(true) when the settings are changed and false when the original state is restored.
+         *
+         * Implementation detail note: for best visual results, use a QGridLayout with two columns,
+         * with the option labels in column 0
          */
         virtual QWidget *createConfigurationInterface(QWidget *parent);