securitysettings/eapqtdialogs/src/eapfastprovnotsuccessnotedialog.cpp
changeset 36 c98682f98478
parent 34 ad1f037f1ac2
child 44 22d80358905b
--- a/securitysettings/eapqtdialogs/src/eapfastprovnotsuccessnotedialog.cpp	Thu Jun 24 11:23:08 2010 +0300
+++ b/securitysettings/eapqtdialogs/src/eapfastprovnotsuccessnotedialog.cpp	Fri Jul 09 10:14:51 2010 +0300
@@ -11,53 +11,71 @@
 *
 * Contributors:
 *
-* Description: Fast Provisioning not successfull note Dialog implementation
+* Description: EAP-FAST Provisioning not successfull note Dialog implementation
 *
 */
 
 /*
-* %version: 3 %
+* %version: 4 %
 */
 
+// System includes
 #include <HbAction>
 #include <HbTranslator>
+
+// User includes
 #include "eapfastprovnotsuccessnotedialog.h"
 #include "OstTraceDefinitions.h"
 #ifdef OST_TRACE_COMPILER_IN_USE
 #endif
 
-// The index numbers of the button of the dialog
-const int okButtonIndex = 1;
+/*!
+ * \class EapFastProvNotSuccessNoteDialog
+ * \brief Implements EAP-MSCHAPv2 New Password Input Dialog. 
+ */
+
+// External function prototypes
+
+// Local constants
 
-/**
- * The constructor
+//! The index numbers of the button of the dialog
+static const int okButtonIndex = 1;
+ 
+// ======== LOCAL FUNCTIONS ========
+
+// ======== MEMBER FUNCTIONS ========
+
+/*!
+ * Constructor.
+ * 
+ * @param [in]  parameters Parameters for the Constructor.
  */
 EapFastProvNotSuccessNoteDialog::EapFastProvNotSuccessNoteDialog(const QVariantMap &parameters)
-:HbMessageBox("default text...",HbMessageBox::MessageTypeWarning),    
+:HbMessageBox(HbMessageBox::MessageTypeWarning),    
 mTranslator(new HbTranslator("eapprompts")),
 mOkActionPressed(false)
 {
     OstTraceFunctionEntry0( EAPFASTPROVNOTSUCCESSNOTEDIALOG_EAPFASTPROVNOTSUCCESSNOTEDIALOG_ENTRY );
     qDebug("EapFastProvNotSuccessNoteDialog::EapFastProvNotSuccessNoteDialog ENTER");
+    
+    Q_UNUSED(parameters)
 
-    createDialog( parameters );
+    createDialog();
     
     OstTraceFunctionExit0( EAPFASTPROVNOTSUCCESSNOTEDIALOG_EAPFASTPROVNOTSUCCESSNOTEDIALOG_EXIT );
     qDebug("EapFastProvNotSuccessNoteDialog::EapFastProvNotSuccessNoteDialog EXIT");
 }
     
-/**
+/*!
  * The construction of the dialog
  */ 
-void EapFastProvNotSuccessNoteDialog::createDialog(const QVariantMap &parameters )
+void EapFastProvNotSuccessNoteDialog::createDialog()
 {
     OstTraceFunctionEntry0( EAPFASTPROVNOTSUCCESSNOTEDIALOG_CREATEDIALOG_ENTRY );
     qDebug("EapFastProvNotSuccessNoteDialog::createDialog ENTER");
      
     QString text(hbTrId("txt_occ_info_provisioning_not_successful_reactiv"));
-    
-    Q_UNUSED(parameters)
-        
+         
     //Set the dialog to be on the screen until user reacts
     //by pressing the Action button
     this->setModal(true);
@@ -93,8 +111,8 @@
     qDebug("EapFastProvNotSuccessNoteDialog::createDialog EXIT");
 }
 
-/**
- * Destructor
+/*!
+ * Destructor.
  */
 EapFastProvNotSuccessNoteDialog::~EapFastProvNotSuccessNoteDialog()
 {
@@ -105,7 +123,7 @@
     OstTraceFunctionExit0( EAPFASTPROVNOTSUCCESSNOTEDIALOG_DEAPFASTPROVNOTSUCCESSNOTEDIALOG_EXIT );
 }
 
-/**
+/*!
  * Function is called when the Ok Action button is pressed
  */
 void EapFastProvNotSuccessNoteDialog::okPressed()
@@ -118,8 +136,8 @@
             mOkActionPressed = true;
             
             QVariantMap data;
-            QVariant variant(okButtonIndex);
-            data.insert("okbutton", variant);
+            data["okbutton"] = okButtonIndex;
+            
             // emit the data of the selected button and close the dialog
             qDebug("EapFastProvNotSuccessNoteDialog::okPressed: emit deviceDialogData");
             emit deviceDialogData(data);
@@ -130,7 +148,7 @@
     qDebug("EapFastProvNotSuccessNoteDialog::okPressed EXIT");
 }
 
-/**
+/*!
  * Function is called when the dialog is about to close
  * 
  */
@@ -143,9 +161,13 @@
     OstTraceFunctionExit0( EAPFASTPROVNOTSUCCESSNOTEDIALOG_CLOSINGDIALOG_EXIT );
 }
 
-/**
- * Updating the dialog during its showing is not allowed.
- */ 
+/*!
+ * Device dialog parameters to be set while dialog is displayed.
+ * Not supported. 
+ *
+ * @param [in] parameters NOT USED
+ * @return true always.
+ */  
 bool EapFastProvNotSuccessNoteDialog::setDeviceDialogParameters
                 (const QVariantMap &parameters)
 {
@@ -158,8 +180,10 @@
     return true;
 }
 
-/**
- * Not supported, 0 always returned
+/*!
+ * Not supported
+ *
+ * @return 0 always returned.
  */
 int EapFastProvNotSuccessNoteDialog::deviceDialogError() const
 {
@@ -168,8 +192,10 @@
     return 0;
 }
 
-/**
+/*!
  * Dialog is closed and the signal about closing is emitted
+ *
+ * @param [in] byClient indicates when the user closes the dialog
  */
 void EapFastProvNotSuccessNoteDialog::closeDeviceDialog(bool byClient)
 {   
@@ -184,8 +210,10 @@
     OstTraceFunctionExit0( EAPFASTPROVNOTSUCCESSNOTEDIALOG_CLOSEDEVICEDIALOG_EXIT );
 }
 
-/**
+/*!
  * This dialog widget is returned to the caller
+ *
+ * @return this dialog widget
  */
 HbPopup *EapFastProvNotSuccessNoteDialog::deviceDialogWidget() const
 {