accesssec_plat/eap_qt_configuration_api/inc/eapqtpluginhandle.h
changeset 34 ad1f037f1ac2
parent 27 9660a5eb236f
--- a/accesssec_plat/eap_qt_configuration_api/inc/eapqtpluginhandle.h	Thu Jun 10 16:12:28 2010 +0300
+++ b/accesssec_plat/eap_qt_configuration_api/inc/eapqtpluginhandle.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".
  *
@@ -12,28 +12,40 @@
  * Contributors:
  *
  * Description: 
- *   Control Panel EAP plugin information
+ *   EAP UI plugin handle
  *
  */
 
 /*
- * %version: 4 %
+ * %version: 7 %
  */
 
 #ifndef EAPQTPLUGINHANDLE_H
 #define EAPQTPLUGINHANDLE_H
 
+// System includes
 #include <qglobal.h>
 #include <QMetaType>
-#include <eapqtconfigdefs.h>
+#include <eapqtconfigexport.h>
 
+// User includes
+
+// Forward declarations
 class EapQtExpandedEapType;
 class EapQtPluginHandlePrivate;
 
+// External data types
+
+// Constants
+
+// Class declaration
 class EAP_QT_PLUGIN_INFO_EXPORT EapQtPluginHandle
 {
+
 public:
     
+    // Data types
+
     enum Plugin
     {
         PluginUndefined = 0,
@@ -51,23 +63,43 @@
         PluginLast
     };
 
-public:
-
+    // default constructor
     EapQtPluginHandle();
-    EapQtPluginHandle(Plugin id);
-    EapQtPluginHandle(EapQtExpandedEapType type); // maps type to default UIDs
-    EapQtPluginHandle(const EapQtPluginHandle& handle);
-    EapQtPluginHandle(EapQtExpandedEapType type, int uid);
+
+    // constructs an instance from an EapQtPluginHandle::Plugin value
+    EapQtPluginHandle(const Plugin id);
+
+    // constructs an instance from an EapQtExpandedEapType object,
+    // maps the supplied type to UIDs of default EAP protocol implementations
+    EapQtPluginHandle(const EapQtExpandedEapType &type);
+
+    // copy constructor
+    EapQtPluginHandle(const EapQtPluginHandle &handle);
+
+    // constructs an instance from an EapQtExpandedEapType object and
+    // supplied EAP protocol implementation UID
+    EapQtPluginHandle(const EapQtExpandedEapType &type, int uid);
+
+    // destructor
     ~EapQtPluginHandle();
 
+    // returns EapQtExpandedEapType of the handle instance
     EapQtExpandedEapType type() const;
+
+    // returns EAP protocol implementation UID of the handle instance
     int protocolImplementationUid() const;
+
+    // returns EapQtPluginHandle::Plugin of the handle instance
     Plugin pluginId() const;
 
+    // assignment
     EapQtPluginHandle &operator=(const EapQtPluginHandle &handle);
+
+    // comparisons
     bool operator ==(const EapQtPluginHandle &right_type_value) const;
+    bool operator !=(const EapQtPluginHandle &right_type_value) const;
 
-private:
+private: // data
 
     QScopedPointer<EapQtPluginHandlePrivate> d_ptr;
 
@@ -76,4 +108,4 @@
 // Make the class known to QMetaType to support using QVariant
 Q_DECLARE_METATYPE(EapQtPluginHandle)
 
-#endif /* EAPQTPLUGINHANDLE_H */
+#endif // EAPQTPLUGINHANDLE_H