accesssec_plat/eap_qt_configuration_api/inc/eapqtcertificateinfo.h
changeset 34 ad1f037f1ac2
parent 27 9660a5eb236f
--- a/accesssec_plat/eap_qt_configuration_api/inc/eapqtcertificateinfo.h	Thu Jun 10 16:12:28 2010 +0300
+++ b/accesssec_plat/eap_qt_configuration_api/inc/eapqtcertificateinfo.h	Thu Jun 24 11:23:08 2010 +0300
@@ -2,7 +2,7 @@
  * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
  * All rights reserved.
  * This component and the accompanying materials are made available
- * under the terms of the License "Eclipse Public License v1.0"
+ * under the terms of "Eclipse Public License v1.0"
  * which accompanies this distribution, and is available
  * at the URL "http://www.eclipse.org/legal/epl-v10.html".
  *
@@ -18,26 +18,38 @@
  */
 
 /*
- * %version: 2 %
+ * %version: 5 %
  */
 
 #ifndef EAPQTCERTIFICATEINFO_H
 #define EAPQTCERTIFICATEINFO_H
 
+// System includes
 #include <QMetaType>
 #include <QVariant>
-#include <eapqtconfigdefs.h>
+#include <eapqtconfigexport.h>
 
+// User includes
+
+// Forward declarations
 class EapQtCertificateInfoPrivate;
 
+// External data types
+
+// Constants
+
+// Class declaration
 class EAP_QT_CONFIG_INTERFACE_EXPORT EapQtCertificateInfo
 {
+
 public:
 
+    // Data types
+
     enum ItemId
     {
         /*! QString */
-        SubjectName,
+        SubjectName = 0,
         /*! QString */
         IssuerName,
         /*! QString */
@@ -48,27 +60,39 @@
         ThumbPrint,
         /*! QString */
         CertificateLabel,
-        /*! marker for the last item */
+        /* marker for the last item */
         ItemIdLast
     };
 
-public:
-
+    // default constructor
     EapQtCertificateInfo();
+    // destructor
     ~EapQtCertificateInfo();
 
-    EapQtCertificateInfo(const EapQtCertificateInfo &certInfo);
-    EapQtCertificateInfo &operator=(const EapQtCertificateInfo &certInfo);
+    // copy constuctor
+    EapQtCertificateInfo(const EapQtCertificateInfo& certInfo);
+    // assignment
+    EapQtCertificateInfo &operator=(const EapQtCertificateInfo& certInfo);
+
+    // gets the certificate field referred to by an id from ItemId
+    // returns QVariant::Invalid is the field has not been set
+    QVariant value(const ItemId id) const;
 
-    QVariant value(ItemId id) const;
-    void setValue(ItemId id, QVariant newValue);
+    // sets the certificate field referred to by an id from ItemId
+    // does nothing if newValue >= ItemIdLast
+    void setValue(const ItemId id, const QVariant& newValue) const;
 
-private:
+    // resets the object i.e. any successive call to
+    // value() returns QVariant::Invalid
+    void clear() const;
+
+private: // data
 
     QScopedPointer<EapQtCertificateInfoPrivate> d_ptr;
+
 };
 
 // Make the class known to QMetaType to support using QVariant
 Q_DECLARE_METATYPE(EapQtCertificateInfo)
 
-#endif /* EAPQTCERTIFICATEINFO_H */
+#endif // EAPQTCERTIFICATEINFO_H