alecs/plasma-framework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added some basic documentation for a method which is impossible to understand without looking at code examples. Please, please, Plasma team, document your API!

Browse Source 
svn path=/trunk/KDE/kdelibs/; revision=1125046
This commit is contained in:
Sebastian Trueg 2010-05-10 15:26:33 +00:00
parent 1334744175
commit c62e5ceca5
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
applet.h
View File

@ -638,6 +638,21 @@ class PLASMA_EXPORT Applet : public QGraphicsWidget
* parented to the supplied widget. Ownership of the widgets is passed
* to the parent widget.
*
* Typically one would add custom pages to the config dialog @p parent
* and then connect to the applyClicked() and okClicked() signals
* or @p parent to react on config changes:
*
* @code
* connect(parent, SIGNAL(applyClicked()), this, SLOT(myConfigAccepted()));
* connect(parent, SIGNAL(okClicked()), this, SLOT(myConfigAccepted()));
* @endcode
*
* With this approach it makes sense to store the custom pages in member
* variables to make their fields accessible from the myConfigAccepted()
* slot.
*
* Use config() to store your configuration.
*
* @param parent the dialog which is the parent of the configuration
* widgets
*/