Changeset 62216 in vbox

Timestamp:

Jul 13, 2016 11:40:39 AM (9 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

108726

Message:

FE/Qt: QIDialog cleanup (part 01): Doxy/comments.

Location:

trunk/src/VBox/Frontends/VirtualBox/src/extensions

Files:

• QIDialog.cpp (modified) (3 diffs)
• QIDialog.h (modified) (5 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/extensions/QIDialog.cpp

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2008-2013 Oracle Corporation
+ * Copyright (C) 2008-2016 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -31 +31 @@
     , m_fPolished(false)
 {
-    /* No need to count that window as important for application,
+    /* Do not count that window as important for application,
      * it will NOT be taken into account when other top-level windows will be closed: */
     setAttribute(Qt::WA_QuitOnClose, false);
@@ -121 +121 @@
 }
 
-void QIDialog::polishEvent(QShowEvent*)
+void QIDialog::polishEvent(QShowEvent *)
 {
     /* Make sure layout is polished: */

trunk/src/VBox/Frontends/VirtualBox/src/extensions/QIDialog.h

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2008-2013 Oracle Corporation
+ * Copyright (C) 2008-2016 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -16 +16 @@
  */
 
-#ifndef __QIDialog_h__
-#define __QIDialog_h__
+#ifndef ___QIDialog_h___
+#define ___QIDialog_h___
 
 /* Qt includes: */
@@ -26 +26 @@
 class QEventLoop;
 
-/* Qt dialog extension: */
-class QIDialog: public QDialog
+
+/** QDialog extension providing the GUI with
+  * the advanced capabilities like delayed show. */
+class QIDialog : public QDialog
 {
     Q_OBJECT;
@@ -33 +35 @@
 public:
 
-    /* Constructor/destructor: */
+    /** Constructs the dialog passing @a pParent and @a flags to the base-class. */
     QIDialog(QWidget *pParent = 0, Qt::WindowFlags flags = 0);
+    /** Destructs the dialog. */
     ~QIDialog();
 
-    /* API: Visibility stuff: */
+    /** Defines whether the dialog is @a fVisible. */
     void setVisible(bool fVisible);
 
 public slots:
 
-    /** Shows the dialog as a modal dialog, blocking until the user closes it.
+    /** Shows the dialog as a modal one, blocking until the user closes it.
       * @param  fShow              detemines whether the dialog should be shown instantly.
       * @param  fApplicationModal  determine whether the dialog should be application-modal. */
     virtual int execute(bool fShow = true, bool fApplicationModal = false);
 
-    /** Shows the dialog as a modal dialog, blocking until the user closes it.
+    /** Shows the dialog as a modal one, blocking until the user closes it.
       * @note  Provided for compatibility with various Qt versions. */
     virtual int exec() /* overload for Qt4, override for Qt5 */ { return execute(); }
@@ -53 +56 @@
 protected:
 
-    /* Handler: Show-event stuff: */
+    /** Handles show @a pEvent. */
     void showEvent(QShowEvent *pEvent);
-
-    /* Handler: Polish-event stuff: */
+    /** Handles show @a pEvent sent for the first time. */
     virtual void polishEvent(QShowEvent *pEvent);
 
 private:
 
-    /* Variables: */
+    /** Holds whether the dialog is polished. */
     bool m_fPolished;
+
+    /** Holds the separate event-loop instance.
+      * @note  This event-loop is only used when the dialog being executed via the execute()
+      *        functionality, allowing for the delayed show and advanced modality flag. */
     QPointer<QEventLoop> m_pEventLoop;
 };
 
+/** Safe pointer to the QIDialog class. */
 typedef QPointer<QIDialog> UISafePointerDialog;
 
-#endif /* __QIDialog_h__ */
+#endif /* !___QIDialog_h___ */