controlpanel/src/cpframework/src/cpbasesettingview.cpp
changeset 55 4c15d9aa2384
parent 37 940f6b67827d
--- a/controlpanel/src/cpframework/src/cpbasesettingview.cpp	Thu Aug 05 11:11:52 2010 +0800
+++ b/controlpanel/src/cpframework/src/cpbasesettingview.cpp	Thu Sep 02 17:14:05 2010 +0800
@@ -11,7 +11,7 @@
 *
 * Contributors:
 *
-* Description:  
+* Description:  Base class for controlpane plugin views.
 *
 */
 
@@ -23,10 +23,24 @@
 
 /*!
     \class CpBaseSettingView
-    \brief The CpBaseSettingView is base class for all setting views in control panel application.
+    \brief The CpBaseSettingView is the base class for all setting views in controlpanel application.
     This class is responsible for processing some common properties, such as setting view's title, content widget and back key action.
  */
 
+
+/*!
+    \fn void returnValueDelivered(const QVariant &returnValue)
+    
+    This signal is emitted when the setting view need to deliver return value to caller. Derived class can 
+    emit the signal in some proper time.
+*/
+
+/*!
+    \fn void aboutToClose()
+    
+    This signal is emitted when the setting view is about to close.
+*/
+
 /*!
     Constructor of CpBaseSettingView.
  */
@@ -46,8 +60,8 @@
 
 
 /*!
-    Give derived class a chance to do some cleaning work before exiting view.
-    Return : true:  ok to exit
+    Emit aboutToClose() signal to indicate that the view is about to close.
+    Derived class can override it to do some specified work before exit.
  */
 void CpBaseSettingView::close()
 {